IoTFleetWise / Client / register_account

register_account

IoTFleetWise.Client.register_account(**kwargs)

Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so 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

An Amazon Web Services account is not the same thing as a “user account”. An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM user or an IAM role, both with credentials. A single Amazon Web Services account can, and typically does, contain many users and roles.

See also: AWS API Documentation

Request Syntax

response = client.register_account(
    timestreamResources={
        'timestreamDatabaseName': 'string',
        'timestreamTableName': 'string'
    },
    iamResources={
        'roleArn': 'string'
    }
)

Parameters:

• timestreamResources (dict) –

  [REQUIRED]

  The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.

  • timestreamDatabaseName (string) – [REQUIRED]

    The name of the registered Amazon Timestream database.

  • timestreamTableName (string) – [REQUIRED]

    The name of the registered Amazon Timestream database table.

• iamResources (dict) –

  The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.

  • roleArn (string) – [REQUIRED]

    The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream. For example, arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN.

Return type:

dict

Returns:

Response Syntax

{
    'registerAccountStatus': 'REGISTRATION_PENDING'|'REGISTRATION_SUCCESS'|'REGISTRATION_FAILURE',
    'timestreamResources': {
        'timestreamDatabaseName': 'string',
        'timestreamTableName': 'string'
    },
    'iamResources': {
        'roleArn': 'string'
    },
    'creationTime': datetime(2015, 1, 1),
    'lastModificationTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • registerAccountStatus (string) –

    The status of registering your Amazon Web Services account, IAM role, and Timestream resources.

  • timestreamResources (dict) –

    The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.

    • timestreamDatabaseName (string) –

      The name of the registered Amazon Timestream database.

    • timestreamTableName (string) –

      The name of the registered Amazon Timestream database table.

  • iamResources (dict) –

    The registered IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.

    • roleArn (string) –

      The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream. For example, arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN.

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

• IoTFleetWise.Client.exceptions.ThrottlingException

• IoTFleetWise.Client.exceptions.ValidationException

• IoTFleetWise.Client.exceptions.AccessDeniedException