API Reference

This section provides a complete reference for the Spatial Data Management on AWS REST API (version 2025-04-18). The API provides comprehensive spatial data organization, storage, and collaboration capabilities. You can organize spatial assets into libraries and projects, manage access controls, and integrate with external data sources through connectors.

Important

All endpoints in this reference use the /iam path prefix and require AWS IAM (Signature Version 4) authentication. For setup instructions, see API Authentication.

Base URL

The API base URL is available from the SpatialDataManagementApiEndpoint parameter in AWS Systems Manager Parameter Store, or from the AWS CloudFormation stack outputs after deployment. All endpoints below are relative to this base URL and are prefixed with /iam.

Libraries

GET /iam/libraries

Operation ID: ListLibraries

Retrieves a paginated list of all libraries accessible to the authenticated user. Libraries are organizational containers that hold projects, assets, and templates. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response

Responses

200

Success

Property	Type	Description
nextToken	String	—
libraries	Array of Library	List of libraries accessible to the user

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}

Operation ID: GetLibrary

Retrieves detailed information about a specific library. Returns library metadata including storage configuration, creation details, and access permissions.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
libraryId	String	—
libraryName	String	—
storageConfig	Object	S3 storage configuration defining where library data is stored
storageConfig.defaultS3BucketName	String	Default S3 bucket name for library storage
storageConfig.defaultRootS3Prefix	String	Default root S3 prefix for organizing library data

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Projects

GET /iam/libraries/{libraryId}/projects

Operation ID: ListProjects

Retrieves a paginated list of projects resources. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response
principalId	query	String	No	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Responses

200

Success

Property	Type	Description
nextToken	String	—
projects	Array of Project	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

POST /iam/libraries/{libraryId}/projects

Operation ID: CreateProject

Creates a new project resource with the specified configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$

Request Body

Property	Type	Required	Description
projectName	String	Yes	—
projectConfig	Object	No	Configuration settings for project.
projectConfig.name	String	No	—
projectConfig.permittedTemplateIds	Array of String	No	—
projectConfig.description	String	No	—
projectConfig.thumbnailHash	String	No	—
projectConfig.allowNonTemplatedAssets	Boolean	No	—
projectConfig.s3BucketName	String	No	—
projectConfig.rootPrefix	String	No	—
projectConfig.latitude	Number	No	—
projectConfig.longitude	Number	No	—
projectConfig.place	String	No	—
projectConfig.metadata	Object	No	—
projectThumbnailObjectKey	String	No	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
libraryId	String	—
projectId	String	—
projectName	String	—
assetCount	Number	—
fileCount	Number	—
totalSize	Number	—
s3BucketName	String	—
rootPrefix	String	—
manifestPrefix	String	—
thumbnailObjectKey	String	—
thumbnailUrl	String	—
permittedTemplateIds	Array of String	—
allowNonTemplatedAssets	Boolean	—
description	String	—
metadataAttributes	Array of MetadataAttribute	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

GET /iam/libraries/{libraryId}/projects/{projectId}

Operation ID: GetProject

Retrieves detailed information about a specific project resource.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
libraryId	String	—
projectId	String	—
projectName	String	—
assetCount	Number	—
fileCount	Number	—
totalSize	Number	—
s3BucketName	String	—
rootPrefix	String	—
manifestPrefix	String	—
thumbnailObjectKey	String	—
thumbnailUrl	String	—
permittedTemplateIds	Array of String	—
allowNonTemplatedAssets	Boolean	—
description	String	—
metadataAttributes	Array of MetadataAttribute	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

PUT /iam/libraries/{libraryId}/projects/{projectId}

Operation ID: UpdateProject

Updates an existing project resource configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$

Request Body

Property	Type	Required	Description
projectName	String	No	—
projectConfig	Object	No	Configuration settings for project.
projectConfig.name	String	No	—
projectConfig.permittedTemplateIds	Array of String	No	—
projectConfig.description	String	No	—
projectConfig.thumbnailHash	String	No	—
projectConfig.allowNonTemplatedAssets	Boolean	No	—
projectConfig.s3BucketName	String	No	—
projectConfig.rootPrefix	String	No	—
projectConfig.latitude	Number	No	—
projectConfig.longitude	Number	No	—
projectConfig.place	String	No	—
projectConfig.metadata	Object	No	—
projectThumbnailObjectKey	String	No	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
libraryId	String	—
projectId	String	—
projectName	String	—
assetCount	Number	—
fileCount	Number	—
totalSize	Number	—
s3BucketName	String	—
rootPrefix	String	—
manifestPrefix	String	—
thumbnailObjectKey	String	—
thumbnailUrl	String	—
permittedTemplateIds	Array of String	—
allowNonTemplatedAssets	Boolean	—
description	String	—
metadataAttributes	Array of MetadataAttribute	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

DELETE /iam/libraries/{libraryId}/projects/{projectId}

Operation ID: DeleteProject

Deletes a project resource and all its associated data. This operation is irreversible.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$

Responses

200

Success

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

GET /iam/libraries/{libraryId}/projects/{projectId}/asset-template-associations

Operation ID: ListProjectAssetTemplateAssociations

Retrieves a paginated list of project asset template associations. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response
status	query	String	No	—

Responses

200

Success

Property	Type	Description
nextToken	String	—
associations	Array of ProjectTemplateAssociationWithTemplate	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

POST /iam/libraries/{libraryId}/projects/{projectId}/asset-template-associations

Operation ID: RequestAssetTemplateAssociation

Requests an asset template association for a project.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$

Request Body

Property	Type	Required	Description
templateId	String	Yes	—

Responses

200

Success

Property	Type	Description
associationType	AssociationType	—
status	AssociationStatus	—
requestedBy	String	—
requestedAt	Number	—
reviewedBy	String	—
reviewedAt	Number	—
sourceResourceId	String	—
targetResourceId	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

GET /iam/libraries/{libraryId}/projects/{projectId}/asset-template-associations/{templateId}

Operation ID: GetAssetTemplateAssociation

Retrieves detailed information about a specific asset template association.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
associationType	AssociationType	—
status	AssociationStatus	—
requestedBy	String	—
requestedAt	Number	—
reviewedBy	String	—
reviewedAt	Number	—
sourceResourceId	String	—
targetResourceId	String	—
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
libraryId	String	—
assetTemplateId	String	—
assetTemplateName	String	—
assetTemplateConfig	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

DELETE /iam/libraries/{libraryId}/projects/{projectId}/asset-template-associations/{templateId}

Operation ID: DeleteAssetTemplateAssociation

Deletes an asset template association resource and all its associated data. This operation is irreversible.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$

Responses

200

Success

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

POST /iam/libraries/{libraryId}/projects/{projectId}/asset-templates/{templateId}/connectors/{connectorId}/verify

Operation ID: VerifyProjectConnectorRelationship

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
result	Boolean	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets

Operation ID: ListAssets

Retrieves a paginated list of assets resources. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response
assetName	query	String	No	—
assetState	query	AssetState	No	—
statusCode	query	ResourceStatus	No	—

Responses

200

Success

Property	Type	Description
nextToken	String	—
assets	Array of Asset	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

POST /iam/libraries/{libraryId}/projects/{projectId}/assets

Operation ID: CreateAsset

Creates a new asset resource with the specified configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$

Request Body

Property	Type	Required	Description
assetName	String	Yes	—
assetId	String	Yes	—
manifestHash	String	No	—
manifestObjectKey	String	No	—
sourceAsset	Object	No	—
sourceAsset.assetId	String	Yes	—
sourceAsset.projectId	String	Yes	—
sourceAsset.libraryId	String	Yes	—
mergeAssets	Array of AssetReference	No	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
assetId	String	—
assetName	String	—
projectId	String	—
libraryId	String	—
assetState	AssetState	—
fileCount	Number	—
totalSize	Number	—
thumbnailUrl	String	—
thumbnailObjectKey	String	—
attributes	Array of Attribute	—
manifestHash	String	—
statusCode	ResourceStatus	—
statusMessage	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}

Operation ID: GetAsset

Retrieves detailed information about a specific asset resource.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
assetId	String	—
assetName	String	—
projectId	String	—
libraryId	String	—
assetState	AssetState	—
fileCount	Number	—
totalSize	Number	—
thumbnailUrl	String	—
thumbnailObjectKey	String	—
attributes	Array of Attribute	—
manifestHash	String	—
statusCode	ResourceStatus	—
statusMessage	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

