feat(client-pinpoint): The OrchestrationSendingRoleArn has been added to the email channel and is used to send emails from campaigns or journeys.

Author: awstools

clients/client-pinpoint/src/commands/DeleteEmailChannelCommand.ts

@@ -55,6 +55,7 @@ export interface DeleteEmailChannelCommandOutput extends DeleteEmailChannelRespo
  * //     MessagesPerSecond: Number("int"),
  * //     Platform: "STRING_VALUE", // required
  * //     RoleArn: "STRING_VALUE",
+ * //     OrchestrationSendingRoleArn: "STRING_VALUE",
  * //     Version: Number("int"),
  * //   },
  * // };

clients/client-pinpoint/src/commands/GetEmailChannelCommand.ts

@@ -55,6 +55,7 @@ export interface GetEmailChannelCommandOutput extends GetEmailChannelResponse, _
  * //     MessagesPerSecond: Number("int"),
  * //     Platform: "STRING_VALUE", // required
  * //     RoleArn: "STRING_VALUE",
+ * //     OrchestrationSendingRoleArn: "STRING_VALUE",
  * //     Version: Number("int"),
  * //   },
  * // };

clients/client-pinpoint/src/commands/UpdateEmailChannelCommand.ts

@@ -42,6 +42,7 @@ export interface UpdateEmailChannelCommandOutput extends UpdateEmailChannelRespo
  *     FromAddress: "STRING_VALUE", // required
  *     Identity: "STRING_VALUE", // required
  *     RoleArn: "STRING_VALUE",
+ *     OrchestrationSendingRoleArn: "STRING_VALUE",
  *   },
  * };
  * const command = new UpdateEmailChannelCommand(input);
@@ -62,6 +63,7 @@ export interface UpdateEmailChannelCommandOutput extends UpdateEmailChannelRespo
  * //     MessagesPerSecond: Number("int"),
  * //     Platform: "STRING_VALUE", // required
  * //     RoleArn: "STRING_VALUE",
+ * //     OrchestrationSendingRoleArn: "STRING_VALUE",
  * //     Version: Number("int"),
  * //   },
  * // };

clients/client-pinpoint/src/models/models_0.ts

@@ -6356,6 +6356,12 @@ export interface EmailChannelResponse {
    */
   RoleArn?: string;
 
+  /**
+   * <p>The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.</p>
+   * @public
+   */
+  OrchestrationSendingRoleArn?: string;
+
   /**
    * <p>The current version of the email channel.</p>
    * @public
@@ -7685,6 +7691,12 @@ export interface EmailChannelRequest {
    * @public
    */
   RoleArn?: string;
+
+  /**
+   * <p>The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.</p>
+   * @public
+   */
+  OrchestrationSendingRoleArn?: string;
 }
 
 /**
@@ -7908,7 +7920,7 @@ export interface EndpointMessageResult {
   Address?: string;
 
   /**
-   * <p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.</p></li>    <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>
+   * <p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.</p></li>    <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>
    * @public
    */
   DeliveryStatus: DeliveryStatus | undefined;

clients/client-pinpoint/src/models/models_1.ts

@@ -2268,7 +2268,7 @@ export interface ListTemplateVersionsResponse {
  */
 export interface MessageResult {
   /**
-   * <p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li>   <li><p>OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li>   <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint address.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>
+   * <p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li>   <li><p>OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li>   <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint address.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>
    * @public
    */
   DeliveryStatus: DeliveryStatus | undefined;

codegen/sdk-codegen/aws-models/pinpoint.json

@@ -5906,6 +5906,12 @@
           "traits": {
             "smithy.api#documentation": "<p>The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.</p>"
           }
+        },
+        "OrchestrationSendingRoleArn": {
+          "target": "com.amazonaws.pinpoint#__string",
+          "traits": {
+            "smithy.api#documentation": "<p>The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.</p>"
+          }
         }
       },
       "traits": {
@@ -6001,6 +6007,12 @@
             "smithy.api#documentation": "<p>The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.</p>"
           }
         },
+        "OrchestrationSendingRoleArn": {
+          "target": "com.amazonaws.pinpoint#__string",
+          "traits": {
+            "smithy.api#documentation": "<p>The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.</p>"
+          }
+        },
         "Version": {
           "target": "com.amazonaws.pinpoint#__integer",
           "traits": {
@@ -6469,7 +6481,7 @@
           "target": "com.amazonaws.pinpoint#DeliveryStatus",
           "traits": {
             "smithy.api#clientOptional": {},
-            "smithy.api#documentation": "<p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.</p></li>    <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>",
+            "smithy.api#documentation": "<p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.</p></li>    <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>",
             "smithy.api#required": {}
           }
         },
@@ -14277,7 +14289,7 @@
           "target": "com.amazonaws.pinpoint#DeliveryStatus",
           "traits": {
             "smithy.api#clientOptional": {},
-            "smithy.api#documentation": "<p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li>   <li><p>OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li>   <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint address.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>",
+            "smithy.api#documentation": "<p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li>   <li><p>OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li>   <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint address.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>",
             "smithy.api#required": {}
           }
         },