aws-cli
aws-cli copied to clipboard
Published
20 hours ago •
aws
aws
Warning when getting help
Describe the bug
Some aws commands generate warning related to strings, when asking for help.
Expected Behavior
Help pages shouldn't generate warnings.
Current Behavior
This is just example, there are many help pages that generate the warning.
=$ aws apprunner disassociate-custom-domain help > /dev/null
<string>:298: (WARNING/2) Inline literal start-string without end-string.
Reproduction Steps
Run help on some aws commands, and redirect help to /dev/null to see the warning.
Possible Solution
No response
Additional Information/Context
No response
CLI version used
aws-cli/2.15.4 Python/3.11.6 Linux/6.5.0-5-amd64 exe/x86_64.debian prompt/off
Environment details (OS name and version, etc.)
Linux Debian (trixie). Kernel 6.5.0-5-amd64; Python 3.11.7
List of services/commands that generate this warning:
- cloudtrail/create-event-data-store
- cloudtrail/get-channel
- cloudtrail/get-event-data-store
- cloudtrail/get-event-selectors
- cloudtrail/list-event-data-stores
- cloudtrail/put-event-selectors
- cloudtrail/restore-event-data-store
- cloudtrail/update-event-data-store
- compute-optimizer/export-auto-scaling-group-recommendations
- compute-optimizer/export-ec2-instance-recommendations
- compute-optimizer/get-auto-scaling-group-recommendations
- compute-optimizer/get-ebs-volume-recommendations
- compute-optimizer/get-ec2-instance-recommendations
- compute-optimizer/get-ecs-service-recommendations
- compute-optimizer/get-lambda-function-recommendations
- efs/describe-backup-policy
- efs/put-backup-policy
- efs/put-lifecycle-configuration
- glue/batch-get-jobs
- glue/create-job
- glue/get-job
- glue/get-jobs
- glue/update-job
- kendra/create-data-source
- kendra/describe-data-source
- kendra/update-data-source
- kinesis-video-archived-media/get-dash-streaming-session-url
- kinesis-video-archived-media/get-hls-streaming-session-url
- lightsail/create-certificate
- lightsail/create-distribution
- lightsail/get-bucket-metric-data
- lightsail/get-certificates
- lightsail/get-distributions
- lightsail/get-distribution-metric-data
- lightsail/get-instance-metric-data
- lightsail/get-load-balancer
- lightsail/get-load-balancers
- lightsail/get-load-balancer-metric-data
- lightsail/get-load-balancer-tls-certificates
- lightsail/get-relational-database-metric-data
- lightsail/update-distribution
- machinelearning/create-data-source-from-rds
- machinelearning/create-data-source-from-redshift
- machinelearning/create-data-source-from-s3
- machinelearning/describe-batch-predictions
- machinelearning/describe-evaluations
- machinelearning/describe-ml-models
- neptunedata/execute-fast-reset
- neptunedata/get-propertygraph-stream
- neptunedata/start-loader-job
- ram/get-resource-shares
- ram/list-principals
- ram/list-resources
- resiliencehub/describe-app-version-template
- resiliencehub/put-draft-app-version-template
- s3api/delete-object
- s3api/delete-objects
- s3api/put-object
- servicediscovery/create-service
- servicediscovery/get-service
- servicediscovery/list-services
- servicediscovery/update-service
- ssm/create-patch-baseline
- ssm/describe-available-patches
- ssm/describe-instance-patches
- ssm/describe-ops-items
- ssm/describe-patch-baselines
- ssm/describe-patch-groups
- ssm/update-patch-baseline
- transfer/create-workflow
- transfer/describe-execution
- transfer/describe-workflow
Scanned all other docs, and found also these:
Inline emphasis start-string without end-string.
- acm/request-certificate
- backup/create-restore-testing-plan
- backup/get-restore-testing-plan
- backup/update-restore-testing-plan
- ce/get-savings-plans-purchase-recommendation
- codecommit/create-approval-rule-template
- codecommit/create-pull-request-approval-rule
- codecommit/update-pull-request-approval-rule-content
- datasync/list-locations
- elbv2/create-rule
- elbv2/describe-rules
- elbv2/modify-rule
- elbv2/set-rule-priorities
- events/describe-rule
- events/list-rules
- events/put-rule
- forecast/create-dataset
- glacier/upload-multipart-part
- lexv2-models/create-slot-type
- lexv2-models/describe-slot-type
- lexv2-models/update-slot-type
- lex-models/create-slot-type-version
- lex-models/get-slot-type
- lex-models/put-slot-type
- mediastore/get-cors-policy
- mediastore/put-cors-policy
- redshift/create-snapshot-schedule
- redshift/modify-snapshot-schedule
- rekognition/start-segment-detection
- resiliencehub/describe-app-version-template
- resiliencehub/put-draft-app-version-template
- resource-groups/create-group
- resource-groups/get-group-query
- resource-groups/search-resources
- resource-groups/update-group-query
- s3control/create-access-grant
- s3control/get-access-grant
- s3control/list-access-grants
- serverlessrepo/create-cloud-formation-change-set
- servicecatalog/associate-principal-with-portfolio
- ssm/describe-ops-items
Anonymous hyperlink mismatch: 1 references but 0 targets.
- appmesh/create-virtual-service
- codestar/create-project
- connect/get-federation-token
- detective/delete-members
- detective/disassociate-membership
- detective/get-members
- detective/list-invitations
- detective/reject-invitation
- dms/create-replication-instance
- ec2/describe-carrier-gateways
- elasticache/reboot-cache-cluster
- healthlake/start-fhir-import-job
- iam/upload-server-certificate
- iam/upload-signing-certificate
- iotanalytics/untag-resource
- iotanalytics/update-dataset
- iot/get-cardinality
- iot/remove-thing-from-thing-group
- kms/create-key
- kms/delete-imported-key-material
- kms/generate-random
- mediapackage/describe-channel
- mediatailor/list-playback-configurations
- mwaa/help
- route53domains/disable-domain-auto-renew
- route53domains/enable-domain-auto-renew
- sagemaker/create-endpoint-config
- sagemaker/create-monitoring-schedule
- sagemaker/describe-endpoint
- sagemaker/describe-endpoint-config
- shield/associate-drt-role
- shield/describe-emergency-contact-settings
- sqs/help
- transcribe/list-medical-transcription-jobs
There are also other warnings/errors, but these are the most common. In total I found some kind of stderr message in 310 service/command help pages.
$ aws kms generate-data-key help
<string>:: (ERROR/3) Anonymous hyperlink mismatch: 2 references but 0 targets.
See "backrefs" attribute for IDs.
$ aws kms help
<string>:18: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.
$ aws --version
aws-cli/2.15.26 Python/3.11.8 Linux/5.15.146.1-microsoft-standard-WSL2 exe/x86_64.ubuntu.22 prompt/off
