get_register_account_status¶

IoTFleetWise.Client.get_register_account_status()¶

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

Request Syntax

response = client.get_register_account_status()

Return type

dict

Returns

Response Syntax

{
    'customerAccountId': 'string',
    'accountStatus': 'REGISTRATION_PENDING'|'REGISTRATION_SUCCESS'|'REGISTRATION_FAILURE',
    'timestreamRegistrationResponse': {
        'timestreamDatabaseName': 'string',
        'timestreamTableName': 'string',
        'timestreamDatabaseArn': 'string',
        'timestreamTableArn': 'string',
        'registrationStatus': 'REGISTRATION_PENDING'|'REGISTRATION_SUCCESS'|'REGISTRATION_FAILURE',
        'errorMessage': 'string'
    },
    'iamRegistrationResponse': {
        'roleArn': 'string',
        'registrationStatus': 'REGISTRATION_PENDING'|'REGISTRATION_SUCCESS'|'REGISTRATION_FAILURE',
        'errorMessage': 'string'
    },
    'creationTime': datetime(2015, 1, 1),
    'lastModificationTime': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- 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 (dict) --
  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 (dict) --
  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 (datetime) --
  The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).
- lastModificationTime (datetime) --
  The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).

Exceptions

IoTFleetWise.Client.exceptions.ResourceNotFoundException
IoTFleetWise.Client.exceptions.InternalServerException
IoTFleetWise.Client.exceptions.ThrottlingException
IoTFleetWise.Client.exceptions.ValidationException
IoTFleetWise.Client.exceptions.AccessDeniedException

Table Of Contents

get_register_account_status¶