[ aws . migrationhub-config ]
This API permits filtering on the ControlId
and HomeRegion
fields.
See also: AWS API Documentation
describe-home-region-controls
[--control-id <value>]
[--home-region <value>]
[--target <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--control-id
(string)
The
ControlID
is a unique identifier string of yourHomeRegionControl
object.
--home-region
(string)
The name of the home region you’d like to view.
--target
(structure)
The target parameter specifies the identifier to which the home region is applied, which is always of type
ACCOUNT
. It applies the home region to the currentACCOUNT
.Type -> (string)
The target type is always an
ACCOUNT
.Id -> (string)
The
TargetID
is a 12-character identifier of theACCOUNT
for which the control was created. (This must be the current account.)
Shorthand Syntax:
Type=string,Id=string
JSON Syntax:
{
"Type": "ACCOUNT",
"Id": "string"
}
--max-results
(integer)
The maximum number of filtering results to display per page.
--next-token
(string)
If a
NextToken
was returned by a previous call, more results are available. To retrieve the next page of results, make the call again using the returned token inNextToken
.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--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.
HomeRegionControls -> (list)
An array that contains your
HomeRegionControl
objects.(structure)
A home region control is an object that specifies the home region for an account, with some additional information. It contains a target (always of type
ACCOUNT
), an ID, and a time at which the home region was set.ControlId -> (string)
A unique identifier that’s generated for each home region control. It’s always a string that begins with “hrc-” followed by 12 lowercase letters and numbers.
HomeRegion -> (string)
The AWS Region that’s been set as home region. For example, “us-west-2” or “eu-central-1” are valid home regions.
Target -> (structure)
The target parameter specifies the identifier to which the home region is applied, which is always an
ACCOUNT
. It applies the home region to the currentACCOUNT
.Type -> (string)
The target type is always an
ACCOUNT
.Id -> (string)
The
TargetID
is a 12-character identifier of theACCOUNT
for which the control was created. (This must be the current account.)RequestedTime -> (timestamp)
A timestamp representing the time when the customer called
CreateHomeregionControl
and set the home region for the account.
NextToken -> (string)
If a
NextToken
was returned by a previous call, more results are available. To retrieve the next page of results, make the call again using the returned token inNextToken
.