PUT /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}

Operation ID: UpdateAsset

Updates an existing asset resource configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$

Request Body

Property	Type	Required	Description
uploadState	UploadState	No	—
assetState	UserUpdatableAssetState	No	—
manifestHash	String	No	—
manifestObjectKey	String	No	—
activeVersionId	String	No	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
assetId	String	—
assetName	String	—
projectId	String	—
libraryId	String	—
assetState	AssetState	—
fileCount	Number	—
totalSize	Number	—
thumbnailUrl	String	—
thumbnailObjectKey	String	—
attributes	Array of Attribute	—
manifestHash	String	—
statusCode	ResourceStatus	—
statusMessage	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

DELETE /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}

Operation ID: DeleteAsset

Deletes an asset resource and all its associated data. This operation is irreversible.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$
force	query	Boolean	No	—

Responses

200

Success

Property	Type	Description
assetState	AssetState	—
message	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

POST /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/asset-templates/{templateId}/connectors/{connectorId}/trigger

Operation ID: TriggerConnectorOnAsset

Triggers a connector on asset processing or validation workflow.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$
fileId	query	String	No	Unique identifier for the file

Responses

200

Success

Property	Type	Description
result	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

POST /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/asset-templates/{templateId}/connectors/{connectorId}/verify

Operation ID: VerifyAssetConnectorRelationship

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$
fileId	query	String	No	Pattern: ^file-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
result	Boolean	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/attributes

Operation ID: ListAssetAttributes

Retrieves a paginated list of asset attributes. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
attributes	Array of Attribute	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

POST /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/connectors/{connectorId}/trigger

Operation ID: TriggerConnectorOnAssetDirect

Triggers a connector on asset (direct) processing or validation workflow.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$
fileId	query	String	No	Unique identifier for the file

Responses

200

Success

Property	Type	Description
result	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/credentials

Operation ID: GetAssetCredentials

Retrieves detailed information about asset credentials.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$
operation	query	AccessRequestOperation	Yes	—
location	query	AssetAccessLocation	Yes	—
requestType	query	CredentialVendingRequestType	No	—
expirationDuration	query	Number	No	—
fileInfo	query	String	No	—

Responses

200

Success

Property	Type	Description
credentials	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/files

Operation ID: ListFiles

Retrieves a paginated list of files resources. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response
root	query	String	No	—
includeHiddenFiles	query	Boolean	No	—
includePreviews	query	Boolean	No	—
includeLocations	query	Boolean	No	—

Responses

200

Success

Property	Type	Description
nextToken	String	—
files	Array of File	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/files/{fileIdOrPathId}

Operation ID: GetFile

Retrieves detailed information about a specific file resource.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$
fileIdOrPathId	path	String	Yes	Pattern: ^(file|path)-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
fileId	String	—
pathId	String	—
assetId	String	—
path	String	—
mtime	Number	—
addedAt	Number	—
size	Number	—
objectKey	String	—
hash	String	—
state	FileState	—
analysisState	AnalysisState	—
hasAttributeSuggestions	Boolean	—
versionId	String	—
suggestedMetadataAttributes	Array of Attribute	—
metadataAttributes	Array of Attribute	—
location	Object	—
location.latitude	Number	—
location.longitude	Number	—
location.place	String	—
location.geoJson	String	—
location.aabb	String	—
url	String	—
previews	Array of FilePreview	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/files/{fileIdOrPathId}/content

Operation ID: GetFileContent

Retrieves the content of a specific file.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$
fileIdOrPathId	path	String	Yes	Pattern: ^(file|path)-[a-fA-F0-9]{32}$

Responses

200

Success

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/files/{fileIdOrPathId}/versions

Operation ID: ListFileVersions

Retrieves a paginated list of file versions. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$
fileIdOrPathId	path	String	Yes	Pattern: ^(file|path)-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
versions	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/files/{fileIdOrPathId}/versions/{versionId}

Operation ID: GetFileVersion

Retrieves detailed information about a specific file version.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$
fileIdOrPathId	path	String	Yes	Pattern: ^(file|path)-[a-fA-F0-9]{32}$
versionId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}-version-[1-9][0-9]*$

Responses

200

Success

Property	Type	Description
fileId	String	—
pathId	String	—
assetId	String	—
path	String	—
mtime	Number	—
addedAt	Number	—
size	Number	—
objectKey	String	—
hash	String	—
state	FileState	—
analysisState	AnalysisState	—
hasAttributeSuggestions	Boolean	—
versionId	String	—
suggestedMetadataAttributes	Array of Attribute	—
metadataAttributes	Array of Attribute	—
location	Object	—
location.latitude	Number	—
location.longitude	Number	—
location.place	String	—
location.geoJson	String	—
location.aabb	String	—
url	String	—
previews	Array of FilePreview	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/multipart-upload-data

Operation ID: GetAssetMultipartUploadData

Retrieves detailed information about asset multipart upload data.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
assetId	String	—
projectId	String	—
uploadState	UploadState	—
s3BucketName	String	—
multipartUploadData	Object	—
multipartUploadData.multipartUploadId	String	—
multipartUploadData.s3UploadKey	String	—
multipartUploadData.filePath	String	—
multipartUploadData.fileSize	Number	—
multipartUploadData.completedParts	Array of UploadPart	—
multipartUploadData.partsSize	Number	—
multipartUploadData.totalParts	Number	—
multipartUploadData.lastCompletedPartNumber	Number	—
multipartUploadData.lastModified	Number	—
uploadedFiles	Array of FileLocation	—
filesToUpload	Array of FileLocation	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

PUT /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/multipart-upload-data

Operation ID: UpdateAssetMultipartUploadData

Updates an existing asset multipart upload data configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$

Request Body

Property	Type	Required	Description
multipartUploadData	Object	Yes	—
multipartUploadData.multipartUploadId	String	No	—
multipartUploadData.s3UploadKey	String	No	—
multipartUploadData.filePath	String	No	—
multipartUploadData.fileSize	Number	No	—
multipartUploadData.completedParts	Array of UploadPart	No	—
multipartUploadData.partsSize	Number	No	—
multipartUploadData.totalParts	Number	No	—
multipartUploadData.lastCompletedPartNumber	Number	No	—
multipartUploadData.lastModified	Number	No	—

Responses

200

Success

Property	Type	Description
assetId	String	—
projectId	String	—
multipartUploadData	Object	—
multipartUploadData.multipartUploadId	String	—
multipartUploadData.s3UploadKey	String	—
multipartUploadData.filePath	String	—
multipartUploadData.fileSize	Number	—
multipartUploadData.completedParts	Array of UploadPart	—
multipartUploadData.partsSize	Number	—
multipartUploadData.totalParts	Number	—
multipartUploadData.lastCompletedPartNumber	Number	—
multipartUploadData.lastModified	Number	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/suggested-attributes

Operation ID: ListAssetSuggestedAttributes

Retrieves a paginated list of asset suggested attributes. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
suggestions	Array of FileTypeSuggestion	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/versions

Operation ID: ListAssetVersions

Retrieves a paginated list of asset versions. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
versions	Array of AssetVersion	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/assets/{assetId}/versions/{versionId}/files

Operation ID: ListFilesForAssetVersion

Retrieves a paginated list of files for an asset version. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
assetId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}$
versionId	path	String	Yes	Pattern: ^asset-[a-fA-F0-9]{32}-version-[1-9][0-9]*$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response
root	query	String	No	—
includeHiddenFiles	query	Boolean	No	—
includePreviews	query	Boolean	No	—
includeLocations	query	Boolean	No	—
includeChanges	query	Boolean	No	—

Responses

200

Success

Property	Type	Description
nextToken	String	—
files	Array of File	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

POST /iam/libraries/{libraryId}/projects/{projectId}/connectors/{connectorId}/trigger

Operation ID: TriggerConnectorOnProjectDirect

Triggers a connector on project (direct) processing or validation workflow.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
result	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/credentials

Operation ID: GetProjectCredentials

Retrieves project credentials.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
operation	query	ProjectAccessOperation	Yes	—
location	query	ProjectAccessLocation	Yes	—
requestType	query	CredentialVendingRequestType	No	—
expirationDuration	query	Number	No	—
fileInfo	query	String	No	—

Responses

200

Success

Property	Type	Description
credentials	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/known-attributes

Operation ID: GetProjectKnownAttributes

Retrieves the known attributes for a specific project.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$

Responses

