Contents:
Get information on the specific AWS role object.
NOTE: APIs for AWS roles apply only to instances of the Designer Cloud Powered by Trifacta® platform that are hosted on AWS and configured for user mode of authentication.
For more information on how to use awsRole objects, see API Workflow - Manage AWS Configurations.
Version: v4
Required Permissions
NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/6.4/index.html#section/Authentication.
Request
Request Type: GET
Endpoint:
/v4/awsRoles/<id>
where:
| Parameter | Description |
|---|---|
<id> | Internal identifier for the AWS role object |
Request URI - Example:
/v4/awsRoles/2
Request Body:
Empty.
Response
Response Status Code - Success: 200 - OK
Response Body Example:
{
"id": 2,
"awsConfig": {
"id": 1
},
"role": "<IAM_ROLE_ARN>",
"createdFrom": "api",
"createdAt": "2019-07-15T18:39:33Z",
"updatedAt": "2019-07-15T18:39:33Z",
"deletedAt": "2019-07-15T18:39:33Z"
}
Reference
| Property | Description |
|---|---|
| id | Internal identifier of the AWS role object |
| awsConfig | Internal identifier of the AWS configuration object with which this AWS role object is associated. |
| role | The AWS IAM role ARN associated with this object |
| createdFrom | Method by which the AWS role object was created. Possible values:
|
| createdAt | Timestamp for when the AWS role object was launched |
| updatedAt | Timestamp for when the AWS role object was last updated |
| deletedAt | Timestamp for when the AWS role object was deleted |
This page has no comments.