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

StopProductSubscription

Stops a product subscription for a user with the specified identity provider.

Request Syntax


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

{
   "Domain": "string",
   "IdentityProvider": { ... },
   "Product": "string",
   "ProductUserArn": "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 stop 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: No

Product

The name of the user-based subscription product.

Valid values: VISUAL_STUDIO_ENTERPRISE | VISUAL_STUDIO_PROFESSIONAL | OFFICE_PROFESSIONAL_PLUS | REMOTE_DESKTOP_SERVICES

Type: String

Required: No

ProductUserArn

The Amazon Resource Name (ARN) of the product user.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-zA-Z0-9-\.]{1,510}/[a-zA-Z0-9-\.]{1,510}

Required: No

Username

The user name from the identity provider for the user.

Type: String

Required: No

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

UnprocessableEntityException

The request failed as resource was not found in desired state.

HTTP Status Code: 422

ValidationException

A parameter is not valid.

HTTP Status Code: 400