200

Success

Property	Type	Description
attributes	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/members

Operation ID: ListProjectMembers

Retrieves a paginated list of project members. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
principalType	query	PrincipalType	Yes	—
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response

Responses

200

Success

Property	Type	Description
members	Array of Member	—
nextToken	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
parameterName	String	—
parameterValue	String	—
allowedValues	Array of String	—

GET /iam/libraries/{libraryId}/projects/{projectId}/members/{principalId}

Operation ID: GetProjectMember

Retrieves detailed information about a specific project member.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$
principalType	query	PrincipalType	No	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
resourceId	ResourceId	—
principalId	String	—
principalType	PrincipalType	—
membershipLevel	MembershipLevel	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
parameterName	String	—
parameterValue	String	—
allowedValues	Array of String	—

POST /iam/libraries/{libraryId}/projects/{projectId}/members/{principalId}

Operation ID: AddProjectMember

Adds a new member to the project with specified access level. Members can be users or groups with roles: OWNER, MANAGER, CONTRIBUTOR, or VIEWER.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Request Body

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—
principalType	PrincipalType	Yes	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
resourceId	ResourceId	—
principalId	String	—
principalType	PrincipalType	—
membershipLevel	MembershipLevel	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

PUT /iam/libraries/{libraryId}/projects/{projectId}/members/{principalId}

Operation ID: UpdateProjectMember

Updates an existing project member configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Request Body

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
resourceId	ResourceId	—
principalId	String	—
principalType	PrincipalType	—
membershipLevel	MembershipLevel	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

DELETE /iam/libraries/{libraryId}/projects/{projectId}/members/{principalId}

Operation ID: DeleteProjectMember

Deletes a project member resource and all its associated data. This operation is irreversible.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Responses

200

Success

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

GET /iam/libraries/{libraryId}/projects/{projectId}/permissions

Operation ID: GetProjectPermissions

Retrieves project permissions.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$

Responses

200

Success

Property	Type	Description
permissions	Array of String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Assets

GET /iam/libraries/{libraryId}/assets

Operation ID: ListLibraryAssets

Retrieves a paginated list of library assets. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response
assetState	query	AssetState	No	—

Responses

200

Success

Property	Type	Description
nextToken	String	—
assets	Array of Asset	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Asset Templates

GET /iam/libraries/{libraryId}/asset-templates

Operation ID: ListAssetTemplates

Retrieves a paginated list of assettemplates resources. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response
permittedConnectorIds	query	String	No	—
preview	query	Boolean	No	—

Responses

200

Success

Property	Type	Description
nextToken	String	—
templates	Array of AssetTemplateMinimal	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

POST /iam/libraries/{libraryId}/asset-templates

Operation ID: CreateAssetTemplate

Creates a new assettemplate resource with the specified configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$

Request Body

Property	Type	Required	Description
assetTemplateConfig	Object	Yes	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
libraryId	String	—
assetTemplateId	String	—
assetTemplateName	String	—
assetTemplateConfig	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/asset-templates/{templateId}

Operation ID: GetAssetTemplate

Retrieves detailed information about a specific assettemplate resource.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
libraryId	String	—
assetTemplateId	String	—
assetTemplateName	String	—
assetTemplateConfig	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

PUT /iam/libraries/{libraryId}/asset-templates/{templateId}

Operation ID: UpdateAssetTemplate

Updates an existing assettemplate resource configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$

Request Body

Property	Type	Required	Description
assetTemplateConfig	Object	Yes	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
libraryId	String	—
assetTemplateId	String	—
assetTemplateName	String	—
assetTemplateConfig	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

DELETE /iam/libraries/{libraryId}/asset-templates/{templateId}

Operation ID: DeleteAssetTemplate

Deletes an asset template resource and all its associated data. This operation is irreversible.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$

Responses

200

Success

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/asset-templates/{templateId}/assets

Operation ID: ListAssetTemplateAssets

Retrieves a paginated list of asset template assets. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
projectId	query	String	No	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$

Responses

200

Success

Property	Type	Description
assets	Object	—
hiddenAssetsCount	Number	—
totalAssetsCount	Number	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/asset-templates/{templateId}/connector-associations

Operation ID: ListAssetTemplateConnectorAssociations

Retrieves a paginated list of asset template connector associations. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response
status	query	String	No	—

Responses

200

Success

Property	Type	Description
nextToken	String	—
associations	Array of TemplateConnectorAssociationDetail	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

POST /iam/libraries/{libraryId}/asset-templates/{templateId}/connector-associations

Operation ID: RequestConnectorAssociation

Requests an association between resources. Enables connector functionality.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$

Request Body

Property	Type	Required	Description
connectorId	String	Yes	—

Responses

200

Success

Property	Type	Description
associationType	AssociationType	—
status	AssociationStatus	—
requestedBy	String	—
requestedAt	Number	—
reviewedBy	String	—
reviewedAt	Number	—
sourceResourceId	String	—
targetResourceId	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

DELETE /iam/libraries/{libraryId}/asset-templates/{templateId}/connector-associations/{connectorId}

Operation ID: DeleteConnectorAssociation

Deletes a connector association resource and all its associated data. This operation is irreversible.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$

Responses

200

Success

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

GET /iam/libraries/{libraryId}/asset-templates/{templateId}/connectors/{connectorId}/resources

Operation ID: GetConnectorResourcesViaAssetTemplate

Retrieves connector resources via an asset template.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
resources	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/asset-templates/{templateId}/members

Operation ID: ListAssetTemplateMembers

Retrieves a paginated list of asset template members. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
principalType	query	PrincipalType	Yes	—
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response

Responses

200

Success

Property	Type	Description
members	Array of Member	—
nextToken	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/asset-templates/{templateId}/members/{principalId}

Operation ID: GetAssetTemplateMember

Retrieves detailed information about a specific asset template member.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$
principalType	query	PrincipalType	No	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
resourceId	ResourceId	—
principalId	String	—
principalType	PrincipalType	—
membershipLevel	MembershipLevel	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

POST /iam/libraries/{libraryId}/asset-templates/{templateId}/members/{principalId}

Operation ID: AddAssetTemplateMember

Adds a new member to the assettemplate with specified access level. Members can be users or groups with roles: OWNER, MANAGER, CONTRIBUTOR, or VIEWER.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Request Body

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—
principalType	PrincipalType	Yes	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
resourceId	ResourceId	—
principalId	String	—
principalType	PrincipalType	—
membershipLevel	MembershipLevel	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

PUT /iam/libraries/{libraryId}/asset-templates/{templateId}/members/{principalId}

Operation ID: UpdateAssetTemplateMember

Updates an existing asset template member configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Request Body

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
resourceId	ResourceId	—
principalId	String	—
principalType	PrincipalType	—
membershipLevel	MembershipLevel	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

DELETE /iam/libraries/{libraryId}/asset-templates/{templateId}/members/{principalId}

Operation ID: DeleteAssetTemplateMember

Deletes an asset template member resource and all its associated data. This operation is irreversible.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Responses

200

Success

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/asset-templates/{templateId}/permissions

Operation ID: GetAssetTemplatePermissions

Retrieves asset template permissions.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
permissions	Array of String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/asset-templates/{templateId}/project-associations

Operation ID: ListAssetTemplateProjectAssociations

Retrieves a paginated list of asset template project associations. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response

Responses

200

Success

Property	Type	Description
nextToken	String	—
associations	Array of ProjectAssociationDetail	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

PUT /iam/libraries/{libraryId}/asset-templates/{templateId}/project-associations/{projectId}

Operation ID: UpdateAssetTemplateProjectAssociation

Updates an existing asset template project association configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$
projectId	path	String	Yes	Pattern: ^project-[a-fA-F0-9]{32}(-[a-fA-F0-9]{32})?$

Request Body

Property	Type	Required	Description
status	AssociationStatus	Yes	—

Responses

200

Success

Property	Type	Description
associationType	AssociationType	—
status	AssociationStatus	—
requestedBy	String	—
requestedAt	Number	—
reviewedBy	String	—
reviewedAt	Number	—
sourceResourceId	String	—
targetResourceId	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Connectors

GET /iam/libraries/{libraryId}/connectors

Operation ID: ListConnectors

Retrieves a paginated list of connectors resources. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response
direction	query	ConnectorDirection	No	—
providingResourceType	query	String	No	—
enabled	query	Boolean	No	—
default	query	Boolean	No	—
supportsExistingResource	query	Boolean	No	—
principalId	query	String	No	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Responses

