Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

RegisterAccount

Important

This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that AWS 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 AWS Identity and Access Management API Reference.

Registers your AWS account, IAM, and Amazon Timestream resources so AWS IoT FleetWise can transfer your vehicle data to the AWS Cloud. For more information, including step-by-step procedures, see Setting up AWS IoT FleetWise.

Note

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

Request Syntax


{
   "iamResources": { 
      "roleArn": "string"
   },
   "timestreamResources": { 
      "timestreamDatabaseName": "string",
      "timestreamTableName": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

iamResources

This parameter has been deprecated.

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

Type: IamResources object

Required: No

timestreamResources

This parameter has been deprecated.

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

Type: TimestreamResources object

Required: No

Response Syntax


{
   "creationTime": number,
   "iamResources": { 
      "roleArn": "string"
   },
   "lastModificationTime": number,
   "registerAccountStatus": "string",
   "timestreamResources": { 
      "timestreamDatabaseName": "string",
      "timestreamTableName": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

creationTime

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

Type: Timestamp

iamResources

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

Type: IamResources object

lastModificationTime

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

Type: Timestamp

registerAccountStatus

The status of registering your AWS account, IAM role, and Timestream resources.

Type: String

Valid Values: REGISTRATION_PENDING | REGISTRATION_SUCCESS | REGISTRATION_FAILURE

timestreamResources

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

Type: TimestreamResources object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permission to perform this action.

HTTP Status Code: 400

ConflictException

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

HTTP Status Code: 400

InternalServerException

The request couldn't be completed because the server temporarily failed.

HTTP Status Code: 500

ResourceNotFoundException

The resource wasn't found.

HTTP Status Code: 400

ThrottlingException

The request couldn't be completed due to throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400