@aws-sdk/client-pinpoint-sms-voice 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,52 +9,61 @@ import { SendVoiceMessageCommandInput, SendVoiceMessageCommandOutput } from "./c
9
9
  import { UpdateConfigurationSetEventDestinationCommandInput, UpdateConfigurationSetEventDestinationCommandOutput } from "./commands/UpdateConfigurationSetEventDestinationCommand";
10
10
  import { PinpointSMSVoiceClient } from "./PinpointSMSVoiceClient";
11
11
  /**
12
+ * @public
12
13
  * Pinpoint SMS and Voice Messaging public facing APIs
13
14
  */
14
15
  export declare class PinpointSMSVoice extends PinpointSMSVoiceClient {
15
16
  /**
17
+ * @public
16
18
  * Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
17
19
  */
18
20
  createConfigurationSet(args: CreateConfigurationSetCommandInput, options?: __HttpHandlerOptions): Promise<CreateConfigurationSetCommandOutput>;
19
21
  createConfigurationSet(args: CreateConfigurationSetCommandInput, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void): void;
20
22
  createConfigurationSet(args: CreateConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetCommandOutput) => void): void;
21
23
  /**
24
+ * @public
22
25
  * Create a new event destination in a configuration set.
23
26
  */
24
27
  createConfigurationSetEventDestination(args: CreateConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions): Promise<CreateConfigurationSetEventDestinationCommandOutput>;
25
28
  createConfigurationSetEventDestination(args: CreateConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void): void;
26
29
  createConfigurationSetEventDestination(args: CreateConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConfigurationSetEventDestinationCommandOutput) => void): void;
27
30
  /**
31
+ * @public
28
32
  * Deletes an existing configuration set.
29
33
  */
30
34
  deleteConfigurationSet(args: DeleteConfigurationSetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConfigurationSetCommandOutput>;
31
35
  deleteConfigurationSet(args: DeleteConfigurationSetCommandInput, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void): void;
32
36
  deleteConfigurationSet(args: DeleteConfigurationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetCommandOutput) => void): void;
33
37
  /**
38
+ * @public
34
39
  * Deletes an event destination in a configuration set.
35
40
  */
36
41
  deleteConfigurationSetEventDestination(args: DeleteConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConfigurationSetEventDestinationCommandOutput>;
37
42
  deleteConfigurationSetEventDestination(args: DeleteConfigurationSetEventDestinationCommandInput, cb: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void): void;
38
43
  deleteConfigurationSetEventDestination(args: DeleteConfigurationSetEventDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationSetEventDestinationCommandOutput) => void): void;
39
44
  /**
45
+ * @public
40
46
  * Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.
41
47
  */
42
48
  getConfigurationSetEventDestinations(args: GetConfigurationSetEventDestinationsCommandInput, options?: __HttpHandlerOptions): Promise<GetConfigurationSetEventDestinationsCommandOutput>;
43
49
  getConfigurationSetEventDestinations(args: GetConfigurationSetEventDestinationsCommandInput, cb: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void): void;
44
50
  getConfigurationSetEventDestinations(args: GetConfigurationSetEventDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigurationSetEventDestinationsCommandOutput) => void): void;
45
51
  /**
52
+ * @public
46
53
  * List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
47
54
  */
48
55
  listConfigurationSets(args: ListConfigurationSetsCommandInput, options?: __HttpHandlerOptions): Promise<ListConfigurationSetsCommandOutput>;
49
56
  listConfigurationSets(args: ListConfigurationSetsCommandInput, cb: (err: any, data?: ListConfigurationSetsCommandOutput) => void): void;
50
57
  listConfigurationSets(args: ListConfigurationSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConfigurationSetsCommandOutput) => void): void;
51
58
  /**
59
+ * @public
52
60
  * Create a new voice message and send it to a recipient's phone number.
53
61
  */
54
62
  sendVoiceMessage(args: SendVoiceMessageCommandInput, options?: __HttpHandlerOptions): Promise<SendVoiceMessageCommandOutput>;
55
63
  sendVoiceMessage(args: SendVoiceMessageCommandInput, cb: (err: any, data?: SendVoiceMessageCommandOutput) => void): void;
56
64
  sendVoiceMessage(args: SendVoiceMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendVoiceMessageCommandOutput) => void): void;
