Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The following ``list-service-dependencies`` example returns a list of service de
aws application-signals list-service-dependencies \
--start-time 1732021200 \
--end-time 1732107600 \
--key-attributes Environment=api-gateway:prod, Name=PetAdoptionStatusUpdater,Type=Service
--key-attributes Environment=api-gateway:prod,Name=PetAdoptionStatusUpdater,Type=Service

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/athena/update-data-catalog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The following ``update-data-catalog`` example updates the Lambda function and de
--name cw_logs_catalog \
--type LAMBDA \
--description "New CloudWatch Logs Catalog" \
--function=arn:aws:lambda:us-west-2:123456789012:function:new_cw_logs_lambda
--parameters function=arn:aws:lambda:us-west-2:123456789012:function:new_cw_logs_lambda

This command produces no output. To see the result, use ``aws athena get-data-catalog --name cw_logs_catalog``.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The following ``create-invalidation-for-distribution-tenant`` example creates an

aws cloudfront create-invalidation-for-distribution-tenant \
--id dt_2wjDZi3hD1ivOXf6rpZJO1AB \
--invalidation-batch '{"Paths": {"Quantity": 1, "Items": ["/*"]}, "CallerReference": "invalidation-'$(date +%s)'"}'
--invalidation-batch '{"Paths": {"Quantity": 1, "Items": ["/*"]}, "CallerReference": "invalidation-1783101622"}'

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/codebuild/list-builds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Run this command again and provide the ``nextToken`` value in the previous respo

aws codebuild list-builds \
--sort-order ASCENDING \
--next-token 4AEA6u7J...The full token has been omitted for brevity...MzY2OA==
--next-token "4AEA6u7J...The full token has been omitted for brevity...MzY2OA=="

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/codebuild/list-projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Run this command again and provide the ``nextToken`` value from the previous res
aws codebuild list-projects \
--sort-by NAME \
--sort-order ASCENDING \
--next-token Ci33ACF6...The full token has been omitted for brevity...U+AkMx8=
--next-token "Ci33ACF6...The full token has been omitted for brevity...U+AkMx8="

Output::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
The following ``batch-disassociate-approval-rule-template-from-repositories`` example disassociates the specified approval rule template from repositories named ``MyDemoRepo`` and ``MyOtherDemoRepo``. ::

aws codecommit batch-disassociate-approval-rule-template-from-repositories \
--repository-names MyDemoRepo, MyOtherDemoRepo \
--approval-rule-template-name 1-approval-rule-for-all pull requests
--repository-names MyDemoRepo MyOtherDemoRepo \
--approval-rule-template-name 1-approval-rule-for-all-pull-requests

Output::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The following ``create-unreferenced-merge-commit`` example creates a commit that
--destination-commit-specifier main \
--merge-option THREE_WAY_MERGE \
--repository-name MyDemoRepo \
--name "Maria Garcia" \
--author-name "Maria Garcia" \
--email "maria_garcia@example.com" \
--commit-message "Testing the results of this merge."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The following ``get-comments-for-compared-commit`` example displays comments mad

aws codecommit get-comments-for-compared-commit \
--repository-name MyDemoRepo \
--before-commit-ID 6e147360EXAMPLE \
--before-commit-id 6e147360EXAMPLE \
--after-commit-id 317f8570EXAMPLE

Output::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The following ``get-comments-for-pull-request`` example displays comments for a
aws codecommit get-comments-for-pull-request \
--repository-name MyDemoRepo \
--pull-request-id 42 \
--before-commit-ID 317f8570EXAMPLE \
--before-commit-id 317f8570EXAMPLE \
--after-commit-id 5d036259EXAMPLE

Output::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The following ``merge-pull-request-by-squash`` example merges and closes the spe
--repository-name MyDemoRepo \
--conflict-detail-level LINE_LEVEL \
--conflict-resolution-strategy ACCEPT_SOURCE \
--name "Jorge Souza" \
--author-name "Jorge Souza" \
--email "jorge_souza@example.com" \
--commit-message "Merging pull request 47 by squash and accepting source in merge conflicts"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The following ``merge-pull-request-by-three-way`` example merges and closes the
--pull-request-id 47 \
--source-commit-id 99132ab0EXAMPLE \
--repository-name MyDemoRepo \
--name "Maria Garcia" \
--author-name "Maria Garcia" \
--email "maria_garcia@example.com" \
--commit-message "Merging pull request 47 by three-way with default options"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@ which contains the dominant language of each of the text files as well as the pr

