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
Responses
200
Retrieved IAM Principal ARNs.
get/cluster-management/v2/data-sources/cluster_data_center/{clusterDataCenterId}/aws-endpoint-service-principals/v2/
Request samples
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
Response samples
- 200
application/json
[- {
- "clusterDataCenterId": "string",
- "iamPrincipalArns": [
- {
- "clusterDataCenterId": "f3eab841-6952-430d-ba90-1bfc3f15da10",
- "principalArn": "arn:aws:iam::123456789012:role/role-name"
}
]
}
]Add an IAM Principal ARN on the AWS Endpoint Service.
SecurityBasic Authentication
Request
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
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
application/json
{- "clusterDataCenterId": "f3eab841-6952-430d-ba90-1bfc3f15da10",
- "principalArn": "arn:aws:iam::123456789012:role/role-name"
}Response samples
- 202
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
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
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
Response samples
- 200
- 404
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
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
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
Response samples
- 404
application/json
{- "errors": [
- {
- "name": "string",
- "message": "string"
}
]
}