57
65
  /**
66
+ * @public
58
67
  * Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.
59
68
  */
60
69
  updateConfigurationSetEventDestination(args: UpdateConfigurationSetEventDestinationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateConfigurationSetEventDestinationCommandOutput>;
@@ -16,15 +16,24 @@ import { ListConfigurationSetsCommandInput, ListConfigurationSetsCommandOutput }
16
16
  import { SendVoiceMessageCommandInput, SendVoiceMessageCommandOutput } from "./commands/SendVoiceMessageCommand";
17
17
  import { UpdateConfigurationSetEventDestinationCommandInput, UpdateConfigurationSetEventDestinationCommandOutput } from "./commands/UpdateConfigurationSetEventDestinationCommand";
18
18
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
19
+ /**
20
+ * @public
21
+ */
19
22
  export type ServiceInputTypes = CreateConfigurationSetCommandInput | CreateConfigurationSetEventDestinationCommandInput | DeleteConfigurationSetCommandInput | DeleteConfigurationSetEventDestinationCommandInput | GetConfigurationSetEventDestinationsCommandInput | ListConfigurationSetsCommandInput | SendVoiceMessageCommandInput | UpdateConfigurationSetEventDestinationCommandInput;
23
+ /**
24
+ * @public
25
+ */
20
26
  export type ServiceOutputTypes = CreateConfigurationSetCommandOutput | CreateConfigurationSetEventDestinationCommandOutput | DeleteConfigurationSetCommandOutput | DeleteConfigurationSetEventDestinationCommandOutput | GetConfigurationSetEventDestinationsCommandOutput | ListConfigurationSetsCommandOutput | SendVoiceMessageCommandOutput | UpdateConfigurationSetEventDestinationCommandOutput;
27
+ /**
28
+ * @public
29
+ */
21
30
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
22
31
  /**
23
32
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
24
33
  */
25
34
  requestHandler?: __HttpHandler;
26
35
  /**
27
- * A constructor for a class implementing the {@link __Checksum} interface
36
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
28
37
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
29
38
  * @internal
30
39
  */
@@ -114,23 +123,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
114
123
  */
115
124
  logger?: __Logger;
116
125
  /**
117
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
126
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
118
127
  */
119
128
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
120
129
  }
130
+ /**
131
+ * @public
132
+ */
121
133
  type PinpointSMSVoiceClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
122
134
  /**
123
- * The configuration interface of PinpointSMSVoiceClient class constructor that set the region, credentials and other options.
135
+ * @public
136
+ *
137
+ * The configuration interface of PinpointSMSVoiceClient class constructor that set the region, credentials and other options.
124
138
  */
125
139
  export interface PinpointSMSVoiceClientConfig extends PinpointSMSVoiceClientConfigType {
126
140
  }
141
+ /**
142
+ * @public
143
+ */
127
144
  type PinpointSMSVoiceClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
128
145
  /**
129
- * The resolved configuration interface of PinpointSMSVoiceClient class. This is resolved and normalized from the {@link PinpointSMSVoiceClientConfig | constructor configuration interface}.
146
+ * @public
147
+ *
148
+ * The resolved configuration interface of PinpointSMSVoiceClient class. This is resolved and normalized from the {@link PinpointSMSVoiceClientConfig | constructor configuration interface}.
130
149
  */
131
150
  export interface PinpointSMSVoiceClientResolvedConfig extends PinpointSMSVoiceClientResolvedConfigType {
132
151
  }
133
152
  /**
153
+ * @public
134
154
  * Pinpoint SMS and Voice Messaging public facing APIs
135
155
  */
136
156
  export declare class PinpointSMSVoiceClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PinpointSMSVoiceClientResolvedConfig> {
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateConfigurationSetRequest, CreateConfigurationSetResponse } from "../models/models_0";
5
5
  import { PinpointSMSVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateConfigurationSetCommand}.
8
10
  */
9
11
  export interface CreateConfigurationSetCommandInput extends CreateConfigurationSetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateConfigurationSetCommand}.
13
17
  */
