AWS Endpoint Service Principals V2

Operations related to AWS endpoint service principals.

List all IAM Principal ARNs.

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
clusterDataCenterId
required
string <uuid>

ID of the Cluster Data Center.

Responses
200

Retrieved IAM Principal ARNs.

get/cluster-management/v2/data-sources/cluster_data_center/{clusterDataCenterId}/aws-endpoint-service-principals/v2/
Request samples
Response samples
application/json
[
  • {
    }
]

Add an IAM Principal ARN on the AWS Endpoint Service.

SecurityBasic Authentication
Request
Request Body schema: application/json
clusterDataCenterId
required
string <uuid>

The ID of the cluster data center.

principalArn
required
string^arn:aws:iam::[0-9]{12}:(root$|user\/[\w+=,.@...

The IAM Principal ARN.

Responses
202

Successfully added an IAM Principal ARNs on the AWS Endpoint Service.

post/cluster-management/v2/resources/aws-endpoint-service-principals/v2/
Request samples
application/json
{
  • "clusterDataCenterId": "f3eab841-6952-430d-ba90-1bfc3f15da10",
  • "principalArn": "arn:aws:iam::123456789012:role/role-name"
}
Response samples
application/json
{
  • "clusterDataCenterId": "f3eab841-6952-430d-ba90-1bfc3f15da10",
  • "principalArn": "arn:aws:iam::123456789012:role/role-name"
}

Retrieve a single IAM Principal ARN

Get details for a single IAM Principal ARN.

SecurityBasic Authentication
Request
path Parameters
principalId
required
string <uuid>

ID of the IAM Principal ARN.

Responses
200

Retrieved the details an IAM Principal ARN.

404

IAM Principal ARN not found.

get/cluster-management/v2/resources/aws-endpoint-service-principals/v2/{principalId}
Request samples
Response samples
application/json
{
  • "clusterDataCenterId": "f3eab841-6952-430d-ba90-1bfc3f15da10",
  • "principalArn": "arn:aws:iam::123456789012:role/role-name"
}

Delete an IAM Principal ARN

Delete an IAM Principal ARN.

SecurityBasic Authentication
Request
path Parameters
principalId
required
string <uuid>

ID of the IAM Principal ARN.

Responses
204

IAM Principal ARN successfully deleted.

404

IAM Principal ARN not found.

delete/cluster-management/v2/resources/aws-endpoint-service-principals/v2/{principalId}
Request samples
Response samples
application/json
{
  • "errors": [
    ]
}