awscli 1.37.4__py3-none-any.whl → 1.37.6__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of awscli might be problematic. Click here for more details.
- awscli/__init__.py +1 -1
- awscli/examples/cloudtrail/create-subscription.rst +29 -26
- awscli/examples/cloudtrail/create-trail.rst +13 -11
- awscli/examples/cloudtrail/describe-trails.rst +30 -29
- awscli/examples/cloudtrail/put-event-selectors.rst +8 -8
- awscli/examples/cloudtrail/update-subscription.rst +25 -22
- awscli/examples/cloudtrail/update-trail.rst +12 -10
- awscli/examples/codebuild/create-report-group.rst +2 -2
- awscli/examples/datapipeline/get-pipeline-definition.rst +1 -1
- awscli/examples/ds-data/add-group-member.rst +12 -0
- awscli/examples/ds-data/create-group.rst +17 -0
- awscli/examples/ds-data/create-user.rst +17 -0
- awscli/examples/ds-data/delete-group.rst +11 -0
- awscli/examples/ds-data/delete-user.rst +11 -0
- awscli/examples/ds-data/describe-group.rst +21 -0
- awscli/examples/ds-data/describe-user.rst +21 -0
- awscli/examples/ds-data/disable-directory-data-access.rst +10 -0
- awscli/examples/ds-data/disable-user.rst +11 -0
- awscli/examples/ds-data/enable-directory-data-access.rst +10 -0
- awscli/examples/ds-data/list-group-members.rst +29 -0
- awscli/examples/ds-data/list-groups-for-member.rst +25 -0
- awscli/examples/ds-data/list-groups.rst +503 -0
- awscli/examples/ds-data/list-users.rst +57 -0
- awscli/examples/ds-data/remove-group-member.rst +12 -0
- awscli/examples/ds-data/reset-user-password.rst +12 -0
- awscli/examples/ds-data/search-groups.rst +25 -0
- awscli/examples/ds-data/search-users.rst +24 -0
- awscli/examples/ds-data/update-group.rst +13 -0
- awscli/examples/ds-data/update-user.rst +13 -0
- awscli/examples/ec2/describe-capacity-reservations.rst +46 -31
- awscli/examples/ec2/describe-instance-image-metadata.rst +186 -0
- awscli/examples/ec2/describe-spot-datafeed-subscription.rst +1 -1
- awscli/examples/ec2/register-image.rst +32 -32
- awscli/examples/ecr-public/get-registry-catalog-data.rst +14 -0
- awscli/examples/ecr-public/get-repository-catalog-data.rst +29 -0
- awscli/examples/ecr-public/list-tags-for-resource.rst +28 -0
- awscli/examples/ecr-public/put-registry-catalog-data.rst +15 -0
- awscli/examples/ecr-public/put-repository-catalog-data.rst +5 -4
- awscli/examples/ecr-public/tag-resource.rst +21 -0
- awscli/examples/ecr-public/untag-resource.rst +12 -0
- awscli/examples/ecs/describe-service-deployments.rst +54 -0
- awscli/examples/ecs/describe-service-revisions.rst +60 -0
- awscli/examples/ecs/list-service-deployments.rst +25 -0
- awscli/examples/ivs-realtime/create-storage-configuration.rst +20 -20
- awscli/examples/ivs-realtime/get-storage-configuration.rst +20 -20
- awscli/examples/ivs-realtime/list-storage-configurations.rst +29 -29
- awscli/examples/kendra/create-data-source.rst +23 -23
- awscli/examples/kendra/describe-data-source.rst +83 -83
- awscli/examples/kendra/update-data-source.rst +18 -18
- awscli/examples/macie2/describe-buckets.rst +13 -11
- awscli/examples/oam/create-link.rst +24 -0
- awscli/examples/oam/create-sink.rst +17 -0
- awscli/examples/oam/delete-link.rst +10 -0
- awscli/examples/oam/delete-sink.rst +10 -0
- awscli/examples/oam/get-link.rst +22 -0
- awscli/examples/oam/get-sink-policy.rst +16 -0
- awscli/examples/oam/get-sink.rst +17 -0
- awscli/examples/oam/list-attached-links.rst +23 -0
- awscli/examples/oam/list-links.rst +21 -0
- awscli/examples/oam/list-sinks.rst +19 -0
- awscli/examples/oam/list-tags-for-resource.rst +16 -0
- awscli/examples/oam/put-sink-policy.rst +17 -0
- awscli/examples/oam/tag-resource.rst +11 -0
- awscli/examples/oam/untag-resource.rst +11 -0
- awscli/examples/oam/update-link.rst +24 -0
- awscli/examples/polly/get-speech-synthesis-task.rst +23 -23
- awscli/examples/polly/list-speech-synthesis-tasks.rst +25 -25
- awscli/examples/polly/start-speech-synthesis-task.rst +27 -27
- awscli/examples/qldb/describe-journal-s3-export.rst +1 -1
- awscli/examples/qldb/export-journal-to-s3.rst +1 -1
- awscli/examples/qldb/list-journal-s3-exports-for-ledger.rst +1 -1
- awscli/examples/qldb/list-journal-s3-exports.rst +2 -2
- awscli/examples/s3api/put-bucket-acl.rst +1 -1
- awscli/examples/s3api/put-bucket-cors.rst +1 -1
- awscli/examples/s3api/put-bucket-logging.rst +10 -10
- awscli/examples/s3api/put-bucket-policy.rst +5 -5
- awscli/examples/s3api/put-object-acl.rst +1 -1
- awscli/examples/synthetics/associate-resource.rst +11 -0
- awscli/examples/synthetics/create-canary.rst +48 -0
- awscli/examples/synthetics/create-group.rst +21 -0
- awscli/examples/synthetics/delete-canary.rst +10 -0
- awscli/examples/synthetics/delete-group.rst +10 -0
- awscli/examples/synthetics/describe-canaries-last-run.rst +31 -0
- awscli/examples/synthetics/describe-canaries.rst +48 -0
- awscli/examples/synthetics/describe-runtime-versions.rst +74 -0
- awscli/examples/synthetics/disassociate-resource.rst +11 -0
- awscli/examples/synthetics/get-canary-runs.rst +29 -0
- awscli/examples/synthetics/get-canary.rst +47 -0
- awscli/examples/synthetics/get-group.rst +21 -0
- awscli/examples/synthetics/list-associated-groups.rst +20 -0
- awscli/examples/synthetics/list-group-resources.rst +16 -0
- awscli/examples/synthetics/list-groups.rst +19 -0
- awscli/examples/synthetics/list-tags-for-resource.rst +31 -0
- awscli/examples/synthetics/start-canary.rst +10 -0
- awscli/examples/synthetics/stop-canary.rst +10 -0
- awscli/examples/synthetics/tag-resource.rst +21 -0
- awscli/examples/synthetics/untag-resource.rst +21 -0
- awscli/examples/synthetics/update-canary.rst +11 -0
- {awscli-1.37.4.dist-info → awscli-1.37.6.dist-info}/METADATA +2 -2
- {awscli-1.37.4.dist-info → awscli-1.37.6.dist-info}/RECORD +108 -42
- {awscli-1.37.4.data → awscli-1.37.6.data}/scripts/aws +0 -0
- {awscli-1.37.4.data → awscli-1.37.6.data}/scripts/aws.cmd +0 -0
- {awscli-1.37.4.data → awscli-1.37.6.data}/scripts/aws_bash_completer +0 -0
- {awscli-1.37.4.data → awscli-1.37.6.data}/scripts/aws_completer +0 -0
- {awscli-1.37.4.data → awscli-1.37.6.data}/scripts/aws_zsh_completer.sh +0 -0
- {awscli-1.37.4.dist-info → awscli-1.37.6.dist-info}/LICENSE.txt +0 -0
- {awscli-1.37.4.dist-info → awscli-1.37.6.dist-info}/WHEEL +0 -0
- {awscli-1.37.4.dist-info → awscli-1.37.6.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
**To list service deployments**
|
|
2
|
+
|
|
3
|
+
The following ``list-service-deployments`` example retrieves the service deployments for the service named ``example-service``. ::
|
|
4
|
+
|
|
5
|
+
aws ecs list-service-deployments \
|
|
6
|
+
--service arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service
|
|
7
|
+
|
|
8
|
+
Output::
|
|
9
|
+
|
|
10
|
+
{
|
|
11
|
+
"serviceDeployments": [
|
|
12
|
+
{
|
|
13
|
+
"serviceDeploymentArn": "arn:aws:ecs:us-east-1:123456789012:service-deployment/example-cluster/example-service/ejGvqq2ilnbKT9qj0vLJe",
|
|
14
|
+
"serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service",
|
|
15
|
+
"clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/example-cluster",
|
|
16
|
+
"startedAt": "2024-10-31T08:03:32.510000-04:00",
|
|
17
|
+
"createdAt": "2024-10-31T08:03:30.917000-04:00",
|
|
18
|
+
"finishedAt": "2024-10-31T08:05:04.527000-04:00",
|
|
19
|
+
"targetServiceRevisionArn": "arn:aws:ecs:us-east-1:123456789012:service-revision/example-cluster/example-service/1485800978477494678",
|
|
20
|
+
"status": "SUCCESSFUL"
|
|
21
|
+
}
|
|
22
|
+
]
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
For more information, see `View service history using Amazon ECS service deployments <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployment.html>`_ in the *Amazon ECS Developer Guide*.
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
**To create a composition storage configuration**
|
|
2
|
-
|
|
3
|
-
The following ``create-storage-configuration`` example creates a composition storage configuration with the specified properties. ::
|
|
4
|
-
|
|
5
|
-
aws ivs-realtime create-storage-configuration \
|
|
6
|
-
--name "test-sc" --s3 "bucketName=
|
|
7
|
-
|
|
8
|
-
Output::
|
|
9
|
-
|
|
10
|
-
{
|
|
11
|
-
"storageConfiguration": {
|
|
12
|
-
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef",
|
|
13
|
-
"name": "test-sc",
|
|
14
|
-
"s3": {
|
|
15
|
-
"bucketName": "
|
|
16
|
-
},
|
|
17
|
-
"tags": {}
|
|
18
|
-
}
|
|
19
|
-
}
|
|
20
|
-
|
|
1
|
+
**To create a composition storage configuration**
|
|
2
|
+
|
|
3
|
+
The following ``create-storage-configuration`` example creates a composition storage configuration with the specified properties. ::
|
|
4
|
+
|
|
5
|
+
aws ivs-realtime create-storage-configuration \
|
|
6
|
+
--name "test-sc" --s3 "bucketName=amzn-s3-demo-bucket"
|
|
7
|
+
|
|
8
|
+
Output::
|
|
9
|
+
|
|
10
|
+
{
|
|
11
|
+
"storageConfiguration": {
|
|
12
|
+
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef",
|
|
13
|
+
"name": "test-sc",
|
|
14
|
+
"s3": {
|
|
15
|
+
"bucketName": "amzn-s3-demo-bucket"
|
|
16
|
+
},
|
|
17
|
+
"tags": {}
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
|
|
21
21
|
For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon Interactive Video Service User Guide*.
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
**To get a composition storage configuration**
|
|
2
|
-
|
|
3
|
-
The following ``get-storage-configuration`` example gets the composition storage configuration specified by the given ARN (Amazon Resource Name). ::
|
|
4
|
-
|
|
5
|
-
aws ivs-realtime get-storage-configuration \
|
|
6
|
-
--name arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh"
|
|
7
|
-
|
|
8
|
-
Output::
|
|
9
|
-
|
|
10
|
-
{
|
|
11
|
-
"storageConfiguration": {
|
|
12
|
-
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
|
|
13
|
-
"name": "test-sc",
|
|
14
|
-
"s3": {
|
|
15
|
-
"bucketName": "
|
|
16
|
-
},
|
|
17
|
-
"tags": {}
|
|
18
|
-
}
|
|
19
|
-
}
|
|
20
|
-
|
|
1
|
+
**To get a composition storage configuration**
|
|
2
|
+
|
|
3
|
+
The following ``get-storage-configuration`` example gets the composition storage configuration specified by the given ARN (Amazon Resource Name). ::
|
|
4
|
+
|
|
5
|
+
aws ivs-realtime get-storage-configuration \
|
|
6
|
+
--name arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh"
|
|
7
|
+
|
|
8
|
+
Output::
|
|
9
|
+
|
|
10
|
+
{
|
|
11
|
+
"storageConfiguration": {
|
|
12
|
+
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
|
|
13
|
+
"name": "test-sc",
|
|
14
|
+
"s3": {
|
|
15
|
+
"bucketName": "amzn-s3-demo-bucket"
|
|
16
|
+
},
|
|
17
|
+
"tags": {}
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
|
|
21
21
|
For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon Interactive Video Service User Guide*.
|
|
@@ -1,30 +1,30 @@
|
|
|
1
|
-
**To list composition storage configurations**
|
|
2
|
-
|
|
3
|
-
The following ``list-storage-configurations`` lists all composition storage configurations for your AWS account, in the AWS region where the API request is processed. ::
|
|
4
|
-
|
|
5
|
-
aws ivs-realtime list-storage-configurations
|
|
6
|
-
|
|
7
|
-
Output::
|
|
8
|
-
|
|
9
|
-
{
|
|
10
|
-
"storageConfigurations": [
|
|
11
|
-
{
|
|
12
|
-
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
|
|
13
|
-
"name": "test-sc-1",
|
|
14
|
-
"s3": {
|
|
15
|
-
"bucketName": "
|
|
16
|
-
},
|
|
17
|
-
"tags": {}
|
|
18
|
-
},
|
|
19
|
-
{
|
|
20
|
-
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABCefgEFGabc",
|
|
21
|
-
"name": "test-sc-2",
|
|
22
|
-
"s3": {
|
|
23
|
-
"bucketName": "
|
|
24
|
-
},
|
|
25
|
-
"tags": {}
|
|
26
|
-
}
|
|
27
|
-
]
|
|
28
|
-
}
|
|
29
|
-
|
|
1
|
+
**To list composition storage configurations**
|
|
2
|
+
|
|
3
|
+
The following ``list-storage-configurations`` lists all composition storage configurations for your AWS account, in the AWS region where the API request is processed. ::
|
|
4
|
+
|
|
5
|
+
aws ivs-realtime list-storage-configurations
|
|
6
|
+
|
|
7
|
+
Output::
|
|
8
|
+
|
|
9
|
+
{
|
|
10
|
+
"storageConfigurations": [
|
|
11
|
+
{
|
|
12
|
+
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
|
|
13
|
+
"name": "test-sc-1",
|
|
14
|
+
"s3": {
|
|
15
|
+
"bucketName": "amzn-s3-demo-bucket-1"
|
|
16
|
+
},
|
|
17
|
+
"tags": {}
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABCefgEFGabc",
|
|
21
|
+
"name": "test-sc-2",
|
|
22
|
+
"s3": {
|
|
23
|
+
"bucketName": "amzn-s3-demo-bucket-2"
|
|
24
|
+
},
|
|
25
|
+
"tags": {}
|
|
26
|
+
}
|
|
27
|
+
]
|
|
28
|
+
}
|
|
29
|
+
|
|
30
30
|
For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon Interactive Video Service User Guide*.
|
|
@@ -1,24 +1,24 @@
|
|
|
1
|
-
**To create an Amazon Kendra data source connector**
|
|
2
|
-
|
|
3
|
-
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. ::
|
|
4
|
-
|
|
5
|
-
aws kendra create-data-source \
|
|
6
|
-
--name "example data source 1" \
|
|
7
|
-
--description "Example data source 1 for example index 1 contains the first set of example documents" \
|
|
8
|
-
--tags '{"Key": "test resources", "Value": "kendra"}, {"Key": "test resources", "Value": "aws"}' \
|
|
9
|
-
--role-arn "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource" \
|
|
10
|
-
--index-id exampleindex1 \
|
|
11
|
-
--language-code "es" \
|
|
12
|
-
--schedule "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *" \
|
|
13
|
-
--configuration '{"TemplateConfiguration": {"Template": file://s3schemaconfig.json}}' \
|
|
14
|
-
--type "TEMPLATE" \
|
|
15
|
-
--custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://
|
|
16
|
-
--vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}'
|
|
17
|
-
|
|
18
|
-
Output::
|
|
19
|
-
|
|
20
|
-
{
|
|
21
|
-
"Id": "exampledatasource1"
|
|
22
|
-
}
|
|
23
|
-
|
|
1
|
+
**To create an Amazon Kendra data source connector**
|
|
2
|
+
|
|
3
|
+
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. ::
|
|
4
|
+
|
|
5
|
+
aws kendra create-data-source \
|
|
6
|
+
--name "example data source 1" \
|
|
7
|
+
--description "Example data source 1 for example index 1 contains the first set of example documents" \
|
|
8
|
+
--tags '{"Key": "test resources", "Value": "kendra"}, {"Key": "test resources", "Value": "aws"}' \
|
|
9
|
+
--role-arn "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource" \
|
|
10
|
+
--index-id exampleindex1 \
|
|
11
|
+
--language-code "es" \
|
|
12
|
+
--schedule "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *" \
|
|
13
|
+
--configuration '{"TemplateConfiguration": {"Template": file://s3schemaconfig.json}}' \
|
|
14
|
+
--type "TEMPLATE" \
|
|
15
|
+
--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"}' \
|
|
16
|
+
--vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}'
|
|
17
|
+
|
|
18
|
+
Output::
|
|
19
|
+
|
|
20
|
+
{
|
|
21
|
+
"Id": "exampledatasource1"
|
|
22
|
+
}
|
|
23
|
+
|
|
24
24
|
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*.
|
|
@@ -1,84 +1,84 @@
|
|
|
1
|
-
**To get information about an Amazon Kendra data source connector**
|
|
2
|
-
|
|
3
|
-
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. ::
|
|
4
|
-
|
|
5
|
-
aws kendra describe-data-source \
|
|
6
|
-
--id exampledatasource1 \
|
|
7
|
-
--index-id exampleindex1
|
|
8
|
-
|
|
9
|
-
Output::
|
|
10
|
-
|
|
11
|
-
{
|
|
12
|
-
"Configuration": {
|
|
13
|
-
"TemplateConfiguration": {
|
|
14
|
-
"Template": {
|
|
15
|
-
"connectionConfiguration": {
|
|
16
|
-
"repositoryEndpointMetadata": {
|
|
17
|
-
"BucketName": "my-bucket"
|
|
18
|
-
}
|
|
19
|
-
},
|
|
20
|
-
"repositoryConfigurations": {
|
|
21
|
-
"document":{
|
|
22
|
-
"fieldMappings": [
|
|
23
|
-
{
|
|
24
|
-
"indexFieldName":"_document_title",
|
|
25
|
-
"indexFieldType":"STRING",
|
|
26
|
-
"dataSourceFieldName": "title"
|
|
27
|
-
},
|
|
28
|
-
{
|
|
29
|
-
"indexFieldName":"_last_updated_at",
|
|
30
|
-
"indexFieldType":"DATE",
|
|
31
|
-
"dataSourceFieldName": "modified_date"
|
|
32
|
-
}
|
|
33
|
-
]
|
|
34
|
-
}
|
|
35
|
-
},
|
|
36
|
-
"additionalProperties": {
|
|
37
|
-
"inclusionPatterns": [
|
|
38
|
-
"*.txt",
|
|
39
|
-
"*.doc",
|
|
40
|
-
"*.docx"
|
|
41
|
-
],
|
|
42
|
-
"exclusionPatterns": [
|
|
43
|
-
"*.json"
|
|
44
|
-
],
|
|
45
|
-
"inclusionPrefixes": [
|
|
46
|
-
"PublicExampleDocsFolder"
|
|
47
|
-
],
|
|
48
|
-
"exclusionPrefixes": [
|
|
49
|
-
"PrivateDocsFolder/private"
|
|
50
|
-
],
|
|
51
|
-
"aclConfigurationFilePath": "ExampleDocsFolder/AclConfig.json",
|
|
52
|
-
"metadataFilesPrefix": "metadata"
|
|
53
|
-
},
|
|
54
|
-
"syncMode": "FULL_CRAWL",
|
|
55
|
-
"type" : "S3",
|
|
56
|
-
"version": "1.0.0"
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
},
|
|
60
|
-
"CreatedAt": 2024-02-25T13:30:10+00:00,
|
|
61
|
-
"CustomDocumentEnrichmentConfiguration": {
|
|
62
|
-
"PostExtractionHookConfiguration": {
|
|
63
|
-
"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs",
|
|
64
|
-
"S3Bucket": "s3://
|
|
65
|
-
},
|
|
66
|
-
"RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE"
|
|
67
|
-
}
|
|
68
|
-
"Description": "Example data source 1 for example index 1 contains the first set of example documents",
|
|
69
|
-
"Id": exampledatasource1,
|
|
70
|
-
"IndexId": exampleindex1,
|
|
71
|
-
"LanguageCode": "en",
|
|
72
|
-
"Name": "example data source 1",
|
|
73
|
-
"RoleArn": "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource",
|
|
74
|
-
"Schedule": "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *",
|
|
75
|
-
"Status": "ACTIVE",
|
|
76
|
-
"Type": "TEMPLATE",
|
|
77
|
-
"UpdatedAt": 1709163615,
|
|
78
|
-
"VpcConfiguration": {
|
|
79
|
-
"SecurityGroupIds": ["sg-1234567890abcdef0"],
|
|
80
|
-
"SubnetIds": ["subnet-1c234","subnet-2b134"]
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
|
|
1
|
+
**To get information about an Amazon Kendra data source connector**
|
|
2
|
+
|
|
3
|
+
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. ::
|
|
4
|
+
|
|
5
|
+
aws kendra describe-data-source \
|
|
6
|
+
--id exampledatasource1 \
|
|
7
|
+
--index-id exampleindex1
|
|
8
|
+
|
|
9
|
+
Output::
|
|
10
|
+
|
|
11
|
+
{
|
|
12
|
+
"Configuration": {
|
|
13
|
+
"TemplateConfiguration": {
|
|
14
|
+
"Template": {
|
|
15
|
+
"connectionConfiguration": {
|
|
16
|
+
"repositoryEndpointMetadata": {
|
|
17
|
+
"BucketName": "my-bucket"
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"repositoryConfigurations": {
|
|
21
|
+
"document":{
|
|
22
|
+
"fieldMappings": [
|
|
23
|
+
{
|
|
24
|
+
"indexFieldName":"_document_title",
|
|
25
|
+
"indexFieldType":"STRING",
|
|
26
|
+
"dataSourceFieldName": "title"
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"indexFieldName":"_last_updated_at",
|
|
30
|
+
"indexFieldType":"DATE",
|
|
31
|
+
"dataSourceFieldName": "modified_date"
|
|
32
|
+
}
|
|
33
|
+
]
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
"additionalProperties": {
|
|
37
|
+
"inclusionPatterns": [
|
|
38
|
+
"*.txt",
|
|
39
|
+
"*.doc",
|
|
40
|
+
"*.docx"
|
|
41
|
+
],
|
|
42
|
+
"exclusionPatterns": [
|
|
43
|
+
"*.json"
|
|
44
|
+
],
|
|
45
|
+
"inclusionPrefixes": [
|
|
46
|
+
"PublicExampleDocsFolder"
|
|
47
|
+
],
|
|
48
|
+
"exclusionPrefixes": [
|
|
49
|
+
"PrivateDocsFolder/private"
|
|
50
|
+
],
|
|
51
|
+
"aclConfigurationFilePath": "ExampleDocsFolder/AclConfig.json",
|
|
52
|
+
"metadataFilesPrefix": "metadata"
|
|
53
|
+
},
|
|
54
|
+
"syncMode": "FULL_CRAWL",
|
|
55
|
+
"type" : "S3",
|
|
56
|
+
"version": "1.0.0"
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
},
|
|
60
|
+
"CreatedAt": 2024-02-25T13:30:10+00:00,
|
|
61
|
+
"CustomDocumentEnrichmentConfiguration": {
|
|
62
|
+
"PostExtractionHookConfiguration": {
|
|
63
|
+
"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs",
|
|
64
|
+
"S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs/function"
|
|
65
|
+
},
|
|
66
|
+
"RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE"
|
|
67
|
+
}
|
|
68
|
+
"Description": "Example data source 1 for example index 1 contains the first set of example documents",
|
|
69
|
+
"Id": exampledatasource1,
|
|
70
|
+
"IndexId": exampleindex1,
|
|
71
|
+
"LanguageCode": "en",
|
|
72
|
+
"Name": "example data source 1",
|
|
73
|
+
"RoleArn": "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource",
|
|
74
|
+
"Schedule": "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *",
|
|
75
|
+
"Status": "ACTIVE",
|
|
76
|
+
"Type": "TEMPLATE",
|
|
77
|
+
"UpdatedAt": 1709163615,
|
|
78
|
+
"VpcConfiguration": {
|
|
79
|
+
"SecurityGroupIds": ["sg-1234567890abcdef0"],
|
|
80
|
+
"SubnetIds": ["subnet-1c234","subnet-2b134"]
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
84
|
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*.
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
**To update an Amazon Kendra data source connector**
|
|
2
|
-
|
|
3
|
-
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. ::
|
|
4
|
-
|
|
5
|
-
aws kendra update-data-source \
|
|
6
|
-
--id exampledatasource1 \
|
|
7
|
-
--index-id exampleindex1 \
|
|
8
|
-
--name "new name for example data source 1" \
|
|
9
|
-
--description "new description for example data source 1" \
|
|
10
|
-
--role-arn arn:aws:iam::my-account-id:role/KendraNewRoleForExampleDataSource \
|
|
11
|
-
--configuration '{"TemplateConfiguration": {"Template": file://s3schemanewconfig.json}}' \
|
|
12
|
-
--custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://
|
|
13
|
-
--language-code "es" \
|
|
14
|
-
--schedule "0 0 18 ? * MON,WED,FRI *" \
|
|
15
|
-
--vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}'
|
|
16
|
-
|
|
17
|
-
This command produces no output.
|
|
18
|
-
|
|
1
|
+
**To update an Amazon Kendra data source connector**
|
|
2
|
+
|
|
3
|
+
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. ::
|
|
4
|
+
|
|
5
|
+
aws kendra update-data-source \
|
|
6
|
+
--id exampledatasource1 \
|
|
7
|
+
--index-id exampleindex1 \
|
|
8
|
+
--name "new name for example data source 1" \
|
|
9
|
+
--description "new description for example data source 1" \
|
|
10
|
+
--role-arn arn:aws:iam::my-account-id:role/KendraNewRoleForExampleDataSource \
|
|
11
|
+
--configuration '{"TemplateConfiguration": {"Template": file://s3schemanewconfig.json}}' \
|
|
12
|
+
--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"}' \
|
|
13
|
+
--language-code "es" \
|
|
14
|
+
--schedule "0 0 18 ? * MON,WED,FRI *" \
|
|
15
|
+
--vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}'
|
|
16
|
+
|
|
17
|
+
This command produces no output.
|
|
18
|
+
|
|
19
19
|
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*.
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
**To query data about one or more S3 buckets that Amazon Macie monitors and analyzes for your account**
|
|
2
2
|
|
|
3
|
-
The following ``describe-buckets`` example queries metadata for all S3 buckets whose names begin with
|
|
3
|
+
The following ``describe-buckets`` example queries metadata for all S3 buckets whose names begin with amzn-s3-demo-bucket and are in the current AWS Region. ::
|
|
4
4
|
|
|
5
5
|
aws macie2 describe-buckets \
|
|
6
|
-
--criteria '{"bucketName":{"prefix":"
|
|
6
|
+
--criteria '{"bucketName":{"prefix":"amzn-s3-demo-bucket"}}'
|
|
7
7
|
|
|
8
8
|
Output::
|
|
9
9
|
|
|
@@ -12,6 +12,7 @@ Output::
|
|
|
12
12
|
{
|
|
13
13
|
"accountId": "123456789012",
|
|
14
14
|
"allowsUnencryptedObjectUploads": "FALSE",
|
|
15
|
+
"automatedDiscoveryMonitoringStatus": "MONITORED",
|
|
15
16
|
"bucketArn": "arn:aws:s3:::amzn-s3-demo-bucket1",
|
|
16
17
|
"bucketCreatedAt": "2020-05-18T19:54:00+00:00",
|
|
17
18
|
"bucketName": "amzn-s3-demo-bucket1",
|
|
@@ -20,11 +21,11 @@ Output::
|
|
|
20
21
|
"jobDetails": {
|
|
21
22
|
"isDefinedInJob": "TRUE",
|
|
22
23
|
"isMonitoredByJob": "TRUE",
|
|
23
|
-
"lastJobId": "
|
|
24
|
-
"lastJobRunTime": "
|
|
24
|
+
"lastJobId": "08c81dc4a2f3377fae45c9ddaEXAMPLE",
|
|
25
|
+
"lastJobRunTime": "2024-08-19T14:55:30.270000+00:00"
|
|
25
26
|
},
|
|
26
|
-
"lastAutomatedDiscoveryTime": "
|
|
27
|
-
"lastUpdated": "
|
|
27
|
+
"lastAutomatedDiscoveryTime": "2024-10-22T19:11:25.364000+00:00",
|
|
28
|
+
"lastUpdated": "2024-10-25T07:33:06.337000+00:00",
|
|
28
29
|
"objectCount": 13,
|
|
29
30
|
"objectCountByEncryptionType": {
|
|
30
31
|
"customerManaged": 0,
|
|
@@ -101,6 +102,7 @@ Output::
|
|
|
101
102
|
{
|
|
102
103
|
"accountId": "123456789012",
|
|
103
104
|
"allowsUnencryptedObjectUploads": "TRUE",
|
|
105
|
+
"automatedDiscoveryMonitoringStatus": "MONITORED",
|
|
104
106
|
"bucketArn": "arn:aws:s3:::amzn-s3-demo-bucket2",
|
|
105
107
|
"bucketCreatedAt": "2020-11-25T18:24:38+00:00",
|
|
106
108
|
"bucketName": "amzn-s3-demo-bucket2",
|
|
@@ -109,11 +111,11 @@ Output::
|
|
|
109
111
|
"jobDetails": {
|
|
110
112
|
"isDefinedInJob": "TRUE",
|
|
111
113
|
"isMonitoredByJob": "FALSE",
|
|
112
|
-
"lastJobId": "
|
|
113
|
-
"lastJobRunTime": "
|
|
114
|
+
"lastJobId": "188d4f6044d621771ef7d65f2EXAMPLE",
|
|
115
|
+
"lastJobRunTime": "2024-07-09T19:37:11.511000+00:00"
|
|
114
116
|
},
|
|
115
|
-
"lastAutomatedDiscoveryTime": "
|
|
116
|
-
"lastUpdated": "
|
|
117
|
+
"lastAutomatedDiscoveryTime": "2024-10-24T19:11:25.364000+00:00",
|
|
118
|
+
"lastUpdated": "2024-10-25T07:33:06.337000+00:00",
|
|
117
119
|
"objectCount": 8,
|
|
118
120
|
"objectCountByEncryptionType": {
|
|
119
121
|
"customerManaged": 0,
|
|
@@ -190,4 +192,4 @@ Output::
|
|
|
190
192
|
]
|
|
191
193
|
}
|
|
192
194
|
|
|
193
|
-
For more information, see `Filtering your S3 bucket inventory <https://docs.aws.amazon.com/macie/latest/user/monitoring-s3-inventory-filter.html>`__ in the *Amazon Macie User Guide*.
|
|
195
|
+
For more information, see `Filtering your S3 bucket inventory <https://docs.aws.amazon.com/macie/latest/user/monitoring-s3-inventory-filter.html>`__ in the *Amazon Macie User Guide*.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
**To create a link**
|
|
2
|
+
|
|
3
|
+
The following ``create-link`` example creates a link between a source account and a sink that you have created in a monitoring account. ::
|
|
4
|
+
|
|
5
|
+
aws oam create-link \
|
|
6
|
+
--label-template sourceAccount \
|
|
7
|
+
--resource-types AWS::CloudWatch::Metric \
|
|
8
|
+
--sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345
|
|
9
|
+
|
|
10
|
+
Output::
|
|
11
|
+
|
|
12
|
+
{
|
|
13
|
+
"Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111",
|
|
14
|
+
"Id": "a1b2c3d4-5678-90ab-cdef-example11111",
|
|
15
|
+
"Label": "sourceAccount",
|
|
16
|
+
"LabelTemplate": "sourceAccount",
|
|
17
|
+
"ResourceTypes": [
|
|
18
|
+
"AWS::CloudWatch::Metric"
|
|
19
|
+
],
|
|
20
|
+
"SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
|
|
21
|
+
"Tags": {}
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
**To create a sink**
|
|
2
|
+
|
|
3
|
+
The following ``create-sink`` example creates a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. ::
|
|
4
|
+
|
|
5
|
+
aws oam create-sink \
|
|
6
|
+
--name DemoSink
|
|
7
|
+
|
|
8
|
+
Output::
|
|
9
|
+
|
|
10
|
+
{
|
|
11
|
+
"Arn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
|
|
12
|
+
"Id": "a1b2c3d4-5678-90ab-cdef-example12345",
|
|
13
|
+
"Name": "DemoSink",
|
|
14
|
+
"Tags": {}
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
**To delete a link**
|
|
2
|
+
|
|
3
|
+
The following ``delete-link`` example deletes a link between a monitoring account sink and a source account. ::
|
|
4
|
+
|
|
5
|
+
aws oam delete-link \
|
|
6
|
+
--identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111
|
|
7
|
+
|
|
8
|
+
This command produces no output.
|
|
9
|
+
|
|
10
|
+
For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
**To delete a sink**
|
|
2
|
+
|
|
3
|
+
The following ``delete-sink`` example deletes a sink. You must delete all links to a sink before you can delete that sink. ::
|
|
4
|
+
|
|
5
|
+
aws oam delete-sink \
|
|
6
|
+
--identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345
|
|
7
|
+
|
|
8
|
+
This command produces no output.
|
|
9
|
+
|
|
10
|
+
For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
**To return complete information about one link**
|
|
2
|
+
|
|
3
|
+
The following ``get-link`` example returns complete information about a link. ::
|
|
4
|
+
|
|
5
|
+
aws oam get-link \
|
|
6
|
+
--identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111
|
|
7
|
+
|
|
8
|
+
Output::
|
|
9
|
+
|
|
10
|
+
{
|
|
11
|
+
"Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111",
|
|
12
|
+
"Id": "a1b2c3d4-5678-90ab-cdef-example11111",
|
|
13
|
+
"Label": "sourceAccount",
|
|
14
|
+
"LabelTemplate": "sourceAccount",
|
|
15
|
+
"ResourceTypes": [
|
|
16
|
+
"AWS::CloudWatch::Metric"
|
|
17
|
+
],
|
|
18
|
+
"SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
|
|
19
|
+
"Tags": {}
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
**To return the current sink policy attached to the sink**
|
|
2
|
+
|
|
3
|
+
The following ``get-sink-policy`` example returns the current sink policy attached to the sink. ::
|
|
4
|
+
|
|
5
|
+
aws oam get-sink-policy \
|
|
6
|
+
--sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345
|
|
7
|
+
|
|
8
|
+
Output::
|
|
9
|
+
|
|
10
|
+
{
|
|
11
|
+
"SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
|
|
12
|
+
"SinkId": "a1b2c3d4-5678-90ab-cdef-example12345",
|
|
13
|
+
"Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789111:root\"},\"Action\":[\"oam:CreateLink\",\"oam:UpdateLink\"],\"Resource\":\"*\",\"Condition\":{\"ForAllValues:StringEquals\":{\"oam:ResourceTypes\":[\"AWS::Logs::LogGroup\",\"AWS::CloudWatch::Metric\",\"AWS::XRay::Trace\",\"AWS::ApplicationInsights::Application\"]}}}]}"
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
**To return complete information about one monitoring account sink**
|
|
2
|
+
|
|
3
|
+
The following ``get-sink`` example returns complete information about a monitoring account sink. ::
|
|
4
|
+
|
|
5
|
+
aws oam get-sink \
|
|
6
|
+
--identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345
|
|
7
|
+
|
|
8
|
+
Output::
|
|
9
|
+
|
|
10
|
+
{
|
|
11
|
+
"Arn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
|
|
12
|
+
"Id": "a1b2c3d4-5678-90ab-cdef-example12345",
|
|
13
|
+
"Name": "DemoSink",
|
|
14
|
+
"Tags": {}
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
For more information, see `CloudWatch cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html>`__ in the *Amazon CloudWatch User Guide*.
|