IoTFleetWise / Client / register_account

register_account#

IoTFleetWise.Client.register_account(**kwargs)#

Warning

This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the CreateCampaign API operation.

You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the DeleteCampaign API operation.

If you want to delete the Timestream inline policy from the service-linked role, such as to mitigate an overly permissive policy, you must first delete any existing campaigns. Then delete the service-linked role and register your account again to enable CloudWatch metrics. For more information, see DeleteServiceLinkedRole in the Identity and Access Management API Reference.

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

    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