Skip to content

Commit 048d165

Browse files
author
awstools
committed
feat(client-mailmanager): Added new "DeliverToQBusiness" rule action to MailManager RulesSet for ingesting email data into Amazon Q Business customer applications
1 parent dbe3f07 commit 048d165

File tree

6 files changed

+150
-0
lines changed

6 files changed

+150
-0
lines changed

clients/client-mailmanager/src/commands/CreateRuleSetCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,12 @@ export interface CreateRuleSetCommandOutput extends CreateRuleSetResponse, __Met
192192
* MailboxArn: "STRING_VALUE", // required
193193
* RoleArn: "STRING_VALUE", // required
194194
* },
195+
* DeliverToQBusiness: { // DeliverToQBusinessAction
196+
* ActionFailurePolicy: "CONTINUE" || "DROP",
197+
* ApplicationId: "STRING_VALUE", // required
198+
* IndexId: "STRING_VALUE", // required
199+
* RoleArn: "STRING_VALUE", // required
200+
* },
195201
* },
196202
* ],
197203
* },

clients/client-mailmanager/src/commands/GetRuleSetCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,12 @@ export interface GetRuleSetCommandOutput extends GetRuleSetResponse, __MetadataB
196196
* // MailboxArn: "STRING_VALUE", // required
197197
* // RoleArn: "STRING_VALUE", // required
198198
* // },
199+
* // DeliverToQBusiness: { // DeliverToQBusinessAction
200+
* // ActionFailurePolicy: "CONTINUE" || "DROP",
201+
* // ApplicationId: "STRING_VALUE", // required
202+
* // IndexId: "STRING_VALUE", // required
203+
* // RoleArn: "STRING_VALUE", // required
204+
* // },
199205
* // },
200206
* // ],
201207
* // },

clients/client-mailmanager/src/commands/UpdateRuleSetCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,12 @@ export interface UpdateRuleSetCommandOutput extends UpdateRuleSetResponse, __Met
192192
* MailboxArn: "STRING_VALUE", // required
193193
* RoleArn: "STRING_VALUE", // required
194194
* },
195+
* DeliverToQBusiness: { // DeliverToQBusinessAction
196+
* ActionFailurePolicy: "CONTINUE" || "DROP",
197+
* ApplicationId: "STRING_VALUE", // required
198+
* IndexId: "STRING_VALUE", // required
199+
* RoleArn: "STRING_VALUE", // required
200+
* },
195201
* },
196202
* ],
197203
* },

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

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1421,6 +1421,41 @@ export interface DeliverToMailboxAction {
14211421
RoleArn: string | undefined;
14221422
}
14231423

