Response Syntax Response Elements Errors See Also

GetProfile

Returns information about the profile of the Amazon Lightsail account that makes the request. The response includes the profile type and, for accounts enrolled in the Lightsail partner program, the partner membership details.

Response Syntax


{
   "partner": { 
      "enrolledAt": number,
      "status": "string",
      "tierName": "string"
   },
   "profileType": "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.

partner

An object that describes the partner membership of the account, such as the tier of the membership, its status, and when the account was enrolled.

This parameter is returned only for accounts that have a profileType of LightsailPartner.

Type: PartnerInfo object

profileType

The type of the profile.

The following profile types are possible:

Lightsailor – The account is not enrolled in the Lightsail partner program.
LightsailPartner – The account is enrolled in the Lightsail partner program.

Type: String

Valid Values: Lightsailor | LightsailPartner

Errors

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

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

AccountSetupInProgressException

Lightsail throws this exception when an account is still in the setup in progress state.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400