Page tree

 

This is the latest version of the APIs.

Contents:


Get information on the specific AWS configuration object. 

NOTE: APIs for AWS configs apply only to instances of the Trifacta® platform that are hosted on AWS and configured for user mode of authentication. These configuration objects can be assigned to individual users as needed.

For more information on how to use awsConfig objects, see API Workflow - Manage AWS Configurations.


Version: 
v4

Required Permissions

NOTE: Each request to the Trifacta® platform must include authentication credentials. See API Authentication.

Request

Request Type: GET

Endpoint:

/v4/awsConfigs/<id>

where:

ParameterDescription
<id>Internal identifier for the AWS configuration object


Request URI - Example:

/v4/awsConfigs/2

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
    "extraBuckets": [
        "bucket1",
        "bucket2"
    ],
    "id": 2,
    "defaultBucket": "testing",
    "credentialProvider": "default",
    "externalId": null,
    "activeRoleId": null,
    "createdAt": "2019-04-16T19:48:47.075Z",
    "updatedAt": "2019-04-16T19:48:47.153Z",
    "credential": {
        "id": 21
    }
}

Reference

PropertyDescription
extraBucketsList of additional S3 buckets that can be accessed based on this configuration object
idInternal identifier of the AWS configuration object
defaultBucketDefault S3 bucket where assigned users can upload and write results
credentialProvider

Type of credential provider. Possible values:

  • default - AWS key/secret combo used to authenticate
  • instance - Use EC2 instance roles.
  • temporary - Credentials are issued based on the IAM role to use. See below.

For more information, see Configure for AWS.

externalId

( Trifacta Wrangler Pro only) This identifier is used to manage cross-account access in AWS. This value should not be modified.

activeRoleId
  • If temporary credential provider is used, this value is the IAM role to use for this AWS configuration.
  • If default credential provider, do not populate this value.
createdAtTimestamp for when the AWS configuration object was launched
updatedAtTimestamp for when the AWS configuration object was last updated
credential.idInternal identifier to the record for the AWS key/secret combination, if in use. This value should not be modified.

This page has no comments.