14
18
  export interface CreateConfigurationSetCommandOutput extends CreateConfigurationSetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateConfigurationSetCommandOutput extends CreateConfiguration
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateConfigurationSetCommandInput - {@link CreateConfigurationSetCommandInput}
34
+ * @returns {@link CreateConfigurationSetCommandOutput}
28
35
  * @see {@link CreateConfigurationSetCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateConfigurationSetCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for PinpointSMSVoiceClient's `config` shape.
@@ -49,11 +56,20 @@ export interface CreateConfigurationSetCommandOutput extends CreateConfiguration
49
56
  export declare class CreateConfigurationSetCommand extends $Command<CreateConfigurationSetCommandInput, CreateConfigurationSetCommandOutput, PinpointSMSVoiceClientResolvedConfig> {
50
57
  readonly input: CreateConfigurationSetCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: CreateConfigurationSetCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointSMSVoiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateConfigurationSetCommandInput, CreateConfigurationSetCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateConfigurationSetEventDestinationRequest, CreateConfigurationSetEventDestinationResponse } from "../models/models_0";
5
5
  import { PinpointSMSVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateConfigurationSetEventDestinationCommand}.
8
10
  */
9
11
  export interface CreateConfigurationSetEventDestinationCommandInput extends CreateConfigurationSetEventDestinationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateConfigurationSetEventDestinationCommand}.
13
17
  */
14
18
  export interface CreateConfigurationSetEventDestinationCommandOutput extends CreateConfigurationSetEventDestinationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Create a new event destination in a configuration set.
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateConfigurationSetEventDestinationCommandOutput extends Cre
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateConfigurationSetEventDestinationCommandInput - {@link CreateConfigurationSetEventDestinationCommandInput}
34
+ * @returns {@link CreateConfigurationSetEventDestinationCommandOutput}
28
35
  * @see {@link CreateConfigurationSetEventDestinationCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateConfigurationSetEventDestinationCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for PinpointSMSVoiceClient's `config` shape.
@@ -52,11 +59,20 @@ export interface CreateConfigurationSetEventDestinationCommandOutput extends Cre
52
59
  export declare class CreateConfigurationSetEventDestinationCommand extends $Command<CreateConfigurationSetEventDestinationCommandInput, CreateConfigurationSetEventDestinationCommandOutput, PinpointSMSVoiceClientResolvedConfig> {
53
60
  readonly input: CreateConfigurationSetEventDestinationCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: CreateConfigurationSetEventDestinationCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointSMSVoiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateConfigurationSetEventDestinationCommandInput, CreateConfigurationSetEventDestinationCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteConfigurationSetRequest, DeleteConfigurationSetResponse } from "../models/models_0";
5
5
  import { PinpointSMSVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteConfigurationSetCommand}.
8
10
  */
9
11
  export interface DeleteConfigurationSetCommandInput extends DeleteConfigurationSetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteConfigurationSetCommand}.
13
17
  */
14
18
  export interface DeleteConfigurationSetCommandOutput extends DeleteConfigurationSetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Deletes an existing configuration set.
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteConfigurationSetCommandOutput extends DeleteConfiguration
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteConfigurationSetCommandInput - {@link DeleteConfigurationSetCommandInput}
34
+ * @returns {@link DeleteConfigurationSetCommandOutput}
28
35
  * @see {@link DeleteConfigurationSetCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteConfigurationSetCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for PinpointSMSVoiceClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DeleteConfigurationSetCommandOutput extends DeleteConfiguration
46
53
  export declare class DeleteConfigurationSetCommand extends $Command<DeleteConfigurationSetCommandInput, DeleteConfigurationSetCommandOutput, PinpointSMSVoiceClientResolvedConfig> {
47
54
  readonly input: DeleteConfigurationSetCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DeleteConfigurationSetCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointSMSVoiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteConfigurationSetCommandInput, DeleteConfigurationSetCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteConfigurationSetEventDestinationRequest, DeleteConfigurationSetEventDestinationResponse } from "../models/models_0";
5
5
  import { PinpointSMSVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteConfigurationSetEventDestinationCommand}.
8
10
  */
9
11
  export interface DeleteConfigurationSetEventDestinationCommandInput extends DeleteConfigurationSetEventDestinationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteConfigurationSetEventDestinationCommand}.
13
17
  */
