Integrations

To learn how to set up IAM Delegated Access for your cloud storage solution, see our IAM Delegated Access docs.

Get integration ID

Use this query to get a list of all IAM integrations.

query GetIntegrations {
  iamIntegrations {
    id
    name
  }
}

Create integration

Use the createAwsIamIntegration mutation to create a Delegated Access integration between your S3 bucket and Labelbox.

Specifying the roleArn when you are creating the integration is optional.

The id returned from this createAwsIntegration mutation is the Labelbox External ID. The Labelbox AWS account ID is 340636424752.

mutation CreateIntegration {
    createAwsIamIntegration (data: { 
      name: "AWS IAM Integration" 
      roleArn: "arn:aws:iam::<AWS_ACCOUNT_ID>:role/<ROLE_NAME>"
    }) {
	id
    }
}

Validate integration

Use the validateIamIntegration mutation to ensure that the integration you set up via IAM was configured properly.

mutation CheckIntegration {
  validateIamIntegration (where: {id: "<INTEGRATION_ID>"}) {
    valid
    checks { 
      name
      success
    }
  }
}

Update integration

Use the updateAwsIamIntegration mutation to update the role ARN associated with the integration. Use the where argument to specify which integration you want to update and the data argument to specify what you want to update (i.e., roleArn or name).

mutation UpdateIntegration {
    updateAwsIamIntegration (
        data: { 
            roleArn: "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>"
            name: "<NEW_INTEGRATION_NAME>"
        },
	where: { 
            id: "<INTEGRATION_ID>" 
        }) {
            id
        }
}

Attach integration to a dataset

Use the setSignerForDataset mutation to attach an IAM integration to your dataset. Use the where argument to specify the dataset and the data argument to specify what to change.

mutation SetSignerForDataset {
    setSignerForDataset (
	data: { signerId: "<INTEGRATION_ID>" },
	where: { id: "<DATASET_ID>" }) {
	    id
	    signer {
		id
	}
    }
}

Validate dataset

When you create your dataset via the GraphQL API, you'll need to run a dataset validation yourself. Use the validateDataset mutation to do this.

This returns a payload with the status of the various checks that you can use for troubleshooting.

mutation ValidateDataset {
  validateDataset (where: {id: "<DATASET_ID>"}){
    valid
    checks {
      name
      success
    }
  }
}