AWS Endpoint Service Principals

Operations related to AWS endpoint service principals.

Retrieve allowed principals on AWS Endpoint Service

Retrieve all the allowed principal for accessing Endpoint Service on a specific cluster data centre. AWS principals, such as AWS accounts, IAM users, and IAM roles used to allow connection from AWS interface endpoint to the endpoint service

SecurityBasic Authentication
Request
path Parameters
clusterDataCentreId
required
string <uuid> [\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12}
Example: 6b776f1d-5b74-4b46-b813-a94b9c1282ca
Responses
200

Successfully retrieved the allowed principals

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

get/provisioning/v1/aws-endpoint-service/{clusterDataCentreId}/principals
Request samples
Response samples
application/json
{
  • "iamPrincipalARNs": [
    ]
}

Update principals of AWS Endpoint Service

Update principals of AWS Endpoint Service on a specific cluster data centre. AWS principals, such as AWS accounts, IAM users, and IAM roles used to allow connection from AWS interface endpoint to the endpoint service

SecurityBasic Authentication
Request
path Parameters
clusterDataCentreId
required
string <uuid> [\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12}
Example: 6b776f1d-5b74-4b46-b813-a94b9c1282ca
Request Body schema: application/json
required

List of principals to update

iamPrincipalARNs
Array of strings

List of IAM Principal ARNs

object
Responses
200

Successfully update the principals of AWS Endpoint Service

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

put/provisioning/v1/aws-endpoint-service/{clusterDataCentreId}/principals
Request samples
application/json
{
  • "iamPrincipalARNs": [
    ]
}
Response samples
application/json
{
  • "iamPrincipalARNs": [
    ]
}

Modify principals of AWS Endpoint Service

Modify principals of AWS Endpoint Service on a specific cluster data centre. AWS principals, such as AWS accounts, IAM users, and IAM roles used to allow connection from AWS interface endpoint to the endpoint service

SecurityBasic Authentication
Request
path Parameters
clusterDataCentreId
required
string <uuid> [\w]{8}-[\w]{4}-[\w]{4}-[\w]{4}-[\w]{12}
Example: 6b776f1d-5b74-4b46-b813-a94b9c1282ca
Request Body schema: application/json
required

List of principals to add

principalsToAdd
Array of strings

List of IAM Principal ARNs to add to AWS Endpoint Service

principalsToRemove
Array of strings

List of IAM Principal ARNs to remove from AWS Endpoint Service

object
Responses
200

Successfully modified the principals to AWS Endpoint Service

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

409

Resource conflict

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

patch/provisioning/v1/aws-endpoint-service/{clusterDataCentreId}/principals
Request samples
application/json
{
  • "principalsToAdd": [
    ],
  • "principalsToRemove": [
    ]
}
Response samples
application/json
{
  • "iamPrincipalARNs": [
    ]
}