14
18
  export interface DeleteConfigurationSetEventDestinationCommandOutput extends DeleteConfigurationSetEventDestinationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Deletes an event destination in a configuration set.
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteConfigurationSetEventDestinationCommandOutput extends Del
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteConfigurationSetEventDestinationCommandInput - {@link DeleteConfigurationSetEventDestinationCommandInput}
34
+ * @returns {@link DeleteConfigurationSetEventDestinationCommandOutput}
28
35
  * @see {@link DeleteConfigurationSetEventDestinationCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteConfigurationSetEventDestinationCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for PinpointSMSVoiceClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DeleteConfigurationSetEventDestinationCommandOutput extends Del
46
53
  export declare class DeleteConfigurationSetEventDestinationCommand extends $Command<DeleteConfigurationSetEventDestinationCommandInput, DeleteConfigurationSetEventDestinationCommandOutput, PinpointSMSVoiceClientResolvedConfig> {
47
54
  readonly input: DeleteConfigurationSetEventDestinationCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DeleteConfigurationSetEventDestinationCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointSMSVoiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteConfigurationSetEventDestinationCommandInput, DeleteConfigurationSetEventDestinationCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetConfigurationSetEventDestinationsRequest, GetConfigurationSetEventDestinationsResponse } from "../models/models_0";
5
5
  import { PinpointSMSVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetConfigurationSetEventDestinationsCommand}.
8
10
  */
9
11
  export interface GetConfigurationSetEventDestinationsCommandInput extends GetConfigurationSetEventDestinationsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetConfigurationSetEventDestinationsCommand}.
13
17
  */
14
18
  export interface GetConfigurationSetEventDestinationsCommandOutput extends GetConfigurationSetEventDestinationsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetConfigurationSetEventDestinationsCommandOutput extends GetCo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetConfigurationSetEventDestinationsCommandInput - {@link GetConfigurationSetEventDestinationsCommandInput}
34
+ * @returns {@link GetConfigurationSetEventDestinationsCommandOutput}
28
35
  * @see {@link GetConfigurationSetEventDestinationsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetConfigurationSetEventDestinationsCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for PinpointSMSVoiceClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetConfigurationSetEventDestinationsCommandOutput extends GetCo
46
53
  export declare class GetConfigurationSetEventDestinationsCommand extends $Command<GetConfigurationSetEventDestinationsCommandInput, GetConfigurationSetEventDestinationsCommandOutput, PinpointSMSVoiceClientResolvedConfig> {
47
54
  readonly input: GetConfigurationSetEventDestinationsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetConfigurationSetEventDestinationsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointSMSVoiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConfigurationSetEventDestinationsCommandInput, GetConfigurationSetEventDestinationsCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListConfigurationSetsRequest, ListConfigurationSetsResponse } from "../models/models_0";
5
5
  import { PinpointSMSVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListConfigurationSetsCommand}.
8
10
  */
9
11
  export interface ListConfigurationSetsCommandInput extends ListConfigurationSetsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListConfigurationSetsCommand}.
13
17
  */
14
18
  export interface ListConfigurationSetsCommandOutput extends ListConfigurationSetsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListConfigurationSetsCommandOutput extends ListConfigurationSet
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListConfigurationSetsCommandInput - {@link ListConfigurationSetsCommandInput}
34
+ * @returns {@link ListConfigurationSetsCommandOutput}
28
35
  * @see {@link ListConfigurationSetsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListConfigurationSetsCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for PinpointSMSVoiceClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListConfigurationSetsCommandOutput extends ListConfigurationSet
43
50
  export declare class ListConfigurationSetsCommand extends $Command<ListConfigurationSetsCommandInput, ListConfigurationSetsCommandOutput, PinpointSMSVoiceClientResolvedConfig> {
44
51
  readonly input: ListConfigurationSetsCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: ListConfigurationSetsCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointSMSVoiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListConfigurationSetsCommandInput, ListConfigurationSetsCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SendVoiceMessageRequest, SendVoiceMessageResponse } from "../models/models_0";
5
5
  import { PinpointSMSVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SendVoiceMessageCommand}.
8
10
  */
9
11
  export interface SendVoiceMessageCommandInput extends SendVoiceMessageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SendVoiceMessageCommand}.
13
17
  */
14
18
  export interface SendVoiceMessageCommandOutput extends SendVoiceMessageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Create a new voice message and send it to a recipient's phone number.
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface SendVoiceMessageCommandOutput extends SendVoiceMessageResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param SendVoiceMessageCommandInput - {@link SendVoiceMessageCommandInput}
34
+ * @returns {@link SendVoiceMessageCommandOutput}
28
35
  * @see {@link SendVoiceMessageCommandInput} for command's `input` shape.
