| Latest revision |
Your text |
| Line 1: |
Line 1: |
| | {{lc}} | | {{lc}} |
| | [[aws configure get]] help | | [[aws configure get]] help |
| − |
| |
| − | GET() GET()
| |
| − |
| |
| − | N[[�]]NA�AM�ME�E
| |
| − | get -
| |
| − |
| |
| − | D�DE�ES�SC�CR�RI�IP�PT�TI�IO�ON�N
| |
| − | Get a configuration value from the config file.
| |
| − |
| |
| − | The a�aw�ws�s c�co�on�nf�fi�ig�gu�ur�re�e g�ge�et�t command can be used to print a configuration
| |
| − | value in the AWS config file. The g�ge�et�t command supports two types of
| |
| − | configuration values, _�u_�n_�q_�u_�a_�l_�i_�f_�i_�e_�d and _�q_�u_�a_�l_�i_�f_�i_�e_�d config values.
| |
| − |
| |
| − | Note that a�aw�ws�s c�co�on�nf�fi�ig�gu�ur�re�e g�ge�et�t only looks at values in the AWS
| |
| − | configuration file. It does n�no�ot�t resolve configuration variables
| |
| − | specified anywhere else, including environment variables, command line
| |
| − | arguments, etc.
| |
| − |
| |
| − | U�Un�nq�qu�ua�al�li�if�fi�ie�ed�d N�Na�am�me�es�s
| |
| − | Every value in the AWS configuration file must be placed in a section
| |
| − | (denoted by [�[s�se�ec�ct�ti�io�on�n-�-n�na�am�me�e]�] in the config file). To retrieve a value
| |
| − | from the config file, the section name and the config name must be
| |
| − | known.
| |
| − |
| |
| − | An unqualified configuration name refers to a name that is not scoped
| |
| − | to a specific section in the configuration file. Sections are
| |
| − | specified by separating parts with the "�".�."�" character
| |
| − | (s�se�ec�ct�ti�io�on�n.�.c�co�on�nf�fi�ig�g-�-n�na�am�me�e). An unqualified name will be scoped to the
| |
| − | current profile. For example, a�aw�ws�s c�co�on�nf�fi�ig�gu�ur�re�e g�ge�et�t a�aw�ws�s_�_a�ac�cc�ce�es�ss�s_�_k�ke�ey�y_�_i�id�d will
| |
| − | retrieve the a�aw�ws�s_�_a�ac�cc�ce�es�ss�s_�_k�ke�ey�y_�_i�id�d from the current profile, or the
| |
| − | d�de�ef�fa�au�ul�lt�t profile if no profile is specified. You can still provide a
| |
| − | -�--�-p�pr�ro�of�fi�il�le�e argument to the a�aw�ws�s c�co�on�nf�fi�ig�gu�ur�re�e g�ge�et�t command. For example, a�aw�ws�s
| |
| − | c�co�on�nf�fi�ig�gu�ur�re�e g�ge�et�t r�re�eg�gi�io�on�n -�--�-p�pr�ro�of�fi�il�le�e t�te�es�st�ti�in�ng�g will print the region value for
| |
| − | the t�te�es�st�ti�in�ng�g profile.
| |
| − |
| |
| − | Q�Qu�ua�al�li�if�fi�ie�ed�d N�Na�am�me�es�s
| |
| − | A qualified name is a name that has at least one "�".�."�" character in the
| |
| − | name. This name provides a way to specify the config section from
| |
| − | which to retrieve the config variable. When a qualified name is
| |
| − | provided to a�aw�ws�s c�co�on�nf�fi�ig�gu�ur�re�e g�ge�et�t, the currently specified profile is
| |
| − | ignored. Section names that have the format [�[p�pr�ro�of�fi�il�le�e p�pr�ro�of�fi�il�le�e-�-n�na�am�me�e]�] can
| |
| − | be specified by using the p�pr�ro�of�fi�il�le�e.�.p�pr�ro�of�fi�il�le�e-�-n�na�am�me�e.�.c�co�on�nf�fi�ig�g-�-n�na�am�me�e syntax, and
| |
| − | the default profile can be specified using the d�de�ef�fa�au�ul�lt�t.�.c�co�on�nf�fi�ig�g-�-n�na�am�me�e
| |
| − | syntax.
| |
| − |
| |
| − | S�SY�YN�NO�OP�PS�SI�IS�S
| |
| − |
| |
| − | aws configure get varname [--profile profile-name]
| |
| − |
| |
| − | O�OP�PT�TI�IO�ON�NS�S
| |
| − | v�va�ar�rn�na�am�me�e (string) The name of the config value to retrieve.
| |
| − |
| |
| − | G�GL�LO�OB�BA�AL�L O�OP�PT�TI�IO�ON�NS�S
| |
| − | -�--�-d�de�eb�bu�ug�g (boolean)
| |
| − |
| |
| − | Turn on debug logging.
| |
| − |
| |
| − | -�--�-e�en�nd�dp�po�oi�in�nt�t-�-u�ur�rl�l (string)
| |
| − |
| |
| − | Override command's default URL with the given URL.
| |
| − |
| |
| − | -�--�-n�no�o-�-v�ve�er�ri�if�fy�y-�-s�ss�sl�l (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.
| |
| − |
| |
| − | -�--�-n�no�o-�-p�pa�ag�gi�in�na�at�te�e (boolean)
| |
| − |
| |
| − | Disable automatic pagination.
| |
| − |
| |
| − | -�--�-o�ou�ut�tp�pu�ut�t (string)
| |
| − |
| |
| − | The formatting style for command output.
| |
| − |
| |
| − | +�o json
| |
| − |
| |
| − | +�o text
| |
| − |
| |
| − | +�o table
| |
| − |
| |
| − | +�o yaml
| |
| − |
| |
| − | +�o yaml-stream
| |
| − |
| |
| − | -�--�-q�qu�ue�er�ry�y (string)
| |
| − |
| |
| − | A JMESPath query to use in filtering the response data.
| |
| − |
| |
| − | -�--�-p�pr�ro�of�fi�il�le�e (string)
| |
| − |
| |
| − | Use a specific profile from your credential file.
| |
| − |
| |
| − | -�--�-r�re�eg�gi�io�on�n (string)
| |
| − |
| |
| − | The region to use. Overrides config/env settings.
| |
| − |
| |
| − | -�--�-v�ve�er�rs�si�io�on�n (string)
| |
| − |
| |
| − | Display the version of this tool.
| |
| − |
| |
| − | -�--�-c�co�ol�lo�or�r (string)
| |
| − |
| |
| − | Turn on/off color output.
| |
| − |
| |
| − | +�o on
| |
| − |
| |
| − | +�o off
| |
| − |
| |
| − | +�o auto
| |
| − |
| |
| − | -�--�-n�no�o-�-s�si�ig�gn�n-�-r�re�eq�qu�ue�es�st�t (boolean)
| |
| − |
| |
| − | Do not sign requests. Credentials will not be loaded if this argument
| |
| − | is provided.
| |
| − |
| |
| − | -�--�-c�ca�a-�-b�bu�un�nd�dl�le�e (string)
| |
| − |
| |
| − | The CA certificate bundle to use when verifying SSL certificates.
| |
| − | Overrides config/env settings.
| |
| − |
| |
| − | -�--�-c�cl�li�i-�-r�re�ea�ad�d-�-t�ti�im�me�eo�ou�ut�t (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.
| |
| − |
| |
| − | -�--�-c�cl�li�i-�-c�co�on�nn�ne�ec�ct�t-�-t�ti�im�me�eo�ou�ut�t (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.
| |
| − |
| |
| − | -�--�-c�cl�li�i-�-b�bi�in�na�ar�ry�y-�-f�fo�or�rm�ma�at�t (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 f�fi�il�le�eb�b:�:/�//�/ will always be treated as binary and use the file
| |
| − | contents directly regardless of the c�cl�li�i-�-b�bi�in�na�ar�ry�y-�-f�fo�or�rm�ma�at�t setting. When
| |
| − | using f�fi�il�le�e:�:/�//�/ the file contents will need to properly formatted for the
| |
| − | configured c�cl�li�i-�-b�bi�in�na�ar�ry�y-�-f�fo�or�rm�ma�at�t.
| |
| − |
| |
| − | +�o base64
| |
| − |
| |
| − | +�o raw-in-base64-out
| |
| − |
| |
| − | -�--�-n�no�o-�-c�cl�li�i-�-p�pa�ag�ge�er�r (boolean)
| |
| − |
| |
| − | Disable cli pager for output.
| |
| − |
| |
| − | -�--�-c�cl�li�i-�-a�au�ut�to�o-�-p�pr�ro�om�mp�pt�t (boolean)
| |
| − |
| |
| − | Automatically prompt for CLI input parameters.
| |
| − |
| |
| − | -�--�-n�no�o-�-c�cl�li�i-�-a�au�ut�to�o-�-p�pr�ro�om�mp�pt�t (boolean)
| |
| − |
| |
| − | Disable automatically prompt for CLI input parameters.
| |
| − |
| |
| − | E�EX�XA�AM�MP�PL�LE�ES�S
| |
| − | Suppose you had the following config file:
| |
| − |
| |
| − | [default]
| |
| − | aws_access_key_id=default_access_key
| |
| − | aws_secret_access_key=default_secret_key
| |
| − |
| |
| − | [profile testing]
| |
| − | aws_access_key_id=testing_access_key
| |
| − | aws_secret_access_key=testing_secret_key
| |
| − | region=us-west-2
| |
| − |
| |
| − | The following commands would have the corresponding output:
| |
| − |
| |
| − | $ aws configure get aws_access_key_id
| |
| − | default_access_key
| |
| − |
| |
| − | $ aws configure get default.aws_access_key_id
| |
| − | default_access_key
| |
| − |
| |
| − | $ aws configure get aws_access_key_id --profile testing
| |
| − | testing_access_key
| |
| − |
| |
| − | $ aws configure get profile.testing.aws_access_key_id
| |
| − | testing_access_key
| |
| − |
| |
| − | $ aws configure get profile.does-not-exist
| |
| − | $
| |
| − | $ echo $?
| |
| − | 1
| |
| − |
| |
| − | GET()
| |
| − |
| |
| | | | |
| | == Related == | | == Related == |