aws comprehend start-dominant-language-detection-job \
--job-name example_language_analysis_job \
--language-code en \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket1/" \
--output-data-config "S3Uri=s3://amzn-s3-demo-bucket2/testfolder/" \
--data-access-role-arn arn:aws:iam::123456789012:role/service-role/AmazonComprehendServiceRole-example-role \
--language-code en
--data-access-role-arn arn:aws:iam::123456789012:role/service-role/AmazonComprehendServiceRole-example-role

Contents of ``Sampletext1.txt``::

Expand Down
4 changes: 1 addition & 3 deletions awscli/examples/comprehend/start-topics-detection-job.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@ The second file, ``doc-topics.csv``, lists the documents associated with a topic

aws comprehend start-topics-detection-job \
--job-name example_topics_detection_job \
--language-code en \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket1/" \
--output-data-config "S3Uri=s3://amzn-s3-demo-bucket2/testfolder/" \
--data-access-role-arn arn:aws:iam::123456789012:role/service-role/AmazonComprehendServiceRole-example-role \
--language-code en
--data-access-role-arn arn:aws:iam::123456789012:role/service-role/AmazonComprehendServiceRole-example-role

Output::

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/comprehend/update-endpoint.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The following ``update-endpoint`` example updates information about an endpoint.

aws comprehend update-endpoint \
--endpoint-arn arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/example-classifier-endpoint \
--active-model-arn arn:aws:comprehend:us-west-2:123456789012:document-classifier/example-classifier-new
--desired-model-arn arn:aws:comprehend:us-west-2:123456789012:document-classifier/example-classifier-new

This command produces no output.

Expand Down
4 changes: 2 additions & 2 deletions awscli/examples/deploy/list-application-revisions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ The following ``list-application-revisions`` example displays information about

aws deploy list-application-revisions \
--application-name WordPress_App \
--s-3-bucket CodeDeployDemoBucket \
--s3-bucket CodeDeployDemoBucket \
--deployed exclude \
--s-3-key-prefix WordPress_ \
--s3-key-prefix WordPress_ \
--sort-by lastUsedTime \
--sort-order descending

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/ds-data/describe-user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The following ``describe-user`` example gets information for the specified user in the specified directory. ::

aws ds-data describe-user command-name \
aws ds-data describe-user \
--directory-id d-1234567890 \
--sam-account-name 'john.doe'

Expand Down
14 changes: 1 addition & 13 deletions awscli/examples/ecs/wait/services-stable.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
**Example 1: To pause running until a service is confirmed to be stable**
**To pause running until a service is confirmed to be stable**

The following ``wait services-stable`` example pauses and continues only after it can confirm that the specified service running on the specified cluster is stable. ::

Expand All @@ -9,15 +9,3 @@ The following ``wait services-stable`` example pauses and continues only after i
This command produces no output.

For more information, see `Amazon ECS services <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html>`__ in the *Amazon ECS Developer Guide*.

**Example 2: To pause running until a task is confirmed to be running**

The following ``wait services-stable`` example pauses and continues only after the specified task enters a ``RUNNING`` state. ::

aws ecs wait services-stable \
--cluster MyCluster \
--tasks arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-EXAMPLE44444

This command produces no output.

For more information, see `Amazon ECS task lifecycle <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle-explanation.html>`__ in the *Amazon ECS Developer Guide*.
11 changes: 11 additions & 0 deletions awscli/examples/ecs/wait/tasks-running.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
**To pause running until a task is confirmed to be running**

The following ``wait tasks-running`` example pauses and continues only after the specified task enters a ``RUNNING`` state. ::

aws ecs wait tasks-running \
--cluster MyCluster \
--tasks arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-EXAMPLE44444

This command produces no output.

For more information, see `Amazon ECS task lifecycle <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle-explanation.html>`__ in the *Amazon ECS Developer Guide*.
2 changes: 1 addition & 1 deletion awscli/examples/fis/update-experiment-template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The following ``update-experiment-template`` example updates the description of

aws fis update-experiment-template \
--id ABCDE1fgHIJkLmNop \
---description myExperimentTemplate
--description myExperimentTemplate