29
36
  * @see {@link SendVoiceMessageCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for PinpointSMSVoiceClient's `config` shape.
@@ -43,11 +50,20 @@ export interface SendVoiceMessageCommandOutput extends SendVoiceMessageResponse,
43
50
  export declare class SendVoiceMessageCommand extends $Command<SendVoiceMessageCommandInput, SendVoiceMessageCommandOutput, PinpointSMSVoiceClientResolvedConfig> {
44
51
  readonly input: SendVoiceMessageCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: SendVoiceMessageCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointSMSVoiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendVoiceMessageCommandInput, SendVoiceMessageCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateConfigurationSetEventDestinationRequest, UpdateConfigurationSetEventDestinationResponse } from "../models/models_0";
5
5
  import { PinpointSMSVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PinpointSMSVoiceClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateConfigurationSetEventDestinationCommand}.
8
10
  */
9
11
  export interface UpdateConfigurationSetEventDestinationCommandInput extends UpdateConfigurationSetEventDestinationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateConfigurationSetEventDestinationCommand}.
13
17
  */
14
18
  export interface UpdateConfigurationSetEventDestinationCommandOutput extends UpdateConfigurationSetEventDestinationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateConfigurationSetEventDestinationCommandOutput extends Upd
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateConfigurationSetEventDestinationCommandInput - {@link UpdateConfigurationSetEventDestinationCommandInput}
34
+ * @returns {@link UpdateConfigurationSetEventDestinationCommandOutput}
28
35
  * @see {@link UpdateConfigurationSetEventDestinationCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateConfigurationSetEventDestinationCommandOutput} for command's `response` shape.
30
37
  * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for PinpointSMSVoiceClient's `config` shape.
