UpdateEntitlement - Amazon AppStream 2.0

UpdateEntitlement

Updates the specified entitlement.

Request Syntax

{ "AppVisibility": "string", "Attributes": [ { "Name": "string", "Value": "string" } ], "Description": "string", "Name": "string", "StackName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AppVisibility

Specifies whether all or only selected apps are entitled.

Type: String

Valid Values: ALL | ASSOCIATED

Required: No

Attributes

The attributes of the entitlement.

Type: Array of EntitlementAttribute objects

Array Members: Minimum number of 1 item.

Required: No

Description

The description of the entitlement.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Name

The name of the entitlement.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

StackName

The name of the stack with which the entitlement is associated.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

Response Syntax

{ "Entitlement": { "AppVisibility": "string", "Attributes": [ { "Name": "string", "Value": "string" } ], "CreatedTime": number, "Description": "string", "LastModifiedTime": number, "Name": "string", "StackName": "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.

Entitlement

The entitlement.

Type: Entitlement object

Errors

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

ConcurrentModificationException

An API error occurred. Wait a few minutes and try again.

HTTP Status Code: 400

EntitlementNotFoundException

The entitlement can't be found.

HTTP Status Code: 400

OperationNotPermittedException

The attempted operation is not permitted.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

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