1424+
/**
1425+
* <p>The action to deliver incoming emails to an Amazon Q Business application for indexing.</p>
1426+
* @public
1427+
*/
1428+
export interface DeliverToQBusinessAction {
1429+
/**
1430+
* <p>A policy that states what to do in the case of failure. The action will fail if there are
1431+
* configuration errors. For example, the specified application has been deleted or the role lacks
1432+
* necessary permissions to call the qbusiness:BatchPutDocument API.</p>
1433+
* @public
1434+
*/
1435+
ActionFailurePolicy?: ActionFailurePolicy | undefined;
1436+
1437+
/**
1438+
* <p>The unique identifier of the Amazon Q Business application instance where the email
1439+
* content will be delivered.</p>
1440+
* @public
1441+
*/
1442+
ApplicationId: string | undefined;
1443+
1444+
/**
1445+
* <p>The identifier of the knowledge base index within the Amazon Q Business application
1446+
* where the email content will be stored and indexed.</p>
1447+
* @public
1448+
*/
1449+
IndexId: string | undefined;
1450+
1451+
/**
1452+
* <p>The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access
1453+
* to the qbusiness:BatchPutDocument API for the given application and index.</p>
1454+
* @public
1455+
*/
1456+
RoleArn: string | undefined;
1457+
}
1458+
14241459
/**
14251460
* <p>This action causes processing to stop and the email to be dropped. If the action
14261461
* applies only to certain recipients, only those recipients are dropped, and processing
@@ -1552,6 +1587,7 @@ export type RuleAction =
15521587
| RuleAction.AddHeaderMember
15531588
| RuleAction.ArchiveMember
15541589
| RuleAction.DeliverToMailboxMember
1590+
| RuleAction.DeliverToQBusinessMember
15551591
| RuleAction.DropMember
15561592
| RuleAction.RelayMember
15571593
| RuleAction.ReplaceRecipientMember
@@ -1576,6 +1612,7 @@ export namespace RuleAction {
15761612
AddHeader?: never;
15771613
ReplaceRecipient?: never;
15781614
DeliverToMailbox?: never;
1615+
DeliverToQBusiness?: never;
15791616
$unknown?: never;
15801617
}
15811618

@@ -1592,6 +1629,7 @@ export namespace RuleAction {
15921629
AddHeader?: never;
15931630
ReplaceRecipient?: never;
15941631
DeliverToMailbox?: never;
1632+
DeliverToQBusiness?: never;
15951633
$unknown?: never;
15961634
}
15971635

@@ -1609,6 +1647,7 @@ export namespace RuleAction {
16091647
AddHeader?: never;
16101648
ReplaceRecipient?: never;
16111649
DeliverToMailbox?: never;
1650+
DeliverToQBusiness?: never;
16121651
$unknown?: never;
16131652
}
16141653

@@ -1625,6 +1664,7 @@ export namespace RuleAction {
16251664
AddHeader?: never;
16261665
ReplaceRecipient?: never;
16271666
DeliverToMailbox?: never;
1667+
DeliverToQBusiness?: never;
16281668
$unknown?: never;
16291669
}
16301670

@@ -1641,6 +1681,7 @@ export namespace RuleAction {
16411681
AddHeader?: never;
16421682
ReplaceRecipient?: never;
16431683
DeliverToMailbox?: never;
1684+
DeliverToQBusiness?: never;
16441685
$unknown?: never;
16451686
}
16461687

@@ -1657,6 +1698,7 @@ export namespace RuleAction {
16571698
AddHeader: AddHeaderAction;
16581699
ReplaceRecipient?: never;
16591700
DeliverToMailbox?: never;
1701+
DeliverToQBusiness?: never;
16601702
$unknown?: never;
16611703
}
16621704

@@ -1674,6 +1716,7 @@ export namespace RuleAction {
16741716
AddHeader?: never;
16751717
ReplaceRecipient: ReplaceRecipientAction;
16761718
DeliverToMailbox?: never;
1719+
DeliverToQBusiness?: never;
16771720
$unknown?: never;
16781721
}
16791722

@@ -1690,6 +1733,25 @@ export namespace RuleAction {
16901733
AddHeader?: never;
16911734
ReplaceRecipient?: never;
16921735
DeliverToMailbox: DeliverToMailboxAction;
1736+
DeliverToQBusiness?: never;
1737+
$unknown?: never;
1738+
}
1739+
1740+
/**
1741+
* <p>This action delivers an email to an Amazon Q Business application for ingestion into
1742+
* its knowledge base.</p>
1743+
* @public
1744+
*/
1745+
export interface DeliverToQBusinessMember {
1746+
Drop?: never;
1747+
Relay?: never;
1748+
Archive?: never;
1749+
WriteToS3?: never;
1750+
Send?: never;
1751+
AddHeader?: never;
1752+
ReplaceRecipient?: never;
1753+
DeliverToMailbox?: never;
1754+
DeliverToQBusiness: DeliverToQBusinessAction;
16931755
$unknown?: never;
16941756
}
16951757

@@ -1705,6 +1767,7 @@ export namespace RuleAction {
17051767
AddHeader?: never;
17061768
ReplaceRecipient?: never;
17071769
DeliverToMailbox?: never;
1770+
DeliverToQBusiness?: never;
17081771
$unknown: [string, any];
17091772
}
17101773

@@ -1717,6 +1780,7 @@ export namespace RuleAction {
17171780
AddHeader: (value: AddHeaderAction) => T;
17181781
ReplaceRecipient: (value: ReplaceRecipientAction) => T;
17191782
DeliverToMailbox: (value: DeliverToMailboxAction) => T;
1783+
DeliverToQBusiness: (value: DeliverToQBusinessAction) => T;
17201784
_: (name: string, value: any) => T;
17211785
}
17221786

@@ -1729,6 +1793,7 @@ export namespace RuleAction {
17291793
if (value.AddHeader !== undefined) return visitor.AddHeader(value.AddHeader);
17301794
if (value.ReplaceRecipient !== undefined) return visitor.ReplaceRecipient(value.ReplaceRecipient);
17311795
if (value.DeliverToMailbox !== undefined) return visitor.DeliverToMailbox(value.DeliverToMailbox);
1796+
if (value.DeliverToQBusiness !== undefined) return visitor.DeliverToQBusiness(value.DeliverToQBusiness);
17321797
return visitor._(value.$unknown[0], value.$unknown[1]);
17331798
};
17341799
}
@@ -4888,6 +4953,7 @@ export const RuleActionFilterSensitiveLog = (obj: RuleAction): any => {
48884953
if (obj.ReplaceRecipient !== undefined)
48894954
return { ReplaceRecipient: ReplaceRecipientActionFilterSensitiveLog(obj.ReplaceRecipient) };
48904955
if (obj.DeliverToMailbox !== undefined) return { DeliverToMailbox: obj.DeliverToMailbox };
4956+
if (obj.DeliverToQBusiness !== undefined) return { DeliverToQBusiness: obj.DeliverToQBusiness };
48914957
if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" };
48924958
};
48934959