200

Success

Property	Type	Description
nextToken	String	—
connectors	Array of ConnectorMinimal	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

POST /iam/libraries/{libraryId}/connectors

Operation ID: CreateConnector

Creates a new connector resource with the specified configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$

Request Body

Property	Type	Required	Description
connectorConfig	Object	Yes	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
libraryId	String	—
connectorId	String	—
connectorName	String	—
connectorType	ConnectorType	—
direction	ConnectorDirection	—
enabled	Boolean	—
default	Boolean	—
connectorConfig	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/connectors/{connectorId}

Operation ID: GetConnector

Retrieves detailed information about a specific connector resource.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
libraryId	String	—
connectorId	String	—
connectorName	String	—
connectorType	ConnectorType	—
direction	ConnectorDirection	—
enabled	Boolean	—
default	Boolean	—
connectorConfig	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

PUT /iam/libraries/{libraryId}/connectors/{connectorId}

Operation ID: UpdateConnector

Updates an existing connector resource configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$

Request Body

Property	Type	Required	Description
connectorName	String	Yes	—
connectorType	ConnectorType	Yes	—
direction	ConnectorDirection	Yes	—
enabled	Boolean	Yes	—
connectorConfig	Object	Yes	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
libraryId	String	—
connectorId	String	—
connectorName	String	—
connectorType	ConnectorType	—
direction	ConnectorDirection	—
enabled	Boolean	—
default	Boolean	—
connectorConfig	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

DELETE /iam/libraries/{libraryId}/connectors/{connectorId}

Operation ID: DeleteConnector

Deletes a connector resource and all its associated data. This operation is irreversible.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$

Responses

200

Success

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/connectors/{connectorId}/asset-template-associations

Operation ID: ListConnectorAssetTemplateAssociations

Retrieves a paginated list of connector asset template associations. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response

Responses

200

Success

Property	Type	Description
nextToken	String	—
associations	Array of AssetTemplateAssociationDetail	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

PUT /iam/libraries/{libraryId}/connectors/{connectorId}/asset-template-associations/{templateId}

Operation ID: UpdateConnectorAssetTemplateAssociation

Updates an existing connector asset template association configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$
templateId	path	String	Yes	Pattern: ^template-[a-fA-F0-9]{32}$

Request Body

Property	Type	Required	Description
status	AssociationStatus	Yes	—

Responses

200

Success

Property	Type	Description
associationType	AssociationType	—
status	AssociationStatus	—
requestedBy	String	—
requestedAt	Number	—
reviewedBy	String	—
reviewedAt	Number	—
sourceResourceId	String	—
targetResourceId	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

GET /iam/libraries/{libraryId}/connectors/{connectorId}/members

Operation ID: ListConnectorMembers

Retrieves a paginated list of connector members. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$
principalType	query	PrincipalType	Yes	—
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response

Responses

200

Success

Property	Type	Description
members	Array of Member	—
nextToken	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
parameterName	String	—
parameterValue	String	—
allowedValues	Array of String	—

GET /iam/libraries/{libraryId}/connectors/{connectorId}/members/{principalId}

Operation ID: GetConnectorMember

Retrieves detailed information about a specific connector member.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$
principalType	query	PrincipalType	No	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
resourceId	ResourceId	—
principalId	String	—
principalType	PrincipalType	—
membershipLevel	MembershipLevel	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
parameterName	String	—
parameterValue	String	—
allowedValues	Array of String	—

POST /iam/libraries/{libraryId}/connectors/{connectorId}/members/{principalId}

Operation ID: AddConnectorMember

Adds a new member to the connector with specified access level. Members can be users or groups with roles: OWNER, MANAGER, CONTRIBUTOR, or VIEWER.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Request Body

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—
principalType	PrincipalType	Yes	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
resourceId	ResourceId	—
principalId	String	—
principalType	PrincipalType	—
membershipLevel	MembershipLevel	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

PUT /iam/libraries/{libraryId}/connectors/{connectorId}/members/{principalId}

Operation ID: UpdateConnectorMember

Updates an existing connector member configuration.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Request Body

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
resourceId	ResourceId	—
principalId	String	—
principalType	PrincipalType	—
membershipLevel	MembershipLevel	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

DELETE /iam/libraries/{libraryId}/connectors/{connectorId}/members/{principalId}

Operation ID: DeleteConnectorMember

Deletes a connector member resource and all its associated data. This operation is irreversible.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Responses

200

Success

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

GET /iam/libraries/{libraryId}/connectors/{connectorId}/permissions

Operation ID: GetConnectorPermissions

Retrieves connector permissions.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
permissions	Array of String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/connectors/{connectorId}/resources

Operation ID: GetConnectorResources

Retrieves detailed information about connector resources.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
connectorId	path	String	Yes	Pattern: ^connector-[a-fA-F0-9]{32}$
resourceType	query	String	No	—
attributeName	query	String	No	—

Responses

200

Success

Property	Type	Description
resources	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Available Asset Templates

GET /iam/libraries/{libraryId}/available-asset-templates

Operation ID: ListAvailableAssetTemplates

Retrieves a paginated list of available asset templates. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response
permittedConnectorIds	query	String	No	—

Responses

200

Success

Property	Type	Description
nextToken	String	—
templates	Array of AssetTemplateMinimal	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Available Connectors

GET /iam/libraries/{libraryId}/available-connectors

Operation ID: ListAvailableConnectors

Retrieves a paginated list of available connectors. Results are sorted by creation date in descending order.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response
direction	query	ConnectorDirection	No	—
providingResourceType	query	String	No	—
enabled	query	Boolean	No	—
default	query	Boolean	No	—
supportsExistingResource	query	Boolean	No	—
principalId	query	String	No	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Responses

200

Success

Property	Type	Description
nextToken	String	—
connectors	Array of ConnectorMinimal	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Members

GET /iam/libraries/{libraryId}/members

Operation ID: ListLibraryMembers

Retrieves a paginated list of all members with access to the library. Includes member details such as principal ID, type, and membership level.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
principalType	query	PrincipalType	Yes	—
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response

Responses

200

Success

Property	Type	Description
members	Array of Member	—
nextToken	String	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

GET /iam/libraries/{libraryId}/members/{principalId}

Operation ID: GetLibraryMember

Retrieves detailed information about a specific library member. Returns the member’s access level and metadata.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
principalId	path	String	Yes	Principal identifier (user or group ID) Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$
principalType	query	PrincipalType	No	Type of principal (USER or GROUP)

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
resourceId	ResourceId	—
principalId	String	—
principalType	PrincipalType	—
membershipLevel	MembershipLevel	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

POST /iam/libraries/{libraryId}/members/{principalId}

Operation ID: AddLibraryMember

Adds a new member to a library with specified access level. Members can be users or groups with roles: OWNER, MANAGER, CONTRIBUTOR, or VIEWER. Only library OWNERS and MANAGERS can add new members.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
principalId	path	String	Yes	Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Request Body

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—
principalType	PrincipalType	Yes	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
resourceId	ResourceId	—
principalId	String	—
principalType	PrincipalType	—
membershipLevel	MembershipLevel	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—
errorCode	String	—
context	Object	—

PUT /iam/libraries/{libraryId}/members/{principalId}

Operation ID: UpdateLibraryMember

Updates the membership level of an existing library member. Can change roles between OWNER, MANAGER, CONTRIBUTOR, and VIEWER.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
principalId	path	String	Yes	Principal identifier to update Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Request Body

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—

Responses

200

Success

Property	Type	Description
createdAt	Number	—
updatedAt	Number	—
createdBy	String	—
updatedBy	String	—
resourceId	ResourceId	—
principalId	String	—
principalType	PrincipalType	—
membershipLevel	MembershipLevel	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

DELETE /iam/libraries/{libraryId}/members/{principalId}

Operation ID: DeleteLibraryMember

