GetRegisterAccountStatus - AWS IoT FleetWise

GetRegisterAccountStatus

Retrieves information about the status of registering your AWS account, IAM, and Amazon Timestream resources so that 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

This API operation doesn't require input parameters.

Response Syntax

{ "accountStatus": "string", "creationTime": number, "customerAccountId": "string", "iamRegistrationResponse": { "errorMessage": "string", "registrationStatus": "string", "roleArn": "string" }, "lastModificationTime": number, "timestreamRegistrationResponse": { "errorMessage": "string", "registrationStatus": "string", "timestreamDatabaseArn": "string", "timestreamDatabaseName": "string", "timestreamTableArn": "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.

accountStatus

The status of registering your account and resources. The status can be one of:

  • REGISTRATION_SUCCESS - The AWS resource is successfully registered.

  • REGISTRATION_PENDING - AWS IoT FleetWise is processing the registration request. This process takes approximately five minutes to complete.

  • REGISTRATION_FAILURE - AWS IoT FleetWise can't register the AWS resource. Try again later.

Type: String

Valid Values: REGISTRATION_PENDING | REGISTRATION_SUCCESS | REGISTRATION_FAILURE

creationTime

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

Type: Timestamp

customerAccountId

The unique ID of the AWS account, provided at account creation.

Type: String

iamRegistrationResponse

Information about the registered IAM resources or errors, if any.

Type: IamRegistrationResponse object

lastModificationTime

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

Type: Timestamp

timestreamRegistrationResponse

Information about the registered Amazon Timestream resources or errors, if any.

Type: TimestreamRegistrationResponse 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

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: