Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

AssociateUser

Associates the user to an EC2 instance to utilize user-based subscriptions.

Note

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in AWS Billing. For more information, see Viewing your monthly charges in the AWS Billing User Guide.

Request Syntax


POST /user/AssociateUser HTTP/1.1
Content-type: application/json

{
   "Domain": "string",
   "IdentityProvider": { ... },
   "InstanceId": "string",
   "Username": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Domain

The domain name of the user.

Type: String

Required: No

IdentityProvider

The identity provider of the user.

Type: IdentityProvider object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

InstanceId

The ID of the EC2 instance, which provides user-based subscriptions.

Type: String

Required: Yes

Username

The user name from the identity provider for the user.

Type: String

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "InstanceUserSummary": { 
      "AssociationDate": "string",
      "DisassociationDate": "string",
      "Domain": "string",
      "IdentityProvider": { ... },
      "InstanceId": "string",
      "Status": "string",
      "StatusMessage": "string",
      "Username": "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.

InstanceUserSummary

Metadata that describes the associate user operation.

Type: InstanceUserSummary object

Errors

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

AccessDeniedException

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

HTTP Status Code: 400

ConflictException

The request couldn't be completed because it conflicted with the current state of the resource.

HTTP Status Code: 500

InternalServerException

An exception occurred with the service.

HTTP Status Code: 500

ResourceNotFoundException

The resource couldn't be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request failed because a service quota is exceeded.

HTTP Status Code: 400

ThrottlingException

The request was denied because of request throttling. Retry the request.

HTTP Status Code: 400

ValidationException

A parameter is not valid.

HTTP Status Code: 400