Menu
AWS OpsWorks
API Reference (API Version 2013-02-18)

GrantAccess

Note

This action can be used only with Windows stacks.

Grants RDP access to a Windows instance for a specified time period.

Request Syntax

{ "InstanceId": "string", "ValidForInMinutes": number }

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.

InstanceId

The instance's AWS OpsWorks Stacks ID.

Type: String

Required: Yes

ValidForInMinutes

The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.

Type: Integer

Valid Range: Minimum value of 60. Maximum value of 1440.

Required: No

Response Syntax

{ "TemporaryCredential": { "InstanceId": "string", "Password": "string", "Username": "string", "ValidForInMinutes": number } }

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.

TemporaryCredential

A TemporaryCredential object that contains the data needed to log in to the instance by RDP clients, such as the Microsoft Remote Desktop Connection.

Type: TemporaryCredential object

Errors

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

ResourceNotFoundException

Indicates that a resource was not found.

HTTP Status Code: 400

ValidationException

Indicates that a request was 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: