awscli.amazonaws.com Open in urlscan Pro
13.225.159.8  Public Scan

URL: https://awscli.amazonaws.com/v2/documentation/api/latest/reference/index.html
Submission: On November 04 via manual from JP — Scanned from JP

Form analysis 1 forms found in the DOM

GET ../search.html

<form class="form-search margin-top-1em" action="../search.html" method="get">
  <input type="text" name="q" style="width: 105px" class="input-small search-query">
  <button type="submit" class="btn btn-small">Search</button>
  <input type="hidden" name="check_keywords" value="yes">
  <input type="hidden" name="area" value="default">
</form>

Text Content

AWS CLI Command Reference
 * Home
 * User Guide
 * Forum
 * GitHub




NAVIGATION

 * index
 * next |
 * previous |
 * AWS CLI 2.3.3 Command Reference »

 * ← AWS CLI Command Reference /
 * accessanalyzer →


TABLE OF CONTENTS

 * aws
   * Description
   * Synopsis
   * Options
   * Available Services
   * See Also


QUICK SEARCH

Search


FEEDBACK

Did you find this page useful? Do you have a suggestion to improve the
documentation? Give us feedback.
If you would like to suggest an improvement or fix for the AWS CLI, check out
our contributing guide on GitHub.


USER GUIDE

First time using the AWS CLI? See the User Guide for help getting started.


AWS¶


DESCRIPTION¶

The AWS Command Line Interface is a unified tool to manage your AWS services.


SYNOPSIS¶

aws [options] <command> <subcommand> [parameters]


Use aws command help for information on a specific command. Use aws help topics
to view a list of available help topics. The synopsis for each command shows its
parameters and their usage. Optional parameters are shown in square brackets.


OPTIONS¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each
SSL connection, the AWS CLI will verify SSL certificates. This option overrides
the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

 * json

 * text

 * table

 * yaml

 * yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

 * on

 * off

 * auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is
provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides
config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket
read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket
connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64.
The base64 format expects binary blobs to be provided as a base64 encoded
string. The raw-in-base64-out format preserves compatibility with AWS CLI V1
behavior and binary values must be passed literally. When providing contents
from a file that map to a binary blob fileb:// will always be treated as binary
and use the file contents directly regardless of the cli-binary-format setting.
When using file:// the file contents will need to properly formatted for the
configured cli-binary-format.

 * base64

 * raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.


