From 185d462e59be65f5a8fde27cb65f043a63855fd6 Mon Sep 17 00:00:00 2001 From: David Souther Date: Thu, 16 Jan 2025 12:53:59 -0500 Subject: [PATCH] Replaced /my-s3-bucket/ with amzn-s3-demo-bucket --- .../codebuild/create-report-group.rst | 4 +- .../datapipeline/get-pipeline-definition.rst | 2 +- .../describe-spot-datafeed-subscription.rst | 2 +- awscli/examples/ec2/register-image.rst | 64 +++---- awscli/examples/kendra/create-data-source.rst | 46 ++--- .../examples/kendra/describe-data-source.rst | 166 +++++++++--------- awscli/examples/kendra/update-data-source.rst | 36 ++-- .../polly/get-speech-synthesis-task.rst | 46 ++--- .../polly/list-speech-synthesis-tasks.rst | 50 +++--- .../polly/start-speech-synthesis-task.rst | 54 +++--- 10 files changed, 235 insertions(+), 235 deletions(-) diff --git a/awscli/examples/codebuild/create-report-group.rst b/awscli/examples/codebuild/create-report-group.rst index ba9815c0fa1d..f94266b403a9 100644 --- a/awscli/examples/codebuild/create-report-group.rst +++ b/awscli/examples/codebuild/create-report-group.rst @@ -13,7 +13,7 @@ Contents of create-report-group-source.json:: "exportConfig": { "exportConfigType": "S3", "s3Destination": { - "bucket": "my-s3-bucket", + "bucket": "amzn-s3-demo-bucket", "path": "", "packaging": "ZIP", "encryptionDisabled": true @@ -31,7 +31,7 @@ Output:: "exportConfig": { "exportConfigType": "S3", "s3Destination": { - "bucket": "my-s3-bucket", + "bucket": "amzn-s3-demo-bucket", "path": "", "packaging": "ZIP", "encryptionDisabled": true diff --git a/awscli/examples/datapipeline/get-pipeline-definition.rst b/awscli/examples/datapipeline/get-pipeline-definition.rst index 0e62f1c4d235..c37795856766 100644 --- a/awscli/examples/datapipeline/get-pipeline-definition.rst +++ b/awscli/examples/datapipeline/get-pipeline-definition.rst @@ -83,7 +83,7 @@ The following is example output:: } ], "values": { - "myS3OutputLoc": "s3://my-s3-bucket/", + "myS3OutputLoc": "s3://amzn-s3-demo-bucket/", "myS3InputLoc": "s3://us-east-1.elasticmapreduce.samples/pig-apache-logs/data", "myShellCmd": "grep -rc \"GET\" ${INPUT1_STAGING_DIR}/* > ${OUTPUT1_STAGING_DIR}/output.txt" } diff --git a/awscli/examples/ec2/describe-spot-datafeed-subscription.rst b/awscli/examples/ec2/describe-spot-datafeed-subscription.rst index b532ff50a93f..24f68d689540 100644 --- a/awscli/examples/ec2/describe-spot-datafeed-subscription.rst +++ b/awscli/examples/ec2/describe-spot-datafeed-subscription.rst @@ -12,7 +12,7 @@ Output:: "SpotDatafeedSubscription": { "OwnerId": "123456789012", "Prefix": "spotdata", - "Bucket": "my-s3-bucket", + "Bucket": "amzn-s3-demo-bucket", "State": "Active" } } diff --git a/awscli/examples/ec2/register-image.rst b/awscli/examples/ec2/register-image.rst index 71e3743e7bfa..5b794d6d7d70 100644 --- a/awscli/examples/ec2/register-image.rst +++ b/awscli/examples/ec2/register-image.rst @@ -1,32 +1,32 @@ -**Example 1: To register an AMI using a manifest file** - -The following ``register-image`` example registers an AMI using the specified manifest file in Amazon S3. :: - - aws ec2 register-image \ - --name my-image \ - --image-location my-s3-bucket/myimage/image.manifest.xml - -Output:: - - { - "ImageId": "ami-1234567890EXAMPLE" - } - -For more information, see `Amazon Machine Images (AMI) `__ in the *Amazon EC2 User Guide*. - -**Example 2: To register an AMI using a snapshot of a root device** - -The following ``register-image`` example registers an AMI using the specified snapshot of an EBS root volume as device ``/dev/xvda``. The block device mapping also includes an empty 100 GiB EBS volume as device ``/dev/xvdf``. :: - - aws ec2 register-image \ - --name my-image \ - --root-device-name /dev/xvda \ - --block-device-mappings DeviceName=/dev/xvda,Ebs={SnapshotId=snap-0db2cf683925d191f} DeviceName=/dev/xvdf,Ebs={VolumeSize=100} - -Output:: - - { - "ImageId": "ami-1a2b3c4d5eEXAMPLE" - } - -For more information, see `Amazon Machine Images (AMI) `__ in the *Amazon EC2 User Guide*. +**Example 1: To register an AMI using a manifest file** + +The following ``register-image`` example registers an AMI using the specified manifest file in Amazon S3. :: + + aws ec2 register-image \ + --name my-image \ + --image-location amzn-s3-demo-bucket/myimage/image.manifest.xml + +Output:: + + { + "ImageId": "ami-1234567890EXAMPLE" + } + +For more information, see `Amazon Machine Images (AMI) `__ in the *Amazon EC2 User Guide*. + +**Example 2: To register an AMI using a snapshot of a root device** + +The following ``register-image`` example registers an AMI using the specified snapshot of an EBS root volume as device ``/dev/xvda``. The block device mapping also includes an empty 100 GiB EBS volume as device ``/dev/xvdf``. :: + + aws ec2 register-image \ + --name my-image \ + --root-device-name /dev/xvda \ + --block-device-mappings DeviceName=/dev/xvda,Ebs={SnapshotId=snap-0db2cf683925d191f} DeviceName=/dev/xvdf,Ebs={VolumeSize=100} + +Output:: + + { + "ImageId": "ami-1a2b3c4d5eEXAMPLE" + } + +For more information, see `Amazon Machine Images (AMI) `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/kendra/create-data-source.rst b/awscli/examples/kendra/create-data-source.rst index b551f145066c..e1020f24d0a7 100644 --- a/awscli/examples/kendra/create-data-source.rst +++ b/awscli/examples/kendra/create-data-source.rst @@ -1,24 +1,24 @@ -**To create an Amazon Kendra data source connector** - -The following ``create-data-source`` creates and configures an Amazon Kendra data source connector. You can use ``describe-data-source`` to view the status of a data source connector, and read any error messages if the status shows a data source connector "FAILED" to completely create. :: - - aws kendra create-data-source \ - --name "example data source 1" \ - --description "Example data source 1 for example index 1 contains the first set of example documents" \ - --tags '{"Key": "test resources", "Value": "kendra"}, {"Key": "test resources", "Value": "aws"}' \ - --role-arn "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource" \ - --index-id exampleindex1 \ - --language-code "es" \ - --schedule "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *" \ - --configuration '{"TemplateConfiguration": {"Template": file://s3schemaconfig.json}}' \ - --type "TEMPLATE" \ - --custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://my-s3-bucket/scanned-image-text-example-docs"}, "RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE"}' \ - --vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}' - -Output:: - - { - "Id": "exampledatasource1" - } - +**To create an Amazon Kendra data source connector** + +The following ``create-data-source`` creates and configures an Amazon Kendra data source connector. You can use ``describe-data-source`` to view the status of a data source connector, and read any error messages if the status shows a data source connector "FAILED" to completely create. :: + + aws kendra create-data-source \ + --name "example data source 1" \ + --description "Example data source 1 for example index 1 contains the first set of example documents" \ + --tags '{"Key": "test resources", "Value": "kendra"}, {"Key": "test resources", "Value": "aws"}' \ + --role-arn "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource" \ + --index-id exampleindex1 \ + --language-code "es" \ + --schedule "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *" \ + --configuration '{"TemplateConfiguration": {"Template": file://s3schemaconfig.json}}' \ + --type "TEMPLATE" \ + --custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs"}, "RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE"}' \ + --vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}' + +Output:: + + { + "Id": "exampledatasource1" + } + For more information, see `Getting started with an Amazon Kendra index and data source connector `__ in the *Amazon Kendra Developer Guide*. \ No newline at end of file diff --git a/awscli/examples/kendra/describe-data-source.rst b/awscli/examples/kendra/describe-data-source.rst index a950e80ca680..196b5430a509 100644 --- a/awscli/examples/kendra/describe-data-source.rst +++ b/awscli/examples/kendra/describe-data-source.rst @@ -1,84 +1,84 @@ -**To get information about an Amazon Kendra data source connector** - -The following ``describe-data-source`` gets information about an Amazon Kendra data soource connector. You can view the configuration of a data source connector, and read any error messages if the status shows a data source connector "FAILED" to completely create. :: - - aws kendra describe-data-source \ - --id exampledatasource1 \ - --index-id exampleindex1 - -Output:: - - { - "Configuration": { - "TemplateConfiguration": { - "Template": { - "connectionConfiguration": { - "repositoryEndpointMetadata": { - "BucketName": "my-bucket" - } - }, - "repositoryConfigurations": { - "document":{ - "fieldMappings": [ - { - "indexFieldName":"_document_title", - "indexFieldType":"STRING", - "dataSourceFieldName": "title" - }, - { - "indexFieldName":"_last_updated_at", - "indexFieldType":"DATE", - "dataSourceFieldName": "modified_date" - } - ] - } - }, - "additionalProperties": { - "inclusionPatterns": [ - "*.txt", - "*.doc", - "*.docx" - ], - "exclusionPatterns": [ - "*.json" - ], - "inclusionPrefixes": [ - "PublicExampleDocsFolder" - ], - "exclusionPrefixes": [ - "PrivateDocsFolder/private" - ], - "aclConfigurationFilePath": "ExampleDocsFolder/AclConfig.json", - "metadataFilesPrefix": "metadata" - }, - "syncMode": "FULL_CRAWL", - "type" : "S3", - "version": "1.0.0" - } - } - }, - "CreatedAt": 2024-02-25T13:30:10+00:00, - "CustomDocumentEnrichmentConfiguration": { - "PostExtractionHookConfiguration": { - "LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", - "S3Bucket": "s3://my-s3-bucket/scanned-image-text-example-docs/function" - }, - "RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE" - } - "Description": "Example data source 1 for example index 1 contains the first set of example documents", - "Id": exampledatasource1, - "IndexId": exampleindex1, - "LanguageCode": "en", - "Name": "example data source 1", - "RoleArn": "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource", - "Schedule": "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *", - "Status": "ACTIVE", - "Type": "TEMPLATE", - "UpdatedAt": 1709163615, - "VpcConfiguration": { - "SecurityGroupIds": ["sg-1234567890abcdef0"], - "SubnetIds": ["subnet-1c234","subnet-2b134"] - } - } - +**To get information about an Amazon Kendra data source connector** + +The following ``describe-data-source`` gets information about an Amazon Kendra data soource connector. You can view the configuration of a data source connector, and read any error messages if the status shows a data source connector "FAILED" to completely create. :: + + aws kendra describe-data-source \ + --id exampledatasource1 \ + --index-id exampleindex1 + +Output:: + + { + "Configuration": { + "TemplateConfiguration": { + "Template": { + "connectionConfiguration": { + "repositoryEndpointMetadata": { + "BucketName": "my-bucket" + } + }, + "repositoryConfigurations": { + "document":{ + "fieldMappings": [ + { + "indexFieldName":"_document_title", + "indexFieldType":"STRING", + "dataSourceFieldName": "title" + }, + { + "indexFieldName":"_last_updated_at", + "indexFieldType":"DATE", + "dataSourceFieldName": "modified_date" + } + ] + } + }, + "additionalProperties": { + "inclusionPatterns": [ + "*.txt", + "*.doc", + "*.docx" + ], + "exclusionPatterns": [ + "*.json" + ], + "inclusionPrefixes": [ + "PublicExampleDocsFolder" + ], + "exclusionPrefixes": [ + "PrivateDocsFolder/private" + ], + "aclConfigurationFilePath": "ExampleDocsFolder/AclConfig.json", + "metadataFilesPrefix": "metadata" + }, + "syncMode": "FULL_CRAWL", + "type" : "S3", + "version": "1.0.0" + } + } + }, + "CreatedAt": 2024-02-25T13:30:10+00:00, + "CustomDocumentEnrichmentConfiguration": { + "PostExtractionHookConfiguration": { + "LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", + "S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs/function" + }, + "RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE" + } + "Description": "Example data source 1 for example index 1 contains the first set of example documents", + "Id": exampledatasource1, + "IndexId": exampleindex1, + "LanguageCode": "en", + "Name": "example data source 1", + "RoleArn": "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource", + "Schedule": "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *", + "Status": "ACTIVE", + "Type": "TEMPLATE", + "UpdatedAt": 1709163615, + "VpcConfiguration": { + "SecurityGroupIds": ["sg-1234567890abcdef0"], + "SubnetIds": ["subnet-1c234","subnet-2b134"] + } + } + For more information, see `Getting started with an Amazon Kendra index and data source connector `__ in the *Amazon Kendra Developer Guide*. \ No newline at end of file diff --git a/awscli/examples/kendra/update-data-source.rst b/awscli/examples/kendra/update-data-source.rst index ebdbeb56c328..68146e9d05a9 100644 --- a/awscli/examples/kendra/update-data-source.rst +++ b/awscli/examples/kendra/update-data-source.rst @@ -1,19 +1,19 @@ -**To update an Amazon Kendra data source connector** - -The following ``update-data-source`` updates the configuration of an Amazon Kendra data source connector. If the action is successful, the service either sends back no output, the HTTP status code 200, or the AWS CLI return code 0. You can use ``describe-data-source`` to view the configuration and status of a data source connector. :: - - aws kendra update-data-source \ - --id exampledatasource1 \ - --index-id exampleindex1 \ - --name "new name for example data source 1" \ - --description "new description for example data source 1" \ - --role-arn arn:aws:iam::my-account-id:role/KendraNewRoleForExampleDataSource \ - --configuration '{"TemplateConfiguration": {"Template": file://s3schemanewconfig.json}}' \ - --custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://my-s3-bucket/scanned-image-text-example-docs"}, "RoleArn": "arn:aws:iam:my-account-id:role/KendraNewRoleForCDE"}' \ - --language-code "es" \ - --schedule "0 0 18 ? * MON,WED,FRI *" \ - --vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}' - -This command produces no output. - +**To update an Amazon Kendra data source connector** + +The following ``update-data-source`` updates the configuration of an Amazon Kendra data source connector. If the action is successful, the service either sends back no output, the HTTP status code 200, or the AWS CLI return code 0. You can use ``describe-data-source`` to view the configuration and status of a data source connector. :: + + aws kendra update-data-source \ + --id exampledatasource1 \ + --index-id exampleindex1 \ + --name "new name for example data source 1" \ + --description "new description for example data source 1" \ + --role-arn arn:aws:iam::my-account-id:role/KendraNewRoleForExampleDataSource \ + --configuration '{"TemplateConfiguration": {"Template": file://s3schemanewconfig.json}}' \ + --custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs"}, "RoleArn": "arn:aws:iam:my-account-id:role/KendraNewRoleForCDE"}' \ + --language-code "es" \ + --schedule "0 0 18 ? * MON,WED,FRI *" \ + --vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}' + +This command produces no output. + For more information, see `Getting started with an Amazon Kendra index and data source connector `__ in the *Amazon Kendra Developer Guide*. \ No newline at end of file diff --git a/awscli/examples/polly/get-speech-synthesis-task.rst b/awscli/examples/polly/get-speech-synthesis-task.rst index 3d25165e19b2..64b726d9c0c0 100644 --- a/awscli/examples/polly/get-speech-synthesis-task.rst +++ b/awscli/examples/polly/get-speech-synthesis-task.rst @@ -1,23 +1,23 @@ -**To get information about a speech synthesis task** - -The following ``get-speech-synthesis-task`` example retrieves information about the specified speech synthesis task. :: - - aws polly get-speech-synthesis-task \ - --task-id 70b61c0f-57ce-4715-a247-cae8729dcce9 - -Output:: - - { - "SynthesisTask": { - "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9", - "TaskStatus": "completed", - "OutputUri": "https://s3.us-west-2.amazonaws.com/my-s3-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3", - "CreationTime": 1603911042.689, - "RequestCharacters": 1311, - "OutputFormat": "mp3", - "TextType": "text", - "VoiceId": "Joanna" - } - } - -For more information, see `Creating long audio files `__ in the *Amazon Polly Developer Guide*. +**To get information about a speech synthesis task** + +The following ``get-speech-synthesis-task`` example retrieves information about the specified speech synthesis task. :: + + aws polly get-speech-synthesis-task \ + --task-id 70b61c0f-57ce-4715-a247-cae8729dcce9 + +Output:: + + { + "SynthesisTask": { + "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9", + "TaskStatus": "completed", + "OutputUri": "https://s3.us-west-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3", + "CreationTime": 1603911042.689, + "RequestCharacters": 1311, + "OutputFormat": "mp3", + "TextType": "text", + "VoiceId": "Joanna" + } + } + +For more information, see `Creating long audio files `__ in the *Amazon Polly Developer Guide*. diff --git a/awscli/examples/polly/list-speech-synthesis-tasks.rst b/awscli/examples/polly/list-speech-synthesis-tasks.rst index 99ba9891aa3c..5ddbdccb0cd0 100644 --- a/awscli/examples/polly/list-speech-synthesis-tasks.rst +++ b/awscli/examples/polly/list-speech-synthesis-tasks.rst @@ -1,25 +1,25 @@ -**To list your speech synthesis tasks** - -The following ``list-speech-synthesis-tasks`` example lists your speech synthesis tasks. :: - - aws polly list-speech-synthesis-tasks - -Output:: - - { - "SynthesisTasks": [ - { - "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9", - "TaskStatus": "completed", - "OutputUri": "https://s3.us-west-2.amazonaws.com/my-s3-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3", - "CreationTime": 1603911042.689, - "RequestCharacters": 1311, - "OutputFormat": "mp3", - "TextType": "text", - "VoiceId": "Joanna" - } - ] - } - -For more information, see `Creating long audio files `__ in the *Amazon Polly Developer Guide*. - +**To list your speech synthesis tasks** + +The following ``list-speech-synthesis-tasks`` example lists your speech synthesis tasks. :: + + aws polly list-speech-synthesis-tasks + +Output:: + + { + "SynthesisTasks": [ + { + "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9", + "TaskStatus": "completed", + "OutputUri": "https://s3.us-west-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3", + "CreationTime": 1603911042.689, + "RequestCharacters": 1311, + "OutputFormat": "mp3", + "TextType": "text", + "VoiceId": "Joanna" + } + ] + } + +For more information, see `Creating long audio files `__ in the *Amazon Polly Developer Guide*. + diff --git a/awscli/examples/polly/start-speech-synthesis-task.rst b/awscli/examples/polly/start-speech-synthesis-task.rst index aa85d49d52d3..740fcde3f1a6 100644 --- a/awscli/examples/polly/start-speech-synthesis-task.rst +++ b/awscli/examples/polly/start-speech-synthesis-task.rst @@ -1,27 +1,27 @@ -**To synthesize text** - -The following ``start-speech-synthesis-task`` example synthesizes the text in ``text_file.txt`` and stores the resulting MP3 file in the specified bucket. :: - - aws polly start-speech-synthesis-task \ - --output-format mp3 \ - --output-s3-bucket-name my-s3-bucket \ - --text file://text_file.txt \ - --voice-id Joanna - -Output:: - - { - "SynthesisTask": { - "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9", - "TaskStatus": "scheduled", - "OutputUri": "https://s3.us-east-2.amazonaws.com/my-s3-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3", - "CreationTime": 1603911042.689, - "RequestCharacters": 1311, - "OutputFormat": "mp3", - "TextType": "text", - "VoiceId": "Joanna" - } - } - -For more information, see `Creating long audio files `__ in the *Amazon Polly Developer Guide*. - +**To synthesize text** + +The following ``start-speech-synthesis-task`` example synthesizes the text in ``text_file.txt`` and stores the resulting MP3 file in the specified bucket. :: + + aws polly start-speech-synthesis-task \ + --output-format mp3 \ + --output-s3-bucket-name amzn-s3-demo-bucket \ + --text file://text_file.txt \ + --voice-id Joanna + +Output:: + + { + "SynthesisTask": { + "TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9", + "TaskStatus": "scheduled", + "OutputUri": "https://s3.us-east-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3", + "CreationTime": 1603911042.689, + "RequestCharacters": 1311, + "OutputFormat": "mp3", + "TextType": "text", + "VoiceId": "Joanna" + } + } + +For more information, see `Creating long audio files `__ in the *Amazon Polly Developer Guide*. +