Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replaced /my-s3-bucket/ with amzn-s3-demo-bucket #9222

Merged
merged 1 commit into from
Jan 23, 2025
Merged

Replaced /my-s3-bucket/ with amzn-s3-demo-bucket #9222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions awscli/examples/codebuild/create-report-group.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -31,7 +31,7 @@ Output::
"exportConfig": {
"exportConfigType": "S3",
"s3Destination": {
"bucket": "my-s3-bucket",
"bucket": "amzn-s3-demo-bucket",
"path": "",
"packaging": "ZIP",
"encryptionDisabled": true
Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/datapipeline/get-pipeline-definition.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/ec2/describe-spot-datafeed-subscription.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Output::
"SpotDatafeedSubscription": {
"OwnerId": "123456789012",
"Prefix": "spotdata",
"Bucket": "my-s3-bucket",
"Bucket": "amzn-s3-demo-bucket",
"State": "Active"
}
}
Expand Down
64 changes: 32 additions & 32 deletions awscli/examples/ec2/register-image.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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) <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html>`__ 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) <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html>`__ 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) <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html>`__ 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) <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html>`__ in the *Amazon EC2 User Guide*.
46 changes: 23 additions & 23 deletions awscli/examples/kendra/create-data-source.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html>`__ in the *Amazon Kendra Developer Guide*.
166 changes: 83 additions & 83 deletions awscli/examples/kendra/describe-data-source.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html>`__ in the *Amazon Kendra Developer Guide*.
36 changes: 18 additions & 18 deletions awscli/examples/kendra/update-data-source.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html>`__ in the *Amazon Kendra Developer Guide*.
Loading
Loading