Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartAccessRequest

Starts the workflow for just-in-time node access sessions.

Request Syntax


{
   "Reason": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "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.

Reason

A brief description explaining why you are requesting access to the node.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Tags

Key-value pairs of metadata you want to assign to the access request.

Type: Array of Tag objects

Array Members: Maximum number of 1000 items.

Required: No

Targets

The node you are requesting access to.

Type: Array of Target objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: Yes

Response Syntax


{
   "AccessRequestId": "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.

AccessRequestId

The ID of the access request.

Type: String

Pattern: ^(oi)-[0-9a-f]{12}$

Errors

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

AccessDeniedException

The requester doesn't have permissions to perform the requested operation.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

ResourceNotFoundException

The specified parameter to be shared could not be found.

HTTP Status Code: 400

ServiceQuotaExceededException

The request exceeds the service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account.

QuotaCode: The quota code recognized by the AWS Service Quotas service.
ResourceId: The unique ID of the resource referenced in the failed request.
ResourceType: The resource type of the resource referenced in the failed request.
ServiceCode: The code for the AWS service that owns the quota.

HTTP Status Code: 400

ThrottlingException

The request or operation couldn't be performed because the service is throttling requests.

QuotaCode: The quota code recognized by the AWS Service Quotas service.
ServiceCode: The code for the AWS service that owns the quota.

HTTP Status Code: 400

ValidationException

The request isn't valid. Verify that you entered valid contents for the command and try again.

ReasonCode: The reason code for the invalid request.

HTTP Status Code: 400