AVAILABLE SERVICES¶

 * accessanalyzer
 * account
 * acm
 * acm-pca
 * alexaforbusiness
 * amp
 * amplify
 * amplifybackend
 * apigateway
 * apigatewaymanagementapi
 * apigatewayv2
 * appconfig
 * appflow
 * appintegrations
 * application-autoscaling
 * application-insights
 * applicationcostprofiler
 * appmesh
 * apprunner
 * appstream
 * appsync
 * athena
 * auditmanager
 * autoscaling
 * autoscaling-plans
 * backup
 * batch
 * braket
 * budgets
 * ce
 * chime
 * chime-sdk-identity
 * chime-sdk-messaging
 * cli-dev
 * cloud9
 * cloudcontrol
 * clouddirectory
 * cloudformation
 * cloudfront
 * cloudhsm
 * cloudhsmv2
 * cloudsearch
 * cloudsearchdomain
 * cloudtrail
 * cloudwatch
 * codeartifact
 * codebuild
 * codecommit
 * codeguru-reviewer
 * codeguruprofiler
 * codepipeline
 * codestar
 * codestar-connections
 * codestar-notifications
 * cognito-identity
 * cognito-idp
 * cognito-sync
 * comprehend
 * comprehendmedical
 * compute-optimizer
 * configservice
 * configure
 * connect
 * connect-contact-lens
 * connectparticipant
 * cur
 * customer-profiles
 * databrew
 * dataexchange
 * datapipeline
 * datasync
 * dax
 * ddb
 * deploy
 * detective
 * devicefarm
 * devops-guru
 * directconnect
 * discovery
 * dlm
 * dms
 * docdb
 * ds
 * dynamodb
 * dynamodbstreams
 * ebs
 * ec2
 * ec2-instance-connect
 * ecr
 * ecr-public
 * ecs
 * efs
 * eks
 * elastic-inference
 * elasticache
 * elasticbeanstalk
 * elastictranscoder
 * elb
 * elbv2
 * emr
 * emr-containers
 * es
 * events
 * finspace
 * finspace-data
 * firehose
 * fis
 * fms
 * forecast
 * forecastquery
 * frauddetector
 * fsx
 * gamelift
 * glacier
 * globalaccelerator
 * glue
 * grafana
 * greengrass
 * greengrassv2
 * groundstation
 * guardduty
 * health
 * healthlake
 * history
 * honeycode
 * iam
 * identitystore
 * imagebuilder
 * importexport
 * inspector
 * iot
 * iot-data
 * iot-jobs-data
 * iot1click-devices
 * iot1click-projects
 * iotanalytics
 * iotdeviceadvisor
 * iotevents
 * iotevents-data
 * iotfleethub
 * iotsecuretunneling
 * iotsitewise
 * iotthingsgraph
 * iotwireless
 * ivs
 * kafka
 * kafkaconnect
 * kendra
 * kinesis
 * kinesis-video-archived-media
 * kinesis-video-media
 * kinesis-video-signaling
 * kinesisanalytics
 * kinesisanalyticsv2
 * kinesisvideo
 * kms
 * lakeformation
 * lambda
 * lex-models
 * lex-runtime
 * lexv2-models
 * lexv2-runtime
 * license-manager
 * lightsail
 * location
 * logs
 * lookoutequipment
 * lookoutmetrics
 * lookoutvision
 * machinelearning
 * macie
 * macie2
 * managedblockchain
 * marketplace-catalog
 * marketplace-entitlement
 * marketplacecommerceanalytics
 * mediaconnect
 * mediaconvert
 * medialive
 * mediapackage
 * mediapackage-vod
 * mediastore
 * mediastore-data
 * mediatailor
 * memorydb
 * meteringmarketplace
 * mgh
 * mgn
 * migrationhub-config
 * mobile
 * mq
 * mturk
 * mwaa
 * neptune
 * network-firewall
 * networkmanager
 * nimble
 * opensearch
 * opsworks
 * opsworks-cm
 * organizations
 * outposts
 * panorama
 * personalize
 * personalize-events
 * personalize-runtime
 * pi
 * pinpoint
 * pinpoint-email
 * pinpoint-sms-voice
 * polly
 * pricing
 * proton
 * qldb
 * qldb-session
 * quicksight
 * ram
 * rds
 * rds-data
 * redshift
 * redshift-data
 * rekognition
 * resource-groups
 * resourcegroupstaggingapi
 * robomaker
 * route53
 * route53-recovery-cluster
 * route53-recovery-control-config
 * route53-recovery-readiness
 * route53domains
 * route53resolver
 * s3
 * s3api
 * s3control
 * s3outposts
 * sagemaker
 * sagemaker-a2i-runtime
 * sagemaker-edge
 * sagemaker-featurestore-runtime
 * sagemaker-runtime
 * savingsplans
 * schemas
 * sdb
 * secretsmanager
 * securityhub
 * serverlessrepo
 * service-quotas
 * servicecatalog
 * servicecatalog-appregistry
 * servicediscovery
 * ses
 * sesv2
 * shield
 * signer
 * sms
 * snow-device-management
 * snowball
 * sns
 * sqs
 * ssm
 * ssm-contacts
 * ssm-incidents
 * sso
 * sso-admin
 * sso-oidc
 * stepfunctions
 * storagegateway
 * sts
 * support
 * swf
 * synthetics
 * textract
 * timestream-query
 * timestream-write
 * transcribe
 * transfer
 * translate
 * voice-id
 * waf
 * waf-regional
 * wafv2
 * wellarchitected
 * wisdom
 * workdocs
 * worklink
 * workmail
 * workmailmessageflow
 * workspaces
 * xray


SEE ALSO¶

 * aws help topics


 * ← AWS CLI Command Reference /
 * accessanalyzer →


NAVIGATION

 * index
 * next |
 * previous |
 * AWS CLI 2.3.3 Command Reference »

© Copyright 2018, Amazon Web Services. Created using Sphinx.