@aws-sdk/client-mailmanager 3.775.0 → 3.782.0

package/dist-types/commands/GetMemberOfAddressListCommand.d.ts

@@ -68,6 +68,7 @@ declare const GetMemberOfAddressListCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class GetMemberOfAddressListCommand extends GetMemberOfAddressListCommand_base {

package/dist-types/commands/GetRelayCommand.d.ts

@@ -70,6 +70,7 @@ declare const GetRelayCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class GetRelayCommand extends GetRelayCommand_base {

package/dist-types/commands/GetRuleSetCommand.d.ts

@@ -249,6 +249,7 @@ declare const GetRuleSetCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class GetRuleSetCommand extends GetRuleSetCommand_base {

package/dist-types/commands/GetTrafficPolicyCommand.d.ts

@@ -69,6 +69,15 @@ declare const GetTrafficPolicyCommand_base: {
  * //               "STRING_VALUE",
  * //             ],
  * //           },
+ * //           Ipv6Expression: { // IngressIpv6Expression
+ * //             Evaluate: { // IngressIpv6ToEvaluate Union: only one key present
+ * //               Attribute: "SENDER_IPV6",
+ * //             },
+ * //             Operator: "CIDR_MATCHES" || "NOT_CIDR_MATCHES", // required
+ * //             Values: [ // Ipv6Cidrs // required
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
  * //           TlsExpression: { // IngressTlsProtocolExpression
  * //             Evaluate: { // IngressTlsProtocolToEvaluate Union: only one key present
  * //               Attribute: "TLS_PROTOCOL",
@@ -119,6 +128,45 @@ declare const GetTrafficPolicyCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
+ * @example Get TrafficPolicy
+ * ```javascript
+ * //
+ * const input = {
+ *   TrafficPolicyId: "tp-12345"
+ * };
+ * const command = new GetTrafficPolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DefaultAction: "DENY",
+ *   MaxMessageSizeBytes: 1000,
+ *   PolicyStatements: [
+ *     {
+ *       Action: "ALLOW",
+ *       Conditions: [
+ *         {
+ *           StringExpression: {
+ *             Evaluate: {
+ *               Attribute: "RECIPIENT"
+ *             },
+ *             Operator: "EQUALS",
+ *             Values: [
+ *               "example@amazon.com",
+ *               "example@gmail.com"
+ *             ]
+ *           }
+ *         }
+ *       ]
+ *     }
+ *   ],
+ *   TrafficPolicyArn: "arn:aws:ses:us-east-1:123456789012:mailmanager-traffic-policy/tp-12345",
+ *   TrafficPolicyId: "tp-12345",
+ *   TrafficPolicyName: "trafficPolicyName"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class GetTrafficPolicyCommand extends GetTrafficPolicyCommand_base {

package/dist-types/commands/ListAddonInstancesCommand.d.ts

@@ -67,6 +67,7 @@ declare const ListAddonInstancesCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class ListAddonInstancesCommand extends ListAddonInstancesCommand_base {

package/dist-types/commands/ListAddonSubscriptionsCommand.d.ts

@@ -66,6 +66,7 @@ declare const ListAddonSubscriptionsCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class ListAddonSubscriptionsCommand extends ListAddonSubscriptionsCommand_base {

package/dist-types/commands/ListAddressListImportJobsCommand.d.ts

@@ -86,6 +86,7 @@ declare const ListAddressListImportJobsCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class ListAddressListImportJobsCommand extends ListAddressListImportJobsCommand_base {

package/dist-types/commands/ListAddressListsCommand.d.ts

@@ -73,6 +73,7 @@ declare const ListAddressListsCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class ListAddressListsCommand extends ListAddressListsCommand_base {

package/dist-types/commands/ListArchiveExportsCommand.d.ts

@@ -79,6 +79,7 @@ declare const ListArchiveExportsCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class ListArchiveExportsCommand extends ListArchiveExportsCommand_base {

package/dist-types/commands/ListArchiveSearchesCommand.d.ts

@@ -79,6 +79,7 @@ declare const ListArchiveSearchesCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class ListArchiveSearchesCommand extends ListArchiveSearchesCommand_base {

package/dist-types/commands/ListArchivesCommand.d.ts

@@ -72,6 +72,7 @@ declare const ListArchivesCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class ListArchivesCommand extends ListArchivesCommand_base {

package/dist-types/commands/ListIngressPointsCommand.d.ts

@@ -67,6 +67,74 @@ declare const ListIngressPointsCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
+ * @example List IngressPoints
+ * ```javascript
+ * //
+ * const input = { /* empty *\/ };
+ * const command = new ListIngressPointsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   IngressPoints: [
+ *     {
+ *       ARecord: "abcde123.prod.us-east-1.email-border.ses.aws.a2z.com",
+ *       IngressPointId: "inp-12345",
+ *       IngressPointName: "ingressPointName",
+ *       Status: "ACTIVE",
+ *       Type: "OPEN"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @example List IngressPoints with PageSize
+ * ```javascript
+ * //
+ * const input = {
+ *   PageSize: 10
+ * };
+ * const command = new ListIngressPointsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   IngressPoints: [
+ *     {
+ *       ARecord: "abcde123.prod.us-east-1.email-border.ses.aws.a2z.com",
+ *       IngressPointId: "inp-12345",
+ *       IngressPointName: "ingressPointName",
+ *       Status: "ACTIVE",
+ *       Type: "OPEN"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @example List IngressPoints with NextToken
+ * ```javascript
+ * //
+ * const input = {
+ *   NextToken: "nextToken"
+ * };
+ * const command = new ListIngressPointsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   IngressPoints: [
+ *     {
+ *       ARecord: "abcde123.prod.us-east-1.email-border.ses.aws.a2z.com",
+ *       IngressPointId: "inp-12345",
+ *       IngressPointName: "ingressPointName",
+ *       Status: "ACTIVE",
+ *       Type: "OPEN"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListIngressPointsCommand extends ListIngressPointsCommand_base {

package/dist-types/commands/ListMembersOfAddressListCommand.d.ts

@@ -77,6 +77,7 @@ declare const ListMembersOfAddressListCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class ListMembersOfAddressListCommand extends ListMembersOfAddressListCommand_base {

package/dist-types/commands/ListRelaysCommand.d.ts

@@ -65,6 +65,7 @@ declare const ListRelaysCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class ListRelaysCommand extends ListRelaysCommand_base {

package/dist-types/commands/ListRuleSetsCommand.d.ts

@@ -65,6 +65,7 @@ declare const ListRuleSetsCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class ListRuleSetsCommand extends ListRuleSetsCommand_base {

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -65,6 +65,7 @@ declare const ListTagsForResourceCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {

package/dist-types/commands/ListTrafficPoliciesCommand.d.ts

@@ -65,6 +65,68 @@ declare const ListTrafficPoliciesCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
+ * @example List TrafficPolicies
+ * ```javascript
+ * //
+ * const input = { /* empty *\/ };
+ * const command = new ListTrafficPoliciesCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   TrafficPolicies: [
+ *     {
+ *       DefaultAction: "DENY",
+ *       TrafficPolicyId: "tp-12345",
+ *       TrafficPolicyName: "trafficPolicyName"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @example List TrafficPolicies with PageSize
+ * ```javascript
+ * //
+ * const input = {
+ *   PageSize: 10
+ * };
+ * const command = new ListTrafficPoliciesCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   TrafficPolicies: [
+ *     {
+ *       DefaultAction: "DENY",
+ *       TrafficPolicyId: "tp-12345",
+ *       TrafficPolicyName: "trafficPolicyName"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @example List TrafficPolicies with NextToken
+ * ```javascript
+ * //
+ * const input = {
+ *   NextToken: "nextToken"
+ * };
+ * const command = new ListTrafficPoliciesCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   TrafficPolicies: [
+ *     {
+ *       DefaultAction: "DENY",
+ *       TrafficPolicyId: "tp-12345",
+ *       TrafficPolicyName: "trafficPolicyName"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListTrafficPoliciesCommand extends ListTrafficPoliciesCommand_base {

package/dist-types/commands/RegisterMemberToAddressListCommand.d.ts

@@ -68,6 +68,7 @@ declare const RegisterMemberToAddressListCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class RegisterMemberToAddressListCommand extends RegisterMemberToAddressListCommand_base {

package/dist-types/commands/StartAddressListImportJobCommand.d.ts

@@ -70,6 +70,7 @@ declare const StartAddressListImportJobCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class StartAddressListImportJobCommand extends StartAddressListImportJobCommand_base {

package/dist-types/commands/StartArchiveExportCommand.d.ts

@@ -118,6 +118,7 @@ declare const StartArchiveExportCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class StartArchiveExportCommand extends StartArchiveExportCommand_base {

package/dist-types/commands/StartArchiveSearchCommand.d.ts

@@ -115,6 +115,7 @@ declare const StartArchiveSearchCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class StartArchiveSearchCommand extends StartArchiveSearchCommand_base {

package/dist-types/commands/StopAddressListImportJobCommand.d.ts

@@ -67,6 +67,7 @@ declare const StopAddressListImportJobCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class StopAddressListImportJobCommand extends StopAddressListImportJobCommand_base {

package/dist-types/commands/StopArchiveExportCommand.d.ts

@@ -61,6 +61,7 @@ declare const StopArchiveExportCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class StopArchiveExportCommand extends StopArchiveExportCommand_base {

package/dist-types/commands/StopArchiveSearchCommand.d.ts

@@ -61,6 +61,7 @@ declare const StopArchiveSearchCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class StopArchiveSearchCommand extends StopArchiveSearchCommand_base {

package/dist-types/commands/TagResourceCommand.d.ts

@@ -70,6 +70,7 @@ declare const TagResourceCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class TagResourceCommand extends TagResourceCommand_base {

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -64,6 +64,7 @@ declare const UntagResourceCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class UntagResourceCommand extends UntagResourceCommand_base {

package/dist-types/commands/UpdateArchiveCommand.d.ts

@@ -74,6 +74,7 @@ declare const UpdateArchiveCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class UpdateArchiveCommand extends UpdateArchiveCommand_base {

package/dist-types/commands/UpdateIngressPointCommand.d.ts

@@ -69,6 +69,68 @@ declare const UpdateIngressPointCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
+ * @example Update Open/Auth IngressPoint with new Name
+ * ```javascript
+ * //
+ * const input = {
+ *   IngressPointId: "inp-12345",
+ *   IngressPointName: "ingressPointNewName"
+ * };
+ * const command = new UpdateIngressPointCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
+ * @example Update Open/Auth IngressPoint with new RuleSetId / TrafficPolicyId
+ * ```javascript
+ * //
+ * const input = {
+ *   IngressPointId: "inp-12345",
+ *   RuleSetId: "rs-12345",
+ *   TrafficPolicyId: "tp-12345"
+ * };
+ * const command = new UpdateIngressPointCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
+ * @example Update Auth IngressPoint with new SmtpPassword
+ * ```javascript
+ * //
+ * const input = {
+ *   IngressPointConfiguration: {
+ *     SmtpPassword: "newSmtpPassword"
+ *   },
+ *   IngressPointId: "inp-12345"
+ * };
+ * const command = new UpdateIngressPointCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
+ * @example Update Auth IngressPoint with new SecretArn
+ * ```javascript
+ * //
+ * const input = {
+ *   IngressPointConfiguration: {
+ *     SecretArn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:abcde"
+ *   },
+ *   IngressPointId: "inp-12345"
+ * };
+ * const command = new UpdateIngressPointCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class UpdateIngressPointCommand extends UpdateIngressPointCommand_base {

package/dist-types/commands/UpdateRelayCommand.d.ts

@@ -68,6 +68,7 @@ declare const UpdateRelayCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class UpdateRelayCommand extends UpdateRelayCommand_base {

package/dist-types/commands/UpdateRuleSetCommand.d.ts

@@ -247,6 +247,7 @@ declare const UpdateRuleSetCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
  * @public
  */
 export declare class UpdateRuleSetCommand extends UpdateRuleSetCommand_base {

package/dist-types/commands/UpdateTrafficPolicyCommand.d.ts

@@ -63,6 +63,15 @@ declare const UpdateTrafficPolicyCommand_base: {
  *               "STRING_VALUE",
  *             ],
  *           },
+ *           Ipv6Expression: { // IngressIpv6Expression
+ *             Evaluate: { // IngressIpv6ToEvaluate Union: only one key present
+ *               Attribute: "SENDER_IPV6",
+ *             },
+ *             Operator: "CIDR_MATCHES" || "NOT_CIDR_MATCHES", // required
+ *             Values: [ // Ipv6Cidrs // required
+ *               "STRING_VALUE",
+ *             ],
+ *           },
  *           TlsExpression: { // IngressTlsProtocolExpression
  *             Evaluate: { // IngressTlsProtocolToEvaluate Union: only one key present
  *               Attribute: "TLS_PROTOCOL",
@@ -117,6 +126,67 @@ declare const UpdateTrafficPolicyCommand_base: {
  * @throws {@link MailManagerServiceException}
  * <p>Base exception class for all service exceptions from MailManager service.</p>
  *
+ *
+ * @example Update TrafficPolicy with new Name
+ * ```javascript
+ * //
+ * const input = {
+ *   TrafficPolicyId: "tp-12345",
+ *   TrafficPolicyName: "trafficPolicyNewName"
+ * };
+ * const command = new UpdateTrafficPolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
+ * @example Update TrafficPolicy with new PolicyStatements
+ * ```javascript
+ * //
+ * const input = {
+ *   PolicyStatements: [
+ *     {
+ *       Action: "ALLOW",
+ *       Conditions: [
+ *         {
+ *           StringExpression: {
+ *             Evaluate: {
+ *               Attribute: "RECIPIENT"
+ *             },
+ *             Operator: "EQUALS",
+ *             Values: [
+ *               "example@amazon.com",
+ *               "example@gmail.com"
+ *             ]
+ *           }
+ *         }
+ *       ]
+ *     }
+ *   ],
+ *   TrafficPolicyId: "tp-12345"
+ * };
+ * const command = new UpdateTrafficPolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
+ * @example Update TrafficPolicy with new DefaultAction
+ * ```javascript
+ * //
+ * const input = {
+ *   DefaultAction: "ALLOW",
+ *   TrafficPolicyId: "tp-12345"
+ * };
+ * const command = new UpdateTrafficPolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class UpdateTrafficPolicyCommand extends UpdateTrafficPolicyCommand_base {