AWS CLI Command Reference

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 . iotfleetwise ]

get-register-account-status

Description

Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud.

For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise .

Note

This API operation doesn't require input parameters.

See also: AWS API Documentation

Synopsis

  get-register-account-status
[--cli-input-json <value>]
[--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>]

Options

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

Global 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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

Output

customerAccountId -> (string)

The unique ID of the Amazon Web Services account, provided at account creation.

accountStatus -> (string)

The status of registering your account and resources. The status can be one of:

  • REGISTRATION_SUCCESS - The Amazon Web Services resource is successfully registered.
  • REGISTRATION_PENDING - Amazon Web Services IoT FleetWise is processing the registration request. This process takes approximately five minutes to complete.
  • REGISTRATION_FAILURE - Amazon Web Services IoT FleetWise can't register the AWS resource. Try again later.

timestreamRegistrationResponse -> (structure)

Information about the registered Amazon Timestream resources or errors, if any.

timestreamDatabaseName -> (string)

The name of the Timestream database.

timestreamTableName -> (string)

The name of the Timestream database table.

timestreamDatabaseArn -> (string)

The Amazon Resource Name (ARN) of the Timestream database.

timestreamTableArn -> (string)

The ARN of the Timestream database table.

registrationStatus -> (string)

The status of registering your Amazon Timestream resources. The status can be one of REGISTRATION_SUCCESS , REGISTRATION_PENDING , REGISTRATION_FAILURE .

errorMessage -> (string)

A message associated with a registration error.

iamRegistrationResponse -> (structure)

Information about the registered IAM resources or errors, if any.

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role to register.

registrationStatus -> (string)

The status of registering your IAM resource. The status can be one of REGISTRATION_SUCCESS , REGISTRATION_PENDING , REGISTRATION_FAILURE .

errorMessage -> (string)

A message associated with a registration error.

creationTime -> (timestamp)

The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).

lastModificationTime -> (timestamp)

The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).