clients/client-mailmanager/src/protocols/Aws_json1_0.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ import {
150150
DeleteRuleSetRequest,
151151
DeleteTrafficPolicyRequest,
152152
DeliverToMailboxAction,
153+
DeliverToQBusinessAction,
153154
DropAction,
154155
ExportDestinationConfiguration,
155156
ExportStatus,
@@ -2059,6 +2060,8 @@ const se_CreateTrafficPolicyRequest = (input: CreateTrafficPolicyRequest, contex
20592060

20602061
// se_DeliverToMailboxAction omitted.
20612062

2063+
// se_DeliverToQBusinessAction omitted.
2064+
20622065
// se_DropAction omitted.
20632066

20642067
// se_ExportDestinationConfiguration omitted.
@@ -2439,6 +2442,8 @@ const de_ArchivesList = (output: any, context: __SerdeContext): Archive[] => {
24392442

24402443
// de_DeliverToMailboxAction omitted.
24412444

2445+
// de_DeliverToQBusinessAction omitted.
2446+
24422447
// de_DropAction omitted.
24432448

24442449
// de_EmailReceivedHeadersList omitted.

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

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1727,6 +1727,41 @@
17271727
"smithy.api#documentation": "<p>This action to delivers an email to a mailbox.</p>"
17281728
}
17291729
},
1730+
"com.amazonaws.mailmanager#DeliverToQBusinessAction": {
1731+
"type": "structure",
1732+
"members": {
1733+
"ActionFailurePolicy": {
1734+
"target": "com.amazonaws.mailmanager#ActionFailurePolicy",
1735+
"traits": {
1736+
"smithy.api#documentation": "<p>A policy that states what to do in the case of failure. The action will fail if there are\n configuration errors. For example, the specified application has been deleted or the role lacks\n necessary permissions to call the qbusiness:BatchPutDocument API.</p>"
1737+
}
1738+
},
1739+
"ApplicationId": {
1740+
"target": "com.amazonaws.mailmanager#QBusinessApplicationId",
1741+
"traits": {
1742+
"smithy.api#documentation": "<p>The unique identifier of the Amazon Q Business application instance where the email\n content will be delivered.</p>",
1743+
"smithy.api#required": {}
1744+
}
1745+
},
1746+
"IndexId": {
1747+
"target": "com.amazonaws.mailmanager#QBusinessIndexId",
1748+
"traits": {
1749+
"smithy.api#documentation": "<p>The identifier of the knowledge base index within the Amazon Q Business application\n where the email content will be stored and indexed.</p>",
1750+
"smithy.api#required": {}
1751+
}
1752+
},
1753+
"RoleArn": {
1754+
"target": "com.amazonaws.mailmanager#IamRoleArn",
1755+
"traits": {
1756+
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access\n to the qbusiness:BatchPutDocument API for the given application and index.</p>",
1757+
"smithy.api#required": {}
1758+
}
1759+
}
1760+
},
1761+
"traits": {
1762+
"smithy.api#documentation": "<p>The action to deliver incoming emails to an Amazon Q Business application for indexing.</p>"
1763+
}
1764+
},
17301765
"com.amazonaws.mailmanager#DropAction": {
17311766
"type": "structure",
17321767
"members": {},
@@ -5333,6 +5368,26 @@
53335368
"target": "com.amazonaws.mailmanager#PolicyStatement"
53345369
}
53355370
},
5371+
"com.amazonaws.mailmanager#QBusinessApplicationId": {
5372+
"type": "string",
5373+
"traits": {
5374+
"smithy.api#length": {
5375+
"min": 36,
5376+
"max": 36
5377+
},
5378+
"smithy.api#pattern": "^[a-z0-9-]+$"
5379+
}
5380+
},
5381+
"com.amazonaws.mailmanager#QBusinessIndexId": {
5382+
"type": "string",
5383+
"traits": {
5384+
"smithy.api#length": {
5385+
"min": 36,
5386+
"max": 36
5387+
},
5388+
"smithy.api#pattern": "^[a-z0-9-]+$"
5389+
}
5390+
},
53365391
"com.amazonaws.mailmanager#Recipients": {
53375392
"type": "list",
53385393
"member": {
@@ -5867,6 +5922,12 @@
58675922
"traits": {
58685923
"smithy.api#documentation": "<p>This action delivers an email to a WorkMail mailbox.</p>"
58695924
}
5925+
},
5926+
"DeliverToQBusiness": {
5927+
"target": "com.amazonaws.mailmanager#DeliverToQBusinessAction",
5928+
"traits": {
5929+
"smithy.api#documentation": "<p>This action delivers an email to an Amazon Q Business application for ingestion into\n its knowledge base.</p>"
5930+
}
58705931
}
58715932
},
58725933
"traits": {

0 commit comments

Comments
 (0)