Contents:
Modify the specified AWS role object using the provided parameters.
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 awsRoles, see API Workflow - Manage AWS Configurations.
Version: v4
Required Permissions
At least one of the following roles is required to use this endpoint:
- Workspace admin
- Alteryx admin
Request
Request Type: PUT
Endpoint:
/v4/awsRoles/<id>
where:
| Parameter | Description |
|---|---|
<id> | Internal identifier for the AWS roles object |
Request URI - Example:
/v4/awsRoles/2
The request body contains the parameters of the awsRoles object that you wish to modify. You do not have to include parameters that are not being modified.
Request Body - IAM role ARN assignment:
The following changes the IAM role ARN for the AWS Role object.
NOTE: When an AWS role object has been created, it must be assigned to an AWS configuration object. This assignment cannot be modified after creation. You must delete the AWS role object and recreate it.
{
"role", "<my_new_iam_role_arn>"
}
Request Body - person assignment:
The following changes the person identifier for the AWS Role object.
NOTE: When an AWS role object has been created, it must be assigned to an AWS configuration object. This assignment cannot be modified after creation. You must delete the AWS role object and recreate it.
{
"personId" 4
}
You can also assign using a workspaceId identifier. For more information, see API AWSRoles Create v4.
Response
Response Status Code - Success: 200 - OK
Response Body Example:
{
"createdFrom": "api",
"id": 2,
"role": "<my_new_iam_role_arn>",
"awsConfigId": 1,
"updatedAt": "2019-07-15T23:18:59.360Z",
"createdAt": "2019-07-15T23:18:59.360Z",
"deleted_at": null
}
Reference
For more information, see API AWSRoles Get List v4.
This page has no comments.