@@ -46,11 +53,20 @@ export interface UpdateConfigurationSetEventDestinationCommandOutput extends Upd
46
53
  export declare class UpdateConfigurationSetEventDestinationCommand extends $Command<UpdateConfigurationSetEventDestinationCommandInput, UpdateConfigurationSetEventDestinationCommandOutput, PinpointSMSVoiceClientResolvedConfig> {
47
54
  readonly input: UpdateConfigurationSetEventDestinationCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: UpdateConfigurationSetEventDestinationCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PinpointSMSVoiceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateConfigurationSetEventDestinationCommandInput, UpdateConfigurationSetEventDestinationCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from PinpointSMSVoice service.
4
6
  */
5
7
  export declare class PinpointSMSVoiceServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { PinpointSMSVoiceServiceException as __BaseException } from "./PinpointSMSVoiceServiceException";
3
3
  /**
4
+ * @public
4
5
  * The resource specified in your request already exists.
5
6
  */
6
7
  export declare class AlreadyExistsException extends __BaseException {
@@ -13,6 +14,7 @@ export declare class AlreadyExistsException extends __BaseException {
13
14
  constructor(opts: __ExceptionOptionType<AlreadyExistsException, __BaseException>);
14
15
  }
15
16
  /**
17
+ * @public
16
18
  * The input you provided is invalid.
17
19
  */
18
20
  export declare class BadRequestException extends __BaseException {
@@ -25,6 +27,7 @@ export declare class BadRequestException extends __BaseException {
25
27
  constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
26
28
  }
27
29
  /**
30
+ * @public
28
31
  * An object that defines a message that contains text formatted using Amazon Pinpoint Voice Instructions markup.
29
32
  */
30
33
  export interface CallInstructionsMessageType {
@@ -34,6 +37,7 @@ export interface CallInstructionsMessageType {
34
37
  Text?: string;
35
38
  }
36
39
  /**
40
+ * @public
37
41
  * An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.
38
42
  */
39
43
  export interface CloudWatchLogsDestination {
@@ -47,6 +51,7 @@ export interface CloudWatchLogsDestination {
47
51
  LogGroupArn?: string;
48
52
  }
49
53
  /**
54
+ * @public
50
55
  * A request to create a new configuration set.
51
56
  */
52
57
  export interface CreateConfigurationSetRequest {
@@ -56,11 +61,13 @@ export interface CreateConfigurationSetRequest {
56
61
  ConfigurationSetName?: string;
57
62
  }
58
63
  /**
64
+ * @public
59
65
  * An empty object that indicates that the configuration set was successfully created.
60
66
  */
61
67
  export interface CreateConfigurationSetResponse {
62
68
  }
63
69
  /**
70
+ * @public
64
71
  * The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
65
72
  */
66
73
  export declare class InternalServiceErrorException extends __BaseException {
@@ -73,6 +80,7 @@ export declare class InternalServiceErrorException extends __BaseException {
73
80
  constructor(opts: __ExceptionOptionType<InternalServiceErrorException, __BaseException>);
74
81
  }
75
82
  /**
83
+ * @public
76
84
  * There are too many instances of the specified resource type.
77
85
  */
78
86
  export declare class LimitExceededException extends __BaseException {
@@ -85,6 +93,7 @@ export declare class LimitExceededException extends __BaseException {
85
93
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
86
94
  }
87
95
  /**
96
+ * @public
88
97
  * You've issued too many requests to the resource. Wait a few minutes, and then try again.
89
98
  */
90
99
  export declare class TooManyRequestsException extends __BaseException {
@@ -97,6 +106,7 @@ export declare class TooManyRequestsException extends __BaseException {
97
106
  constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
98
107
  }
99
108
  /**
109
+ * @public
100
110
  * An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.
101
111
  */
102
112
  export interface KinesisFirehoseDestination {
@@ -109,6 +119,9 @@ export interface KinesisFirehoseDestination {
109
119
  */
110
120
  IamRoleArn?: string;
111
121
  }
122
+ /**
123
+ * @public
124
+ */
112
125
  export declare enum EventType {
113
126
  ANSWERED = "ANSWERED",
114
127
  BUSY = "BUSY",
@@ -119,6 +132,7 @@ export declare enum EventType {
119
132
  RINGING = "RINGING"
120
133
  }
121
134
  /**
135
+ * @public
122
136
  * An object that contains information about an event destination that sends data to Amazon SNS.
123
137
  */
124
138
  export interface SnsDestination {
@@ -128,6 +142,7 @@ export interface SnsDestination {
128
142
  TopicArn?: string;
129
143
  }
130
144
  /**
145
+ * @public
131
146
  * An object that defines a single event destination.
132
147
  */
133
148
  export interface EventDestinationDefinition {
@@ -153,6 +168,7 @@ export interface EventDestinationDefinition {
153
168
  SnsDestination?: SnsDestination;
154
169
  }
155
170
  /**
171
+ * @public
156
172
  * Create a new event destination in a configuration set.
157
173
  */
158
174
  export interface CreateConfigurationSetEventDestinationRequest {
@@ -170,11 +186,13 @@ export interface CreateConfigurationSetEventDestinationRequest {
170
186
  EventDestinationName?: string;
171
187
  }
172
188
  /**
189
+ * @public
173
190
  * An empty object that indicates that the event destination was created successfully.
174
191
  */
175
192
  export interface CreateConfigurationSetEventDestinationResponse {
176
193
  }
177
194
  /**
195
+ * @public
178
196
  * The resource you attempted to access doesn't exist.
179
197
  */
180
198
  export declare class NotFoundException extends __BaseException {
@@ -186,6 +204,9 @@ export declare class NotFoundException extends __BaseException {
186
204
  */
187
205
  constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
188
206
  }
207
+ /**
208
+ * @public
209
+ */
189
210
  export interface DeleteConfigurationSetRequest {
190
211
  /**
191
212
  * ConfigurationSetName
@@ -193,10 +214,14 @@ export interface DeleteConfigurationSetRequest {
193
214
  ConfigurationSetName: string | undefined;
194
215
  }
195
216
  /**
217
+ * @public
196
218
  * An empty object that indicates that the configuration set was deleted successfully.
197
219
  */
198
220
  export interface DeleteConfigurationSetResponse {
199
221
  }
222
+ /**
223
+ * @public
224
+ */
200
225
  export interface DeleteConfigurationSetEventDestinationRequest {
201
226
  /**
202
227
  * ConfigurationSetName
@@ -208,11 +233,13 @@ export interface DeleteConfigurationSetEventDestinationRequest {
208
233
  EventDestinationName: string | undefined;
209
234
  }
210
235
  /**
236
+ * @public
211
237
  * An empty object that indicates that the event destination was deleted successfully.
212
238
  */
213
239
  export interface DeleteConfigurationSetEventDestinationResponse {
214
240
  }
215
241
  /**
242
+ * @public
216
243
  * An object that defines an event destination.
217
244
  */
218
245
  export interface EventDestination {
@@ -241,6 +268,9 @@ export interface EventDestination {
241
268
  */
242
269
  SnsDestination?: SnsDestination;
243
270
  }
271
+ /**
272
+ * @public
273
+ */
244
274
  export interface GetConfigurationSetEventDestinationsRequest {
245
275
  /**
246
276
  * ConfigurationSetName
@@ -248,6 +278,7 @@ export interface GetConfigurationSetEventDestinationsRequest {
248
278
  ConfigurationSetName: string | undefined;
249
279
  }
250
280
  /**
281
+ * @public
251
282
  * An object that contains information about an event destination.
252
283
  */
253
284
  export interface GetConfigurationSetEventDestinationsResponse {
@@ -256,6 +287,9 @@ export interface GetConfigurationSetEventDestinationsResponse {
256
287
  */
257
288
  EventDestinations?: EventDestination[];
258
289
  }
290
+ /**
291
+ * @public
292
+ */
259
293
  export interface ListConfigurationSetsRequest {
260
294
  /**
261
295
  * A token returned from a previous call to the API that indicates the position in the list of results.
@@ -267,6 +301,7 @@ export interface ListConfigurationSetsRequest {
267
301
  PageSize?: string;
268
302
  }
269
303
  /**
304
+ * @public
270
305
  * An object that contains information about the configuration sets for your account in the current region.
271
306
  */
272
307
  export interface ListConfigurationSetsResponse {
@@ -280,6 +315,7 @@ export interface ListConfigurationSetsResponse {
280
315
  NextToken?: string;
281
316
  }
282
317
  /**
318
+ * @public
283
319
  * An object that defines a message that contains unformatted text.
284
320
  */
285
321
  export interface PlainTextMessageType {
@@ -297,6 +333,7 @@ export interface PlainTextMessageType {
297
333
  VoiceId?: string;
298
334
  }
299
335
  /**
336
+ * @public
300
337
  * An object that defines a message that contains SSML-formatted text.
301
338
  */
302
339
  export interface SSMLMessageType {
@@ -314,6 +351,7 @@ export interface SSMLMessageType {
314
351
  VoiceId?: string;
315
352
  }
316
353
  /**
354
+ * @public
317
355
  * An object that contains a voice message and information about the recipient that you want to send it to.
318
356
  */
319
357
  export interface VoiceMessageContent {
@@ -331,6 +369,7 @@ export interface VoiceMessageContent {
331
369
  SSMLMessage?: SSMLMessageType;
332
370
  }
333
371
  /**
372
+ * @public
334
373
  * SendVoiceMessageRequest
335
374
  */
336
375
  export interface SendVoiceMessageRequest {
@@ -356,6 +395,7 @@ export interface SendVoiceMessageRequest {
356
395
  OriginationPhoneNumber?: string;
357
396
  }
358
397
  /**
398
+ * @public
359
399
  * An object that that contains the Message ID of a Voice message that was sent successfully.
360
400
  */
361
401
  export interface SendVoiceMessageResponse {
@@ -365,6 +405,7 @@ export interface SendVoiceMessageResponse {
365
405
  MessageId?: string;
366
406
  }
367
407
  /**
408
+ * @public
368
409
  * UpdateConfigurationSetEventDestinationRequest
369
410
  */
370
411
  export interface UpdateConfigurationSetEventDestinationRequest {
@@ -382,6 +423,7 @@ export interface UpdateConfigurationSetEventDestinationRequest {
382
423
  EventDestinationName: string | undefined;
383
424
  }
384
425
  /**
426
+ * @public
385
427
  * An empty object that indicates that the event destination was updated successfully.
386
428
  */
387
429
  export interface UpdateConfigurationSetEventDestinationResponse {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-pinpoint-sms-voice",
3
3
  "description": "AWS SDK for JavaScript Pinpoint Sms Voice Client for Node.js, Browser and React Native",
4
- "version": "3.296.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.296.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
24
  "@aws-sdk/config-resolver": "3.296.0",
25
- "@aws-sdk/credential-provider-node": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
26
  "@aws-sdk/fetch-http-handler": "3.296.0",
27
27
  "@aws-sdk/hash-node": "3.296.0",
28
28
  "@aws-sdk/invalid-dependency": "3.296.0",