Removes a member’s access to the library. The member will no longer be able to access any resources within this library.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
principalId	path	String	Yes	Principal identifier to remove Pattern: ^(arn:aws:[a-zA-Z0-9-]+:[a-zA-Z0-9-]:[0-9]:[a-zA-Z0-9-/:.]+|[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|system|[a-zA-Z0-9+=,.@-]+)$

Responses

200

Success

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Permissions

GET /iam/libraries/{libraryId}/permissions

Operation ID: GetLibraryPermissions

Retrieves the permission structure for a library. Shows what actions the current user can perform on this library resource.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
permissions	Array of String	Permission structure showing allowed actions

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Search Assets

POST /iam/libraries/{libraryId}/search-assets

Operation ID: SearchAssets

Searches for assets using flexible query criteria. Supports filtering and pagination.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$

Request Body

Property	Type	Required	Description
searchPattern	String	No	—
searchFilters	Array of PropertyFilter	No	—
size	Number	No	—
from	Number	No	—
sort	String	No	—
sortDescending	Boolean	No	—
logicalOperator	String	No	—

Responses

200

Success

Property	Type	Description
assets	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Search Files

POST /iam/libraries/{libraryId}/search-files

Operation ID: SearchFiles

Searches for files using flexible query criteria. Supports filtering and pagination.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$

Request Body

Property	Type	Required	Description
searchPattern	String	No	—
searchFilters	Array of PropertyFilter	No	—
size	Number	No	—
from	Number	No	—
sort	String	No	—
sortDescending	Boolean	No	—
logicalOperator	String	No	—

Responses

200

Success

Property	Type	Description
files	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Audit Event Queries

POST /iam/libraries/{libraryId}/audit-event-queries

Operation ID: QueryAuditEvents

Queries audit events with specified filters and time ranges.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$
maxResults	query	Number	No	Maximum number of results to return per page
nextToken	query	String	No	Pagination token from a previous response

Request Body

Property	Type	Required	Description
filters	Array of AuditFilter	No	—
operation	String	No	—

Responses

200

Success

Property	Type	Description
nextToken	String	—
columns	Array of String	—
rows	Array of Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Known Attributes

GET /iam/libraries/{libraryId}/known-attributes

Operation ID: GetAllProjectKnownAttributes

Retrieves all known attributes across projects in a library.

Parameters

Name	In	Type	Required	Description
libraryId	path	String	Yes	Pattern: ^library-[a-fA-F0-9]{32}$

Responses

200

Success

Property	Type	Description
attributes	Object	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Personas

GET /iam/personas

Operation ID: GetPersonas

Retrieves the list of available personas.

Responses

200

Success

Property	Type	Description
personas	Array of Persona	—

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Telemetry

POST /iam/telemetry

Operation ID: SubmitTelemetry

Request Body

Property	Type	Required	Description
Event	Array of TelemetryEvent	Yes	—
UserDetails	Object	Yes	—
UserDetails.sessionId	String	Yes	—
UserDetails.userId	String	Yes	—

Responses

200

Success

400

Bad request. The request was invalid or cannot be served.

Property	Type	Description
message	String	—

Enumerations

The API uses the following enumeration types:

AccessRequestOperation

Type: string

Allowed values:

• read

• write

AnalysisState

Type: string

Allowed values:

• SUCCEEDED

• FAILED

• PENDING

• IN_PROGRESS

AssetAccessLocation

Type: string

Allowed values:

• manifest

• data

• manifest_and_data

AssetState

Type: string

Allowed values:

• DRAFT

• REVIEWED

• READY

• PENDING_DELETE

• PENDING_CREATE

• UPLOADING

AssociationStatus

Type: string

Allowed values:

• PENDING

• APPROVED

• DENIED

• REVOKED

AssociationType

Type: string

Allowed values:

• PROJECT_TEMPLATE

• TEMPLATE_CONNECTOR

ConnectorDirection

Type: string

Allowed values:

• derive

• publish

• bidirectional

ConnectorType

Type: string

Allowed values:

• opensearch

• stac

• synchronization

• lambda

• eventbridge

• DeadlineCloud

• rest

• RESTApi

• S3Csv

CredentialVendingRequestType

Type: string

Allowed values:

• user

FileState

Type: string

Allowed values:

• READY

• PENDING

• PROCESSING

• ERROR

• UPLOADING

FilterOperator

Type: string

Allowed values:

• eq

• ne

• lt

• lte

• gt

• gte

• like

• not_contains

• starts_with

• not_starts_with

• geo

MembershipLevel

Type: string

Allowed values:

• VIEWER

• CONTRIBUTOR

• MANAGER

• OWNER

PrincipalType

Type: string

Allowed values:

• USER

• GROUP

ProjectAccessLocation

Type: string

Allowed values:

• data

ProjectAccessOperation

Type: string

Allowed values:

• write

ResourceStatus

Type: string

Allowed values:

• READY

• UPLOADING

• ANALYZING

• DELETED

• PENDING_CREATE

• CREATE_FAILED

• UPDATE_FAILED

• UPLOAD_FAILED

UploadState

Type: string

Allowed values:

• UPLOAD_INITIATED

• UPLOADING

• PAUSED

• CANCELED

• CANCELING

• COMPLETE

UserUpdatableAssetState

Type: string

Allowed values:

• DRAFT

• DELETED

• REVIEWED

Data types

The API uses the following complex data types:

AddAssetTemplateMemberRequestContent

Context information for library operations.

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—
principalType	PrincipalType	Yes	—

AddAssetTemplateMemberResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

AddConnectorMemberRequestContent

Context information for connector operations.

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—
principalType	PrincipalType	Yes	—

AddConnectorMemberResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

AddLibraryMemberRequestContent

Context information for library operations.

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—
principalType	PrincipalType	Yes	—

AddLibraryMemberResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

AddProjectMemberRequestContent

Context information for project operations.

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—
principalType	PrincipalType	Yes	—

AddProjectMemberResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

Asset

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
assetId	String	Yes	Unique identifier for the asset
assetName	String	Yes	—
projectId	String	Yes	Unique identifier for the project
libraryId	String	Yes	Unique identifier for the library
assetState	AssetState	Yes	—
fileCount	Number	Yes	—
totalSize	Number	Yes	—
thumbnailUrl	String	No	—
thumbnailObjectKey	String	No	—
attributes	Array of Attribute	No	—
statusCode	ResourceStatus	No	—
statusMessage	String	No	—

AssetReference

Property	Type	Required	Description
assetId	String	Yes	Unique identifier for the asset
projectId	String	Yes	Unique identifier for the project
libraryId	String	Yes	Unique identifier for the library

AssetTemplateAssociationDetail

Property	Type	Required	Description
associationType	AssociationType	Yes	—
status	AssociationStatus	Yes	—
requestedBy	String	Yes	—
requestedAt	Number	Yes	—
reviewedBy	String	No	—
reviewedAt	Number	No	—
sourceResourceId	String	Yes	—
targetResourceId	String	Yes	—
assetTemplateId	String	No	—
assetTemplateName	String	No	—
assetTemplateCreatedAt	Number	No	—

AssetTemplateMinimal

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
assetTemplateId	String	Yes	—
assetTemplateName	String	Yes	—
permittedConnectorIds	Array of String	No	—
allowedFileTypes	Array of String	No	—
allowAdditionalFileTypes	Boolean	No	—

AssetVersion

Property	Type	Required	Description
versionId	String	Yes	Unique identifier for the asset version
createdAt	Number	Yes	—
createdBy	String	No	—
hash	String	No	—

Attribute

Property	Type	Required	Description
name	String	Yes	—
value	Object	Yes	—
source	String	No	—
type	String	No	—

AttributeSuggestion

Property	Type	Required	Description
attribute	String	Yes	—
presence	Number	Yes	—
example	String	Yes	—

AuditFilter

Property	Type	Required	Description
field	String	Yes	—
operator	String	Yes	—
value	String	Yes	—

ConflictExceptionResponseContent

Property	Type	Required	Description
message	String	Yes	—
errorCode	String	No	—
context	Object	No	—

ConnectorMinimal

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
connectorId	String	Yes	Unique identifier for the connector
connectorName	String	Yes	—
connectorType	ConnectorType	Yes	—
direction	ConnectorDirection	Yes	—
enabled	Boolean	Yes	—
connectorConfig	Object	No	—

CreateAssetRequestContent

Context information for project operations.

Property	Type	Required	Description
assetName	String	Yes	—
assetId	String	Yes	Unique identifier for the asset
manifestHash	String	No	—
manifestObjectKey	String	No	—
sourceAsset	AssetReference	No	—
mergeAssets	Array of AssetReference	No	—

CreateAssetResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
assetId	String	Yes	Unique identifier for the asset
assetName	String	Yes	—
projectId	String	Yes	Unique identifier for the project
libraryId	String	Yes	Unique identifier for the library
assetState	AssetState	Yes	—
fileCount	Number	Yes	—
totalSize	Number	Yes	—
thumbnailUrl	String	No	—
thumbnailObjectKey	String	No	—
attributes	Array of Attribute	No	—
manifestHash	String	No	—
statusCode	ResourceStatus	No	—
statusMessage	String	No	—

CreateAssetTemplateRequestContent

Context information for library operations.

Property	Type	Required	Description
assetTemplateConfig	Object	Yes	—

CreateAssetTemplateResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
assetTemplateId	String	Yes	—
assetTemplateName	String	Yes	—
assetTemplateConfig	Object	Yes	—

CreateConnectorRequestContent

Context information for library operations.

Property	Type	Required	Description
connectorConfig	Object	Yes	—

CreateConnectorResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
connectorId	String	Yes	Unique identifier for the connector
connectorName	String	Yes	—
connectorType	ConnectorType	Yes	—
direction	ConnectorDirection	Yes	—
enabled	Boolean	Yes	—
default	Boolean	Yes	—
connectorConfig	Object	Yes	—

CreateProjectRequestContent

Context information for library operations.

Property	Type	Required	Description
projectName	String	Yes	—
projectConfig	ProjectConfig	No	—
projectThumbnailObjectKey	String	No	—

CreateProjectResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
projectId	String	Yes	Unique identifier for the project
projectName	String	Yes	—
assetCount	Number	Yes	—
fileCount	Number	Yes	—
totalSize	Number	Yes	—
s3BucketName	String	Yes	—
rootPrefix	String	Yes	—
manifestPrefix	String	Yes	—
thumbnailObjectKey	String	No	—
thumbnailUrl	String	No	—
permittedTemplateIds	Array of String	No	—
allowNonTemplatedAssets	Boolean	Yes	—
description	String	No	—
metadataAttributes	Array of MetadataAttribute	No	—

DeleteAssetResponseContent

Response data for DeleteAsset operation.

Property	Type	Required	Description
assetState	AssetState	Yes	—
message	String	No	—

File

Property	Type	Required	Description
fileId	String	Yes	Unique identifier for the file
pathId	String	Yes	—
assetId	String	Yes	Unique identifier for the asset
path	String	Yes	—
mtime	Number	Yes	—
addedAt	Number	No	—
size	Number	Yes	—
objectKey	String	Yes	—
hash	String	Yes	—
state	FileState	Yes	—
analysisState	AnalysisState	Yes	—
hasAttributeSuggestions	Boolean	Yes	—
versionId	String	No	Unique identifier for the asset version
suggestedMetadataAttributes	Array of Attribute	No	—
metadataAttributes	Array of Attribute	No	—
location	Location	No	—
url	String	No	—
previews	Array of FilePreview	No	—

FileLocation

Property	Type	Required	Description
s3Location	String	Yes	—
userLocation	String	Yes	—

FilePreview

Property	Type	Required	Description
previewUrl	String	Yes	—
previewType	String	Yes	—

FileTypeSuggestion

Property	Type	Required	Description
fileType	String	Yes	—
count	Number	Yes	—
suggestions	Array of AttributeSuggestion	Yes	—

ForbiddenExceptionResponseContent

Property	Type	Required	Description
message	String	Yes	—

GetAllProjectKnownAttributesResponseContent

Response data for GetAllProjectKnownAttributes operation.

Property	Type	Required	Description
attributes	Object	Yes	—

GetAssetCredentialsResponseContent

Response data for GetAssetCredentials operation.

Property	Type	Required	Description
credentials	Object	Yes	—

GetAssetMultipartUploadDataResponseContent

Response data for GetAssetMultipartUploadData operation.

Property	Type	Required	Description
assetId	String	Yes	Unique identifier for the asset
projectId	String	Yes	Unique identifier for the project
uploadState	UploadState	Yes	—
s3BucketName	String	Yes	—
multipartUploadData	MultipartUploadData	Yes	—
uploadedFiles	Array of FileLocation	Yes	—
filesToUpload	Array of FileLocation	Yes	—

GetAssetResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
assetId	String	Yes	Unique identifier for the asset
assetName	String	Yes	—
projectId	String	Yes	Unique identifier for the project
libraryId	String	Yes	Unique identifier for the library
assetState	AssetState	Yes	—
fileCount	Number	Yes	—
totalSize	Number	Yes	—
thumbnailUrl	String	No	—
thumbnailObjectKey	String	No	—
attributes	Array of Attribute	No	—
manifestHash	String	No	—
statusCode	ResourceStatus	No	—
statusMessage	String	No	—

GetAssetTemplateAssociationResponseContent

Property	Type	Required	Description
associationType	AssociationType	Yes	—
status	AssociationStatus	Yes	—
requestedBy	String	Yes	—
requestedAt	Number	Yes	—
reviewedBy	String	No	—
reviewedAt	Number	No	—
sourceResourceId	String	Yes	—
targetResourceId	String	Yes	—
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
assetTemplateId	String	Yes	—
assetTemplateName	String	Yes	—
assetTemplateConfig	Object	Yes	—

GetAssetTemplateMemberResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

GetAssetTemplatePermissionsResponseContent

Response data for GetAssetTemplatePermissions operation.

Property	Type	Required	Description
permissions	Array of String	Yes	—

GetAssetTemplateResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
assetTemplateId	String	Yes	—
assetTemplateName	String	Yes	—
assetTemplateConfig	Object	Yes	—

GetConnectorMemberResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

GetConnectorPermissionsResponseContent

Response data for GetConnectorPermissions operation.

Property	Type	Required	Description
permissions	Array of String	Yes	—

GetConnectorResourcesResponseContent

Response data for GetConnectorResources operation.

Property	Type	Required	Description
resources	Object	Yes	—

GetConnectorResourcesViaAssetTemplateResponseContent

Response data for GetConnectorResourcesViaAssetTemplate operation.

Property	Type	Required	Description
resources	Object	Yes	—

GetConnectorResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
connectorId	String	Yes	Unique identifier for the connector
connectorName	String	Yes	—
connectorType	ConnectorType	Yes	—
direction	ConnectorDirection	Yes	—
enabled	Boolean	Yes	—
default	Boolean	Yes	—
connectorConfig	Object	Yes	—

GetFileResponseContent

Property	Type	Required	Description
fileId	String	Yes	Unique identifier for the file
pathId	String	Yes	—
assetId	String	Yes	Unique identifier for the asset
path	String	Yes	—
mtime	Number	Yes	—
addedAt	Number	No	—
size	Number	Yes	—
objectKey	String	Yes	—
hash	String	Yes	—
state	FileState	Yes	—
analysisState	AnalysisState	Yes	—
hasAttributeSuggestions	Boolean	Yes	—
versionId	String	No	Unique identifier for the asset version
suggestedMetadataAttributes	Array of Attribute	No	—
metadataAttributes	Array of Attribute	No	—
location	Location	No	—
url	String	No	—
previews	Array of FilePreview	No	—

GetFileVersionResponseContent

Property	Type	Required	Description
fileId	String	Yes	Unique identifier for the file
pathId	String	Yes	—
assetId	String	Yes	Unique identifier for the asset
path	String	Yes	—
mtime	Number	Yes	—
addedAt	Number	No	—
size	Number	Yes	—
objectKey	String	Yes	—
hash	String	Yes	—
state	FileState	Yes	—
analysisState	AnalysisState	Yes	—
hasAttributeSuggestions	Boolean	Yes	—
versionId	String	No	Unique identifier for the asset version
suggestedMetadataAttributes	Array of Attribute	No	—
metadataAttributes	Array of Attribute	No	—
location	Location	No	—
url	String	No	—
previews	Array of FilePreview	No	—

GetLibraryMemberResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

GetLibraryPermissionsResponseContent

Property	Type	Required	Description
permissions	Array of String	Yes	Permission structure showing allowed actions

GetLibraryResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
libraryName	String	Yes	—
storageConfig	StorageConfig	Yes	—

GetPersonasResponseContent

Response data for GetPersonas operation.

Property	Type	Required	Description
personas	Array of Persona	Yes	—

GetProjectCredentialsResponseContent

Response data for GetProjectCredentials operation.

Property	Type	Required	Description
credentials	Object	Yes	—

GetProjectKnownAttributesResponseContent

Response data for GetProjectKnownAttributes operation.

Property	Type	Required	Description
attributes	Object	Yes	—

GetProjectMemberResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

GetProjectPermissionsResponseContent

Response data for GetProjectPermissions operation.

Property	Type	Required	Description
permissions	Array of String	Yes	—

GetProjectResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
projectId	String	Yes	Unique identifier for the project
projectName	String	Yes	—
assetCount	Number	Yes	—
fileCount	Number	Yes	—
totalSize	Number	Yes	—
s3BucketName	String	Yes	—
rootPrefix	String	Yes	—
manifestPrefix	String	Yes	—
thumbnailObjectKey	String	No	—
thumbnailUrl	String	No	—
permittedTemplateIds	Array of String	No	—
allowNonTemplatedAssets	Boolean	Yes	—
description	String	No	—
metadataAttributes	Array of MetadataAttribute	No	—

InvalidParameterValueExceptionResponseContent

Property	Type	Required	Description
message	String	Yes	—
parameterName	String	No	—
parameterValue	String	No	—
allowedValues	Array of String	No	—

Library

Represents a library resource that serves as an organizational container for projects, assets, and templates. Libraries define storage configuration and access controls.

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
libraryName	String	Yes	Human-readable name of the library
storageConfig	StorageConfig	Yes	—

ListAssetAttributesResponseContent

Response data for ListAssetAttributes operation.

Property	Type	Required	Description
attributes	Array of Attribute	Yes	—

ListAssetSuggestedAttributesResponseContent

Response data for ListAssetSuggestedAttributes operation.

Property	Type	Required	Description
suggestions	Array of FileTypeSuggestion	Yes	—

ListAssetTemplateAssetsResponseContent

Response data for ListAssetTemplateAssets operation.

Property	Type	Required	Description
assets	Object	Yes	—
hiddenAssetsCount	Number	No	—
totalAssetsCount	Number	No	—

ListAssetTemplateConnectorAssociationsResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
associations	Array of TemplateConnectorAssociationDetail	Yes	—

ListAssetTemplateMembersResponseContent

Response data for ListMembers operation.

Property	Type	Required	Description
members	Array of Member	Yes	—
nextToken	String	No	Pagination token from a previous response

ListAssetTemplateProjectAssociationsResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
associations	Array of ProjectAssociationDetail	Yes	—

ListAssetTemplatesResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
templates	Array of AssetTemplateMinimal	Yes	—

ListAssetVersionsResponseContent

Response data for ListAssetVersions operation.

Property	Type	Required	Description
versions	Array of AssetVersion	Yes	—

ListAssetsResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
assets	Array of Asset	Yes	—

ListAvailableAssetTemplatesResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
templates	Array of AssetTemplateMinimal	Yes	—

ListAvailableConnectorsResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
connectors	Array of ConnectorMinimal	Yes	—

ListConnectorAssetTemplateAssociationsResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
associations	Array of AssetTemplateAssociationDetail	Yes	—

ListConnectorMembersResponseContent

Response data for ListMembers operation.

Property	Type	Required	Description
members	Array of Member	Yes	—
nextToken	String	No	Pagination token from a previous response

ListConnectorsResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
connectors	Array of ConnectorMinimal	Yes	—

ListFileVersionsResponseContent

Response data for ListFileVersions operation.

Property	Type	Required	Description
versions	Object	Yes	—

ListFilesForAssetVersionResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
files	Array of File	Yes	—

ListFilesResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
files	Array of File	Yes	—

ListLibrariesResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
libraries	Array of Library	Yes	List of libraries accessible to the user

ListLibraryAssetsResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
assets	Array of Asset	Yes	—

ListLibraryMembersResponseContent

Response data for ListMembers operation.

Property	Type	Required	Description
members	Array of Member	Yes	—
nextToken	String	No	Pagination token from a previous response

ListProjectAssetTemplateAssociationsResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
associations	Array of ProjectTemplateAssociationWithTemplate	Yes	—

ListProjectMembersResponseContent

Response data for ListMembers operation.

Property	Type	Required	Description
members	Array of Member	Yes	—
nextToken	String	No	Pagination token from a previous response

ListProjectsResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
projects	Array of Project	Yes	—

Location

Property	Type	Required	Description
latitude	Number	No	—
longitude	Number	No	—
place	String	No	—
geoJson	String	No	—
aabb	String	No	—

Member

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

MetadataAttribute

Property	Type	Required	Description
attribute	String	Yes	—
value	String	Yes	—

MultipartUploadData

Property	Type	Required	Description
multipartUploadId	String	No	—
s3UploadKey	String	No	—
filePath	String	No	—
fileSize	Number	No	—
completedParts	Array of UploadPart	No	—
partsSize	Number	No	—
totalParts	Number	No	—
lastCompletedPartNumber	Number	No	—
lastModified	Number	No	—

Persona

Property	Type	Required	Description
resourceType	String	Yes	—
persona	MembershipLevel	Yes	—
resourcePermissions	Array of ResourcePermissions	Yes	—

Project

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
projectId	String	Yes	Unique identifier for the project
projectName	String	Yes	—
assetCount	Number	Yes	—
fileCount	Number	Yes	—
totalSize	Number	Yes	—
s3BucketName	String	Yes	—
rootPrefix	String	Yes	—
manifestPrefix	String	Yes	—
thumbnailObjectKey	String	No	—
thumbnailUrl	String	No	—
permittedTemplateIds	Array of String	No	—
allowNonTemplatedAssets	Boolean	Yes	—
description	String	No	—
metadataAttributes	Array of MetadataAttribute	No	—

ProjectAssociationDetail

Property	Type	Required	Description
associationType	AssociationType	Yes	—
status	AssociationStatus	Yes	—
requestedBy	String	Yes	—
requestedAt	Number	Yes	—
reviewedBy	String	No	—
reviewedAt	Number	No	—
sourceResourceId	String	Yes	—
targetResourceId	String	Yes	—
projectId	String	No	Unique identifier for the project
projectName	String	No	—
projectDescription	String	No	—
projectAssetCount	Number	No	—
projectCreatedAt	Number	No	—

ProjectConfig

Configuration settings for project.

Property	Type	Required	Description
name	String	No	—
permittedTemplateIds	Array of String	No	—
description	String	No	—
thumbnailHash	String	No	—
allowNonTemplatedAssets	Boolean	No	—
s3BucketName	String	No	—
rootPrefix	String	No	—
latitude	Number	No	—
longitude	Number	No	—
place	String	No	—
metadata	Object	No	—

ProjectTemplateAssociationWithTemplate

Property	Type	Required	Description
associationType	AssociationType	Yes	—
status	AssociationStatus	Yes	—
requestedBy	String	Yes	—
requestedAt	Number	Yes	—
reviewedBy	String	No	—
reviewedAt	Number	No	—
sourceResourceId	String	Yes	—
targetResourceId	String	Yes	—
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
assetTemplateId	String	Yes	—
assetTemplateName	String	Yes	—
assetTemplateConfig	Object	Yes	—

PropertyFilter

Property	Type	Required	Description
key	String	Yes	—
operator	FilterOperator	Yes	—
stringValue	String	No	—
numberValue	Number	No	—

QueryAuditEventsRequestContent

Context information for library operations.

Property	Type	Required	Description
filters	Array of AuditFilter	No	—
operation	String	No	—

QueryAuditEventsResponseContent

Property	Type	Required	Description
nextToken	String	No	Pagination token from a previous response
columns	Array of String	No	—
rows	Array of Object	No	—

RequestAssetTemplateAssociationRequestContent

Context information for project operations.

Property	Type	Required	Description
templateId	String	Yes	Unique identifier for the template

RequestAssetTemplateAssociationResponseContent

Property	Type	Required	Description
associationType	AssociationType	Yes	—
status	AssociationStatus	Yes	—
requestedBy	String	Yes	—
requestedAt	Number	Yes	—
reviewedBy	String	No	—
reviewedAt	Number	No	—
sourceResourceId	String	Yes	—
targetResourceId	String	Yes	—

RequestConnectorAssociationRequestContent

Context information for library operations.

Property	Type	Required	Description
connectorId	String	Yes	Unique identifier for the connector

RequestConnectorAssociationResponseContent

Property	Type	Required	Description
associationType	AssociationType	Yes	—
status	AssociationStatus	Yes	—
requestedBy	String	Yes	—
requestedAt	Number	Yes	—
reviewedBy	String	No	—
reviewedAt	Number	No	—
sourceResourceId	String	Yes	—
targetResourceId	String	Yes	—

ResourcePermissions

Property	Type	Required	Description
resourceType	String	Yes	—
permissions	Array of String	Yes	—

SearchAssetsRequestContent

Context information for library operations.

Property	Type	Required	Description
searchPattern	String	No	—
searchFilters	Array of PropertyFilter	No	—
size	Number	No	—
from	Number	No	—
sort	String	No	—
sortDescending	Boolean	No	—
logicalOperator	String	No	—

SearchAssetsResponseContent

Response data for SearchAssets operation.

Property	Type	Required	Description
assets	Object	Yes	—

SearchFilesRequestContent

Context information for library operations.

Property	Type	Required	Description
searchPattern	String	No	—
searchFilters	Array of PropertyFilter	No	—
size	Number	No	—
from	Number	No	—
sort	String	No	—
sortDescending	Boolean	No	—
logicalOperator	String	No	—

SearchFilesResponseContent

Response data for SearchFiles operation.

Property	Type	Required	Description
files	Object	Yes	—

StorageConfig

S3 storage configuration defining where library data is stored

Property	Type	Required	Description
defaultS3BucketName	String	Yes	Default S3 bucket name for library storage
defaultRootS3Prefix	String	Yes	Default root S3 prefix for organizing library data

SubmitTelemetryRequestContent

Request parameters for SubmitTelemetry operation.

Property	Type	Required	Description
Event	Array of TelemetryEvent	Yes	—
UserDetails	UserDetails	Yes	—

TelemetryEvent

Property	Type	Required	Description
details	String	Yes	—
id	String	Yes	—
metadata	String	Yes	—
timestamp	Number	Yes	—
type	String	Yes	—

TemplateConnectorAssociationDetail

Property	Type	Required	Description
associationType	AssociationType	Yes	—
status	AssociationStatus	Yes	—
requestedBy	String	Yes	—
requestedAt	Number	Yes	—
reviewedBy	String	No	—
reviewedAt	Number	No	—
sourceResourceId	String	Yes	—
targetResourceId	String	Yes	—
connectorId	String	Yes	Unique identifier for the connector

TriggerConnectorOnAssetDirectResponseContent

Response data for TriggerConnectorOnAssetDirect operation.

Property	Type	Required	Description
result	String	Yes	—

TriggerConnectorOnAssetResponseContent

Response data for TriggerConnectorOnAsset operation.

Property	Type	Required	Description
result	String	Yes	—

TriggerConnectorOnProjectDirectResponseContent

Response data for TriggerConnectorOnProjectDirect operation.

Property	Type	Required	Description
result	String	Yes	—

UpdateAssetMultipartUploadDataRequestContent

Context information for project operations.

Property	Type	Required	Description
multipartUploadData	MultipartUploadData	Yes	—

UpdateAssetMultipartUploadDataResponseContent

Response data for UpdateAssetMultipartUploadData operation.

Property	Type	Required	Description
assetId	String	Yes	Unique identifier for the asset
projectId	String	Yes	Unique identifier for the project
multipartUploadData	MultipartUploadData	Yes	—

UpdateAssetRequestContent

Context information for project operations.

Property	Type	Required	Description
uploadState	UploadState	No	—
assetState	UserUpdatableAssetState	No	—
manifestHash	String	No	—
manifestObjectKey	String	No	—
activeVersionId	String	No	—

UpdateAssetResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
assetId	String	Yes	Unique identifier for the asset
assetName	String	Yes	—
projectId	String	Yes	Unique identifier for the project
libraryId	String	Yes	Unique identifier for the library
assetState	AssetState	Yes	—
fileCount	Number	Yes	—
totalSize	Number	Yes	—
thumbnailUrl	String	No	—
thumbnailObjectKey	String	No	—
attributes	Array of Attribute	No	—
manifestHash	String	No	—
statusCode	ResourceStatus	No	—
statusMessage	String	No	—

UpdateAssetTemplateMemberRequestContent

Context information for library operations.

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—

UpdateAssetTemplateMemberResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

UpdateAssetTemplateProjectAssociationRequestContent

Context information for library operations.

Property	Type	Required	Description
status	AssociationStatus	Yes	—

UpdateAssetTemplateProjectAssociationResponseContent

Property	Type	Required	Description
associationType	AssociationType	Yes	—
status	AssociationStatus	Yes	—
requestedBy	String	Yes	—
requestedAt	Number	Yes	—
reviewedBy	String	No	—
reviewedAt	Number	No	—
sourceResourceId	String	Yes	—
targetResourceId	String	Yes	—

UpdateAssetTemplateRequestContent

Context information for library operations.

Property	Type	Required	Description
assetTemplateConfig	Object	Yes	—

UpdateAssetTemplateResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
assetTemplateId	String	Yes	—
assetTemplateName	String	Yes	—
assetTemplateConfig	Object	Yes	—

UpdateConnectorAssetTemplateAssociationRequestContent

Context information for connector operations.

Property	Type	Required	Description
status	AssociationStatus	Yes	—

UpdateConnectorAssetTemplateAssociationResponseContent

Property	Type	Required	Description
associationType	AssociationType	Yes	—
status	AssociationStatus	Yes	—
requestedBy	String	Yes	—
requestedAt	Number	Yes	—
reviewedBy	String	No	—
reviewedAt	Number	No	—
sourceResourceId	String	Yes	—
targetResourceId	String	Yes	—

UpdateConnectorMemberRequestContent

Context information for connector operations.

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—

UpdateConnectorMemberResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

UpdateConnectorRequestContent

Context information for connector operations.

Property	Type	Required	Description
connectorName	String	Yes	—
connectorType	ConnectorType	Yes	—
direction	ConnectorDirection	Yes	—
enabled	Boolean	Yes	—
connectorConfig	Object	Yes	—

UpdateConnectorResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
connectorId	String	Yes	Unique identifier for the connector
connectorName	String	Yes	—
connectorType	ConnectorType	Yes	—
direction	ConnectorDirection	Yes	—
enabled	Boolean	Yes	—
default	Boolean	Yes	—
connectorConfig	Object	Yes	—

UpdateLibraryMemberRequestContent

Context information for library operations.

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—

UpdateLibraryMemberResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

UpdateProjectMemberRequestContent

Context information for project operations.

Property	Type	Required	Description
membershipLevel	MembershipLevel	Yes	—

UpdateProjectMemberResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
resourceId	ResourceId	Yes	—
principalId	String	Yes	Identifier of the IAM principal (user, role, or group)
principalType	PrincipalType	Yes	—
membershipLevel	MembershipLevel	Yes	—

UpdateProjectRequestContent

Context information for project operations.

Property	Type	Required	Description
projectName	String	No	—
projectConfig	ProjectConfig	No	—
projectThumbnailObjectKey	String	No	—

UpdateProjectResponseContent

Property	Type	Required	Description
createdAt	Number	Yes	—
updatedAt	Number	No	—
createdBy	String	Yes	—
updatedBy	String	No	—
libraryId	String	Yes	Unique identifier for the library
projectId	String	Yes	Unique identifier for the project
projectName	String	Yes	—
assetCount	Number	Yes	—
fileCount	Number	Yes	—
totalSize	Number	Yes	—
s3BucketName	String	Yes	—
rootPrefix	String	Yes	—
manifestPrefix	String	Yes	—
thumbnailObjectKey	String	No	—
thumbnailUrl	String	No	—
permittedTemplateIds	Array of String	No	—
allowNonTemplatedAssets	Boolean	Yes	—
description	String	No	—
metadataAttributes	Array of MetadataAttribute	No	—

UploadPart

Property	Type	Required	Description
partNumber	Number	Yes	—
etag	String	Yes	—

UserDetails

Property	Type	Required	Description
sessionId	String	Yes	—
userId	String	Yes	—

ValidationExceptionResponseContent

Property	Type	Required	Description
message	String	Yes	—

VerifyAssetConnectorRelationshipResponseContent

Response data for VerifyAssetConnectorRelationship operation.

Property	Type	Required	Description
result	Boolean	Yes	—

VerifyProjectConnectorRelationshipResponseContent

Response data for VerifyProjectConnectorRelationship operation.

Property	Type	Required	Description
result	Boolean	Yes	—

Error Responses

All API operations may return the following error responses:

400

Bad request. The request was invalid or cannot be served.

403

Forbidden. The authenticated user does not have permission.

409

Conflict. The request conflicts with the current state of the resource.

500

Internal server error.