Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . migrationhub-config ]

create-home-region-control

Description

This API sets up the home region for the calling account only.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-home-region-control
--home-region <value>
--target <value>
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--home-region (string)

The name of the home region of the calling account.

--target (structure)

The account for which this command sets up a home region control. The Target is always of type ACCOUNT .

Shorthand Syntax:

Type=string,Id=string

JSON Syntax:

{
  "Type": "ACCOUNT",
  "Id": "string"
}

--dry-run | --no-dry-run (boolean)

Optional Boolean flag to indicate whether any effect should take place. It tests whether the caller has permission to make the call.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

HomeRegionControl -> (structure)

This object is the HomeRegionControl object that's returned by a successful call to CreateHomeRegionControl .

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 current ACCOUNT .

Type -> (string)

The target type is always an ACCOUNT .

Id -> (string)

The TargetID is a 12-character identifier of the ACCOUNT 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.