Output::

Expand Down
12 changes: 6 additions & 6 deletions awscli/examples/healthlake/create-fhir-datastore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ The following ``create-fhir-datastore`` example demonstrates how to create a new
Output::

{
"DatastoreEndpoint": "https://healthlake.us-west-2.amazonaws.com/datastore/(Data store ID)/r4/",
"DatastoreArn": "arn:aws:healthlake:us-west-2:(AWS Account ID):datastore/(Data store ID)",
"DatastoreEndpoint": "https://healthlake.us-west-2.amazonaws.com/datastore/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6/r4/",
"DatastoreArn": "arn:aws:healthlake:us-west-2:123456789012:datastore/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"DatastoreStatus": "CREATING",
"DatastoreId": "(Data store ID)"
"DatastoreId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}

**Example 2: To create a SMART on FHIR-enabled HealthLake data store**
Expand All @@ -38,10 +38,10 @@ Contents of ``identity_provider_configuration.json``::
Output::

{
"DatastoreEndpoint": "https://healthlake.us-west-2.amazonaws.com/datastore/(Data store ID)/r4/",
"DatastoreArn": "arn:aws:healthlake:us-west-2:(AWS Account ID):datastore/(Data store ID)",
"DatastoreEndpoint": "https://healthlake.us-west-2.amazonaws.com/datastore/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6/r4/",
"DatastoreArn": "arn:aws:healthlake:us-west-2:123456789012:datastore/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"DatastoreStatus": "CREATING",
"DatastoreId": "(Data store ID)"
"DatastoreId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}

For more information, see `Creating a HealthLake data store <https://docs.aws.amazon.com/healthlake/latest/devguide/managing-data-stores-create.html>`__ in the *AWS HealthLake Developer Guide*.
8 changes: 4 additions & 4 deletions awscli/examples/healthlake/delete-fhir-datastore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
The following ``delete-fhir-datastore`` example demonstrates how to delete a data store and all of its contents in AWS HealthLake. ::

aws healthlake delete-fhir-datastore \
--datastore-id (Data store ID)
--datastore-id a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Output::

{
"DatastoreEndpoint": "https://healthlake.us-west-2.amazonaws.com/datastore/(Data store ID)/r4/",
"DatastoreArn": "arn:aws:healthlake:us-west-2:(AWS Account ID):datastore/(Data store ID)",
"DatastoreEndpoint": "https://healthlake.us-west-2.amazonaws.com/datastore/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6/r4/",
"DatastoreArn": "arn:aws:healthlake:us-west-2:123456789012:datastore/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"DatastoreStatus": "DELETING",
"DatastoreId": "(Data store ID)"
"DatastoreId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}

For more information, see `Deleting a HealthLake data store <https://docs.aws.amazon.com/healthlake/latest/devguide/managing-data-stores-delete.html>`__ in the *AWS HealthLake Developer Guide*.
6 changes: 3 additions & 3 deletions awscli/examples/healthlake/describe-fhir-datastore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ Output::
}
},
"DatastoreName": "Demo",
"DatastoreArn": "arn:aws:healthlake:us-west-2:<AWS Account ID>:datastore/<Data store ID>",
"DatastoreEndpoint": "https://healthlake.us-west-2.amazonaws.com/datastore/<Data store ID>/r4/",
"DatastoreArn": "arn:aws:healthlake:us-west-2:123456789012:datastore/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"DatastoreEndpoint": "https://healthlake.us-west-2.amazonaws.com/datastore/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6/r4/",
"DatastoreStatus": "ACTIVE",
"DatastoreTypeVersion": "R4",
"CreatedAt": 1603761064.881,
"DatastoreId": "<Data store ID>",
"DatastoreId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"IdentityProviderConfiguration": {
"AuthorizationStrategy": "AWS_AUTH",
"FineGrainedAuthorizationEnabled": false
Expand Down
8 changes: 4 additions & 4 deletions awscli/examples/healthlake/describe-fhir-export-job.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,26 @@
The following ``describe-fhir-export-job`` example shows how to find the properties of a FHIR export job in AWS HealthLake. ::

aws healthlake describe-fhir-export-job \
--datastore-id (Data store ID) \
--datastore-id a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 \
--job-id 9b9a51943afaedd0a8c0c26c49135a31

Output::

{
"ExportJobProperties": {
"DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
"DataAccessRoleArn": "arn:aws:iam::123456789012:role/HealthLakeDataAccessRole",
"JobStatus": "IN_PROGRESS",
"JobId": "9009813e9d69ba7cf79bcb3468780f16",
"SubmitTime": "2024-11-20T11:31:46.672000-05:00",
"EndTime": "2024-11-20T11:34:01.636000-05:00",
"OutputDataConfig": {
"S3Configuration": {
"S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
"S3Uri": "s3://amzn-s3-demo-bucket/healthlake/",
"KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

},
"DatastoreId": "(Data store ID)"
"DatastoreId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
}

Expand Down
8 changes: 4 additions & 4 deletions awscli/examples/healthlake/describe-fhir-import-job.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@
The following ``describe-fhir-import-job`` example shows how to learn the properties of a FHIR import job using AWS HealthLake. ::

aws healthlake describe-fhir-import-job \
--datastore-id (Data store ID) \
--datastore-id a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 \
--job-id c145fbb27b192af392f8ce6e7838e34f

Output::

{
"ImportJobProperties": {
"InputDataConfig": {
"S3Uri": "s3://(Bucket Name)/(Prefix Name)/"
"S3Uri": "s3://amzn-s3-demo-bucket/healthlake/"
},
"DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
"DataAccessRoleArn": "arn:aws:iam::123456789012:role/HealthLakeDataAccessRole",
"JobStatus": "COMPLETED",
"JobId": "c145fbb27b192af392f8ce6e7838e34f",
"SubmitTime": 1606272542.161,
"EndTime": 1606272609.497,
"DatastoreId": "(Data store ID)"
"DatastoreId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
}

Expand Down
6 changes: 3 additions & 3 deletions awscli/examples/healthlake/list-fhir-datastores.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ Output::
}
},
"DatastoreName": "Demo",
"DatastoreArn": "arn:aws:healthlake:us-west-2:<AWS Account ID>:datastore/<Data store ID>",
"DatastoreEndpoint": "https://healthlake.us-west-2.amazonaws.com/datastore/<Data store ID>/r4/",
"DatastoreArn": "arn:aws:healthlake:us-west-2:123456789012:datastore/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"DatastoreEndpoint": "https://healthlake.us-west-2.amazonaws.com/datastore/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6/r4/",
"DatastoreStatus": "ACTIVE",
"DatastoreTypeVersion": "R4",
"CreatedAt": 1603761064.881,
"DatastoreId": "<Data store ID>",
"DatastoreId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"IdentityProviderConfiguration": {
"AuthorizationStrategy": "AWS_AUTH",
"FineGrainedAuthorizationEnabled": false
Expand Down
16 changes: 8 additions & 8 deletions awscli/examples/healthlake/list-fhir-export-jobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
The following ``list-fhir-export-jobs`` example shows how to use the command to view a list of export jobs associated with an account. ::

aws healthlake list-fhir-export-jobs \
--datastore-id (Data store ID) \
--submitted-before (DATE like 2024-10-13T19:00:00Z) \
--submitted-after (DATE like 2020-10-13T19:00:00Z ) \
--datastore-id a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 \
--submitted-before 2024-10-13T19:00:00Z \
--submitted-after 2020-10-13T19:00:00Z \
--job-name "FHIR-EXPORT" \
--job-status SUBMITTED \
--max-results (Integer between 1 and 500)
--max-results 50

Output::

Expand All @@ -17,17 +17,17 @@ Output::
{
"OutputDataConfig": {
"S3Configuration": {
"S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
"KmsKeyId": "(KmsKey Id)"
"S3Uri": "s3://amzn-s3-demo-bucket/healthlake/",
"KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
},
"DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
"DataAccessRoleArn": "arn:aws:iam::123456789012:role/HealthLakeDataAccessRole",
"JobStatus": "COMPLETED",
"JobId": "c145fbb27b192af392f8ce6e7838e34f",
"JobName": "FHIR-EXPORT",
"SubmitTime": "2024-11-20T11:31:46.672000-05:00",
"EndTime": "2024-11-20T11:34:01.636000-05:00",
"DatastoreId": "(Data store ID)"
"DatastoreId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
]
}
Expand Down
Loading
Loading