StartProductSubscription
Starts a product subscription for a user with the specified identity provider.
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/StartProductSubscription HTTP/1.1
Content-type: application/json
{
"Domain": "string
",
"IdentityProvider": { ... },
"Product": "string
",
"Tags": {
"string
" : "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 Active Directory that contains the user for whom to start the product subscription.
Type: String
Required: No
- IdentityProvider
-
An object that specifies details for the identity provider.
Type: IdentityProvider object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- Product
-
The name of the user-based subscription product.
Valid values:
VISUAL_STUDIO_ENTERPRISE
|VISUAL_STUDIO_PROFESSIONAL
|OFFICE_PROFESSIONAL_PLUS
Type: String
Required: Yes
- Tags
-
The tags that apply to the product subscription.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Required: No
- Username
-
The user name from the identity provider of the user.
Type: String
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ProductUserSummary": {
"Domain": "string",
"IdentityProvider": { ... },
"Product": "string",
"ProductUserArn": "string",
"Status": "string",
"StatusMessage": "string",
"SubscriptionEndDate": "string",
"SubscriptionStartDate": "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.
- ProductUserSummary
-
Metadata that describes the start product subscription operation.
Type: ProductUserSummary 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: