[ 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 | --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]

Options

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

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.

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

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