diff --git a/awscli/examples/notifications/associate-channel.rst b/awscli/examples/notifications/associate-channel.rst new file mode 100644 index 000000000000..3dd6342ee308 --- /dev/null +++ b/awscli/examples/notifications/associate-channel.rst @@ -0,0 +1,11 @@ +**To associate a delivery channel** + +The following ``associate-channel`` example associates a delivery channel with a particular NotificationConfiguration. :: + + aws notifications associate-channel \ + --arn arn:aws:notifications-contacts::123456789012:emailcontact/a01jjz5n8e8557aswvm1fv4wqrf \ + --notification-configuration-arn arn:aws:notifications::123456789012:configuration/a01jjzj251d2wxsss2wvtvxethb + +This command produces no output. + +For more information, see `Adding delivery channels in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/create-event-rule.rst b/awscli/examples/notifications/create-event-rule.rst new file mode 100644 index 000000000000..78f6d8128faa --- /dev/null +++ b/awscli/examples/notifications/create-event-rule.rst @@ -0,0 +1,24 @@ +**To create an eventrule** + +The following ``create-event-rule`` example creates an event rule associated with a specified NotificationConfiguration. :: + + aws notifications create-event-rule \ + --notification-configuration-arn arn:aws:notifications::123456789012:configuration/a01jjzj251d2wxsss2wvtvxethb \ + --source aws.health \ + --event-type "AWS Health Event" \ + --regions us-east-1 + +Output:: + + { + "arn": "arn:aws:notifications::123456789012:configuration/a01jjzj251d2wxsss2wvtvxethb/rule/a01jjzkdcbfq2chvmramvnv28nm", + "notificationConfigurationArn": "arn:aws:notifications::123456789012:configuration/a01jjzj251d2wxsss2wvtvxethb", + "statusSummaryByRegion": { + "us-east-1": { + "status": "CREATING", + "reason": "" + } + } + } + +For more information, see `Creating your first notification configuration in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/create-notification-configuration.rst b/awscli/examples/notifications/create-notification-configuration.rst new file mode 100644 index 000000000000..8a24471bbea7 --- /dev/null +++ b/awscli/examples/notifications/create-notification-configuration.rst @@ -0,0 +1,17 @@ +**To create a notificationconfiguration** + +The following ``create-notification-configuration`` example creates a NotificationConfiguration. :: + + aws notifications create-notification-configuration \ + --name testnotification-1 \ + --aggregation-duration SHORT \ + --description CLI-Demo + +Output:: + + { + "arn": "arn:aws:notifications::123456789012:configuration/a01jjzj251d2wxsss2wvtvxethb", + "status": "INACTIVE" + } + +For more information, see `Adding delivery channels in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/delete-event-rule.rst b/awscli/examples/notifications/delete-event-rule.rst new file mode 100644 index 000000000000..3b83eb701194 --- /dev/null +++ b/awscli/examples/notifications/delete-event-rule.rst @@ -0,0 +1,10 @@ +**To delete an eventrule** + +The following ``delete-event-rule`` example deletes an EventRule associated to a specific NotificationConfiguration. :: + + aws notifications delete-event-rule \ + --arn arn:aws:notifications::123456789012:configuration/a01jjzj251d2wxsss2wvtvxethb/rule/a01jjzkdcbfq2chvmramvnv28nm + +This command produces no output. + +For more information, see `Deleting notification configurations in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/delete-notification-configuration.rst b/awscli/examples/notifications/delete-notification-configuration.rst new file mode 100644 index 000000000000..7a242564b95c --- /dev/null +++ b/awscli/examples/notifications/delete-notification-configuration.rst @@ -0,0 +1,10 @@ +**To delete a notificationconfiguration** + +The following ``delete-notification-configuration`` example deletes a NotificationConfiguration. :: + + aws notifications delete-notification-configuration \ + --arn arn:aws:notifications::123456789012:configuration/a01jjzj251d2wxsss2wvtvxethb + +This command produces no output. + +For more information, see `Deleting notification configurations in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/deregister-notification-hub.rst b/awscli/examples/notifications/deregister-notification-hub.rst new file mode 100644 index 000000000000..e45c3f30d22e --- /dev/null +++ b/awscli/examples/notifications/deregister-notification-hub.rst @@ -0,0 +1,17 @@ +**To deregisters a notificationconfiguration** + +The following ``deregister-notification-hub`` example deregisters a NotificationConfiguration in the specified Region. :: + + aws notifications deregister-notification-hub --notification-hub-region us-west-2 + +Output:: + + { + "notificationHubRegion": "us-west-2", + "statusSummary": { + "status": "DEREGISTERING", + "reason": "" + } + } + +For more information, see `Adding or removing a notification hub in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/disassociate-channel.rst b/awscli/examples/notifications/disassociate-channel.rst new file mode 100644 index 000000000000..6704c23874d4 --- /dev/null +++ b/awscli/examples/notifications/disassociate-channel.rst @@ -0,0 +1,11 @@ +**To disassociates a channel** + +The following ``disassociate-channel`` example disassociates a Channel from a specified NotificationConfiguration. :: + + aws notifications disassociate-channel \ + --notification-configuration-arn arn:aws:notifications::123456789012:configuration/a01jjzhee9p37n8gc2ke1mr5zjx \ + --arn arn:aws:chatbot::123456789012:chat-configuration/slack-channel/Slack-CW-Events-Integration + +This command produces no output. + +For more information, see `Editing notification configurations in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/get-event-rule.rst b/awscli/examples/notifications/get-event-rule.rst new file mode 100644 index 000000000000..0230c64b6dff --- /dev/null +++ b/awscli/examples/notifications/get-event-rule.rst @@ -0,0 +1,29 @@ +**To view the details of a specified eventrule** + +The following ``get-event-rule`` example display the details about a specific EventRule. :: + + aws notifications get-event-rule \ + --arn arn:aws:notifications::123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh/rule/a01jg2z8ydvea0x0v3z8xkwjrrs + +Output:: + + { + "arn": "arn:aws:notifications::123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh/rule/a01jg2z8ydvea0x0v3z8xkwjrrs", + "notificationConfigurationArn": "arn:aws:notifications::123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh", + "creationTime": "2024-10-27T02:31:35.611000+00:00", + "source": "aws.health", + "eventType": "AWS Health Event", + "eventPattern": "", + "regions": [ + "us-east-1" + ], + "managedRules": [ + "arn:aws:events:us-east-1:123456789012:rule/AWSUserNotificationsManagedRule-aa1apyq" + ], + "statusSummaryByRegion": { + "us-east-1": { + "status": "ACTIVE", + "reason": "" + } + } + } diff --git a/awscli/examples/notifications/get-notification-configuration.rst b/awscli/examples/notifications/get-notification-configuration.rst new file mode 100644 index 000000000000..5ccf7e1e5a97 --- /dev/null +++ b/awscli/examples/notifications/get-notification-configuration.rst @@ -0,0 +1,17 @@ +**To view the details of a specified notificationconfiguration** + +The following ``get-notification-configuration`` example displays the details about a specific NotificationConfiguration. :: + + aws notifications get-notification-configuration \ + --arn arn:aws:notifications::123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh + +Output:: + + { + "arn": "arn:aws:notifications::123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh", + "name": "Health-quick-setup", + "description": "Health notifications created with quick setup", + "status": "ACTIVE", + "creationTime": "2024-10-27T02:31:34.987000+00:00", + "aggregationDuration": "SHORT" + } diff --git a/awscli/examples/notifications/get-notification-event.rst b/awscli/examples/notifications/get-notification-event.rst new file mode 100644 index 000000000000..d32743ec63ca --- /dev/null +++ b/awscli/examples/notifications/get-notification-event.rst @@ -0,0 +1,87 @@ +**To view the details of a specified notification event** + +The following ``get-notification-event`` example displays a specific notification event. :: + + aws notifications get-notification-event \ + --arn arn:aws:notifications:us-east-1:123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh/event/a01jjta9p8wvpgt281q0e10e457 + +Output:: + + { + "arn": "arn:aws:notifications:us-east-1:123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh/event/a01jjta9p8wvpgt281q0e10e457", + "notificationConfigurationArn": "arn:aws:notifications::123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh", + "creationTime": "2024-11-30T00:38:09.948000+00:00", + "content": { + "schemaVersion": "v1.0", + "id": "a01jjta9p8wvpgt281q0e10e457", + "sourceEventMetadata": { + "eventTypeVersion": "0", + "sourceEventId": "0c1aa45d-8e0c-6a46-114c-f89a9f7c3bd1", + "eventOriginRegion": "us-east-1", + "relatedAccount": "123456789012", + "source": "aws.health", + "eventOccurrenceTime": "2024-11-30T00:37:40+00:00", + "eventType": "AWS Health Event", + "relatedResources": [] + }, + "messageComponents": { + "headline": "$SingleSentenceSummary", + "paragraphSummary": "$ParagraphSummary", + "completeDescription": "$CompleteDescription", + "dimensions": [ + { + "name": "Affected account", + "value": "123456789012" + }, + { + "name": "Service", + "value": "CLOUDFRONT" + }, + { + "name": "Event type code", + "value": "AWS_CLOUDFRONT_OPERATIONAL_ISSUE" + }, + { + "name": "Event type category", + "value": "issue" + }, + { + "name": "Event region", + "value": "global" + }, + { + "name": "Start time", + "value": "Wed, 29 Nov 2024 10:18:05 GMT" + }, + { + "name": "End time", + "value": "Wed, 29 Nov 2024 11:40:53 GMT" + } + ] + }, + "sourceEventDetailUrl": "https://health.aws.amazon.com/health/home?region=us-east-1#/event-log?eventID=arn:aws:health:global::event/CLOUDFRONT/AWS_CLOUDFRONT_OPERATIONAL_ISSUE/AWS_CLOUDFRONT_OPERATIONAL_ISSUE_94265_0AFCF3D5C81&eventTab=details&layout=vertical", + "notificationType": "ALERT", + "aggregationEventType": "NONE", + "textParts": { + "CompleteDescription": { + "type": "LOCALIZED_TEXT", + "textByLocale": { + "en_US": "Current severity level: Operating normally\n\n[RESOLVED] Increased Error Rates\n\n[03:40 AM PST] Between November 28 10:56 PM and November 29 3:06 AM PST, we experienced an issue for CloudFront customers with S3 static website origins. This issue was the result of a recent change which impacted traffic from certain CloudFront locations to S3 static website origins and resulted in \"404 NoSuchBucket\" errors. Our engineers were engaged and immediately began investigating multiple parallel paths to mitigate the impact. We initiated a rollback of the change which led to full recovery of errors at 3:06 AM PST. The issue has been resolved and the service is operating normally." + } + }, + "ParagraphSummary": { + "type": "LOCALIZED_TEXT", + "textByLocale": { + "en_US": "Current severity level: Operating normally\n\n[RESOLVED] Increased Error Rates\n\n[03:40 AM PST] Between November 28 10:56 PM and November 29 3:06 AM PST, we experienced an issue for CloudFront customers with S3 static website origins. This issue was the result of a recent change which impacted traffic from certain CloudFront locations to S3 static website origins and resulted in \"404 NoSuchBucket\" errors. Our engineers were engaged and immediately began investigating multiple parallel paths to mitigate the im..." + } + }, + "SingleSentenceSummary": { + "type": "LOCALIZED_TEXT", + "textByLocale": { + "en_US": "Health Event: AWS CLOUDFRONT OPERATIONAL ISSUE in global on account 123456789012." + } + } + }, + "media": [] + } + } \ No newline at end of file diff --git a/awscli/examples/notifications/list-channels.rst b/awscli/examples/notifications/list-channels.rst new file mode 100644 index 000000000000..7340bdb7411f --- /dev/null +++ b/awscli/examples/notifications/list-channels.rst @@ -0,0 +1,16 @@ +**To view the list of channels for a specific notificationconfiguration** + +The following ``list-channels`` example displays the list of channels configured for a specific NotificationConfiguration. :: + + aws notifications list-channels \ + --notification-configuration-arn arn:aws:notifications::123456789012:configuration/a01jg38mtmd0ta5zshhstphfw8w + +Output:: + + { + "channels": [ + "arn:aws:notifications-contacts::123456789012:emailcontact/a01jjz5n8e8557aswvm1fv4wqrf" + ] + } + +For more information, see `Viewing delivery channel details in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/list-event-rules.rst b/awscli/examples/notifications/list-event-rules.rst new file mode 100644 index 000000000000..aaa54dd24ddc --- /dev/null +++ b/awscli/examples/notifications/list-event-rules.rst @@ -0,0 +1,33 @@ +**To view the list of event rules** + +The following ``list-event-rules`` example displays the list of event rules for a specific NotificationConfiguration. :: + + aws notifications list-event-rules \ + --notification-configuration-arn arn:aws:notifications::123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh + +Output:: + + { + "eventRules": [ + { + "arn": "arn:aws:notifications::123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh/rule/a01jg2z8ydvea0x0v3z8xkwjrrs", + "notificationConfigurationArn": "arn:aws:notifications::123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh", + "creationTime": "2024-10-27T02:31:35.611000+00:00", + "source": "aws.health", + "eventType": "AWS Health Event", + "eventPattern": "", + "regions": [ + "us-east-1" + ], + "managedRules": [ + "arn:aws:events:us-east-1:123456789012:rule/AWSUserNotificationsManagedRule-aa1apyq" + ], + "statusSummaryByRegion": { + "us-east-1": { + "status": "ACTIVE", + "reason": "" + } + } + } + ] + } \ No newline at end of file diff --git a/awscli/examples/notifications/list-notification-configurations.rst b/awscli/examples/notifications/list-notification-configurations.rst new file mode 100644 index 000000000000..ad32d28761ca --- /dev/null +++ b/awscli/examples/notifications/list-notification-configurations.rst @@ -0,0 +1,36 @@ +**To view the list of notificationconfiguration ** + +The following ``list-notification-configurations`` example displays the list of NotificationConfiguration. :: + + aws notifications list-notification-configurations + +Output:: + + { + "notificationConfigurations": [ + { + "arn": "arn:aws:notifications::123456789012:configuration/a01jg38mtmd0ta5zshhstphfw8w", + "name": "EC2-quick-setup", + "description": "EC2 notifications created with quick setup", + "status": "ACTIVE", + "creationTime": "2024-10-27T05:15:22.126000+00:00", + "aggregationDuration": "SHORT" + }, + { + "arn": "arn:aws:notifications::123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh", + "name": "Health-quick-setup", + "description": "Health notifications created with quick setup", + "status": "ACTIVE", + "creationTime": "2024-10-27T02:31:34.987000+00:00", + "aggregationDuration": "SHORT" + }, + { + "arn": "arn:aws:notifications::123456789012:configuration/a01jg2ne1shtc7pbwanwdvn0h7t", + "name": "test-notification", + "description": "test-notification", + "status": "INACTIVE", + "creationTime": "2024-10-26T23:39:37.137000+00:00", + "aggregationDuration": "SHORT" + } + ] + } \ No newline at end of file diff --git a/awscli/examples/notifications/list-notification-events.rst b/awscli/examples/notifications/list-notification-events.rst new file mode 100644 index 000000000000..178df194272b --- /dev/null +++ b/awscli/examples/notifications/list-notification-events.rst @@ -0,0 +1,51 @@ +**To view the list of notification events** + +The following ``list-notification-events`` example displays the list of notification events. :: + + aws notifications list-notification-events + +Output:: + + { + "notificationEvents": [{ + "arn": "arn:aws:notifications:us-east-1:123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh/event/a01jjta9p8wvpgt281q0e10e457", + "notificationConfigurationArn": "arn:aws:notifications::123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh", + "relatedAccount": "123456789012", + "creationTime": "2024-11-30T00:38:09.948000+00:00", + "notificationEvent": { + "schemaVersion": "v1.0", + "sourceEventMetadata": { + "eventOriginRegion": "us-east-1", + "source": "aws.health", + "eventType": "AWS Health Event" + }, + "messageComponents": { + "headline": "Health Event: AWS CLOUDFRONT OPERATIONAL ISSUE in global on account 123456789012." + }, + "eventStatus": "null", + "notificationType": "ALERT" + }, + "aggregationEventType": "NONE" + }, + { + "arn": "arn:aws:notifications:us-east-1:123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh/event/a01jjt9mgqeewxcr08jccgxqnkj", + "notificationConfigurationArn": "arn:aws:notifications::123456789012:configuration/a01jg2z8xtb12whwyg3ztxmjazh", + "relatedAccount": "123456789012", + "creationTime": "2024-11-30T00:26:36.142000+00:00", + "notificationEvent": { + "schemaVersion": "v1.0", + "sourceEventMetadata": { + "eventOriginRegion": "us-east-1", + "source": "aws.health", + "eventType": "AWS Health Event" + }, + "messageComponents": { + "headline": "Health Event: AWS CLOUDFRONT OPERATIONAL ISSUE in global on account 123456789012." + }, + "eventStatus": "null", + "notificationType": "ALERT" + }, + "aggregationEventType": "NONE" + } + ] + } \ No newline at end of file diff --git a/awscli/examples/notifications/list-notification-hubs.rst b/awscli/examples/notifications/list-notification-hubs.rst new file mode 100644 index 000000000000..e30e4a02ef5a --- /dev/null +++ b/awscli/examples/notifications/list-notification-hubs.rst @@ -0,0 +1,30 @@ +**To view the list of notification hubs** + +The following ``list-notification-hubs`` example displays the list of notification hubs. :: + + aws notifications list-notification-hubs + +Output:: + + { + "notificationHubs": [ + { + "notificationHubRegion": "us-east-1", + "statusSummary": { + "status": "ACTIVE", + "reason": "" + }, + "creationTime": "2023-06-16T07:16:35.164000+00:00", + "lastActivationTime": "2023-06-16T07:16:35.251000+00:00" + }, + { + "notificationHubRegion": "ap-southeast-2", + "statusSummary": { + "status": "ACTIVE", + "reason": "" + }, + "creationTime": "2024-09-31T04:06:57.879000+00:00", + "lastActivationTime": "2024-09-31T04:06:59.946000+00:00" + } + ] + } \ No newline at end of file diff --git a/awscli/examples/notifications/list-tags-for-resource.rst b/awscli/examples/notifications/list-tags-for-resource.rst new file mode 100644 index 000000000000..1fbc12fb2f3e --- /dev/null +++ b/awscli/examples/notifications/list-tags-for-resource.rst @@ -0,0 +1,17 @@ +**To list the tags** + +The following ``list-tags-for-resource`` example lists all the tags associated to the given resource ARN. :: + + aws notifications list-tags-for-resource \ + --arn arn:aws:notifications::123456789012:configuration/a01jjzhee9p37n8gc2ke1mr5zjx + +Output:: + + { + "tags": { + "costcenter": "usernotifications", + "usage": "CLI-Demo" + } + } + +For more information, see `Tagging your AWS User Notifications resources `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/register-notification-hub.rst b/awscli/examples/notifications/register-notification-hub.rst new file mode 100644 index 000000000000..d6a6606823b0 --- /dev/null +++ b/awscli/examples/notifications/register-notification-hub.rst @@ -0,0 +1,18 @@ +**To registers a notificationconfiguration** + +The following ``register-notification-hub`` example registers a Notification hub. :: + + aws notifications register-notification-hub --notification-hub-region us-west-2 + +Output:: + + { + "notificationHubRegion": "us-west-2", + "statusSummary": { + "status": "REGISTERING", + "reason": "" + }, + "creationTime": "2024-11-01T03:02:58.561000+00:00" + } + +For more information, see `Adding or removing a notification hub in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/tag-resource.rst b/awscli/examples/notifications/tag-resource.rst new file mode 100644 index 000000000000..23653e946cb9 --- /dev/null +++ b/awscli/examples/notifications/tag-resource.rst @@ -0,0 +1,11 @@ +**To add a tag to the specified resource** + +The following ``tag-resource`` example add a tag(Key Value pair) to the notifications resource in the specified account. :: + + aws notifications tag-resource \ + --arn arn:aws:notifications::123456789012:configuration/a01jjzhee9p37n8gc2ke1mr5zjx \ + --tags usage=CLI-Demo,costcenter=usernotifications + +This command produces no output. + +For more information, see `Tagging your AWS User Notifications resources `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/untag-resource.rst b/awscli/examples/notifications/untag-resource.rst new file mode 100644 index 000000000000..f3a271f07be8 --- /dev/null +++ b/awscli/examples/notifications/untag-resource.rst @@ -0,0 +1,11 @@ +**To remove a tag from the specified resource** + +The following ``untag-resource`` example removes a tag(Key Value pair) to the notifications resource in the specified account. :: + + aws notifications untag-resource \ + --arn arn:aws:notifications::123456789012:configuration/a01jjzhee9p37n8gc2ke1mr5zjx \ + --tag-keys usage=CLI-Demo + +This command produces no output. + +For more information, see `Tagging your AWS User Notifications resources `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/update-event-rule.rst b/awscli/examples/notifications/update-event-rule.rst new file mode 100644 index 000000000000..d193be159152 --- /dev/null +++ b/awscli/examples/notifications/update-event-rule.rst @@ -0,0 +1,22 @@ +**To update an existing eventrule** + +The following ``update-event-rule`` example updates an existing event rule that is associated with a specified NotificationConfiguration. :: + + aws notifications update-event-rule \ + --arn "arn:aws:notifications::123456789012:configuration/a01jjzj251d2wxsss2wvtvxethb/rule/a01jjzkdcbfq2chvmramvnv28nm" \ + --event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"]}" + +Output:: + + { + "arn": "arn:aws:notifications::123456789012:configuration/a01jjzj251d2wxsss2wvtvxethb/rule/a01jjzkdcbfq2chvmramvnv28nm", + "notificationConfigurationArn": "arn:aws:notifications::123456789012:configuration/a01jjzj251d2wxsss2wvtvxethb", + "statusSummaryByRegion": { + "us-east-1": { + "status": "CREATING", + "reason": "" + } + } + } + +For more information, see `Editing notification configurations in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notifications/update-notification-configuration.rst b/awscli/examples/notifications/update-notification-configuration.rst new file mode 100644 index 000000000000..96597cbc57d5 --- /dev/null +++ b/awscli/examples/notifications/update-notification-configuration.rst @@ -0,0 +1,17 @@ +**To update an existing notificationconfiguration** + +The following ``update-notification-configuration`` example updates an existing NotificationConfiguration. :: + + aws notifications update-notification-configuration \ + --arn arn:aws:notifications::123456789012:configuration/a01jjzj251d2wxsss2wvtvxethb \ + --name cli-demo-notification \ + --description CLI-Demo-Notification \ + --aggregation-duration LONG + +Output:: + + { + "arn": "arn:aws:notifications::123456789012:configuration/a01jjzj251d2wxsss2wvtvxethb" + } + +For more information, see `Editing notification configurations in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notificationscontacts/activate-email-contact.rst b/awscli/examples/notificationscontacts/activate-email-contact.rst new file mode 100644 index 000000000000..5586ae80e9ba --- /dev/null +++ b/awscli/examples/notificationscontacts/activate-email-contact.rst @@ -0,0 +1,9 @@ +**To activate an email contact** + +The following ``activate-email-contact`` example activates an email contact using an activation code ``welf20z``. Activation code is made of alpha-numeric with 7 characters long and can be found in the email activation link as a token value:: + + aws notificationscontacts activate-email-contact \ + --arn arn:aws:notifications-contacts::123456789012:emailcontact/a01jjz84gswr5vvvc0ep0s8r7qr \ + --code welf20z + +This command produces no output. \ No newline at end of file diff --git a/awscli/examples/notificationscontacts/create-email-contact.rst b/awscli/examples/notificationscontacts/create-email-contact.rst new file mode 100644 index 000000000000..57a43c2a652e --- /dev/null +++ b/awscli/examples/notificationscontacts/create-email-contact.rst @@ -0,0 +1,15 @@ +**To create an email contact** + +The following ``create-email-contact`` example creates an email contact for the provided email address. :: + + aws notificationscontacts create-email-contact \ + --name testuser \ + --email-address testuser@amazon.com + +Output:: + + { + "arn": "arn:aws:notifications-contacts::123456789012:emailcontact/a01jjz84gswr5vvvc0ep0s8r7qr" + } + +For more information, see `Adding delivery channels in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notificationscontacts/delete-email-contact.rst b/awscli/examples/notificationscontacts/delete-email-contact.rst new file mode 100644 index 000000000000..9d0b17c4dfad --- /dev/null +++ b/awscli/examples/notificationscontacts/delete-email-contact.rst @@ -0,0 +1,10 @@ +**To delete an email contact** + +The following ``delete-email-contact`` example delete the specified notification email contact. :: + + aws notificationscontacts delete-email-contact \ + --arn arn:aws:notifications-contacts::123456789012:emailcontact/a01jjz84gswr5vvvc0ep0s8r7qr + +This command produces no output. + +For more information, see `Deleting email addresses for user-configured notifications in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notificationscontacts/get-email-contact.rst b/awscli/examples/notificationscontacts/get-email-contact.rst new file mode 100644 index 000000000000..b40a33e04b51 --- /dev/null +++ b/awscli/examples/notificationscontacts/get-email-contact.rst @@ -0,0 +1,21 @@ +**To display details of an email contact** + +The following ``get-email-contact`` example displays the details about the given notification email contact. :: + + aws notificationscontacts get-email-contact + --arn arn:aws:notifications-contacts::123456789012:emailcontact/a01jjz84gswr5vvvc0ep0s8r7qr + +Output:: + + { + "emailContact": { + "arn": "arn:aws:notifications-contacts::123456789012:emailcontact/a01jjz84gswr5vvvc0ep0s8r7qr", + "name": "testuser", + "address": "testuser@amazon.com", + "status": "active", + "creationTime": "2024-10-01T01:14:02.506000+00:00", + "updateTime": "2024-10-01T01:14:02.506000+00:00" + } + } + +For more information, see `Viewing delivery channel details in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notificationscontacts/list-email-contacts.rst b/awscli/examples/notificationscontacts/list-email-contacts.rst new file mode 100644 index 000000000000..c3bfa0dc058f --- /dev/null +++ b/awscli/examples/notificationscontacts/list-email-contacts.rst @@ -0,0 +1,30 @@ +**To display the list of all email contact** + +The following ``list-email-contacts`` example displays the list of all notification email contacts created in an account. :: + + aws notificationscontacts list-email-contacts + +Output:: + + { + "emailContacts": [ + { + "arn": "arn:aws:notifications-contacts::123456789012:emailcontact/a01jjz50jvqx2xndxhnyd8cptg1", + "name": "testuser01", + "address": "testuser01+1@amazon.com", + "status": "inactive", + "creationTime": "2024-09-30T21:42:00.823000+00:00", + "updateTime": "2024-09-30T21:42:00.823000+00:00" + }, + { + "arn": "arn:aws:notifications-contacts::123456789012:emailcontact/a01jjz84gswr5vvvc0ep0s8r7qr", + "name": "testuser", + "address": "testuser@amazon.com", + "status": "active", + "creationTime": "2024-10-01T01:14:02.506000+00:00", + "updateTime": "2024-10-01T01:14:02.506000+00:00" + } + ] + } + +For more information, see `Viewing delivery channel details in AWS User Notifications `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notificationscontacts/list-tags-for-resource.rst b/awscli/examples/notificationscontacts/list-tags-for-resource.rst new file mode 100644 index 000000000000..8935cf7337c3 --- /dev/null +++ b/awscli/examples/notificationscontacts/list-tags-for-resource.rst @@ -0,0 +1,17 @@ +**To list the tags** + +The following ``list-tags-for-resource`` example lists all the tags associated to the given resource ARN. :: + + aws notificationscontacts list-tags-for-resource \ + --arn arn:aws:notifications::123456789012:configuration/a01jjzhee9p37n8gc2ke1mr5zjx + +Output:: + + { + "tags": { + "name": "clidemo", + "costcenter": "usernotifications" + } + } + +For more information, see `Tagging your AWS User Notifications resources `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notificationscontacts/send-activation-code.rst b/awscli/examples/notificationscontacts/send-activation-code.rst new file mode 100644 index 000000000000..6f04e7a85076 --- /dev/null +++ b/awscli/examples/notificationscontacts/send-activation-code.rst @@ -0,0 +1,8 @@ +**To create an email contact** + +The following ``send-activation-code`` example sends an activation email to the email address associated with the specified notification email contact. :: + + aws notificationscontacts send-activation-code \ + --arn arn:aws:notifications-contacts::123456789012:emailcontact/a01jjz84gswr5vvvc0ep0s8r7qr + +This command produces no output. \ No newline at end of file diff --git a/awscli/examples/notificationscontacts/tag-resource.rst b/awscli/examples/notificationscontacts/tag-resource.rst new file mode 100644 index 000000000000..ebbc04111314 --- /dev/null +++ b/awscli/examples/notificationscontacts/tag-resource.rst @@ -0,0 +1,11 @@ +**To add a tag to the specified resource** + +The following ``tag-resource`` example add a tag(Key Value pair) to the notificationscontacts resource in the specified account. :: + + aws notificationscontacts tag-resource \ + --arn arn:aws:notifications-contacts::123456789012:emailcontact/a01jjz84gswr5vvvc0ep0s8r7qr \ + --tags usage=CLI-Demo,costcenter=usernotifications + +This command produces no output. + +For more information, see `Tagging your AWS User Notifications resources `__ in the *AWS User Notifications User Guide*. \ No newline at end of file diff --git a/awscli/examples/notificationscontacts/untag-resource.rst b/awscli/examples/notificationscontacts/untag-resource.rst new file mode 100644 index 000000000000..5b098daf1ee1 --- /dev/null +++ b/awscli/examples/notificationscontacts/untag-resource.rst @@ -0,0 +1,11 @@ +**To remove a tag from the specified resource** + +The following ``untag-resource`` example removes a tag(Key Value pair) to the notificationscontacts resource in the specified account. :: + + aws notificationscontacts untag-resource \ + --arn arn:aws:notifications-contacts::123456789012:emailcontact/a01jjz84gswr5vvvc0ep0s8r7qr \ + --tag-keys usage=CLI-Demo + +This command produces no output. + +For more information, see `Tagging your AWS User Notifications resources `__ in the *AWS User Notifications User Guide*. \ No newline at end of file