Get an S3 asset. | NVIDIA Run:ai Documentation

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "test@run.ai",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "test@run.ai",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "bucket": "my-bucket",
    "path": "/container/my-bucket",
    "url": "https://s3.amazonaws.com",
    "accessKeyAssetId": "string"
  },
  "usedBy": {
    "workspaces": [
      {
        "id": "string",
        "name": "my-workload-name",
        "status": "string"
      }
    ],
    "trainings": [
      {
        "id": "string",
        "name": "my-workload-name",
        "status": "string"
      }
    ],
    "distributed": [
      {
        "id": "string",
        "name": "my-workload-name",
        "status": "string"
      }
    ],
    "inferences": [
      {
        "id": "string",
        "name": "my-workload-name",
        "status": "string"
      }
    ],
    "templates": [
      {
        "id": "string",
        "name": "my-asset"
      }
    ],
    "assets": {
      "environment": {
        "id": "string",
        "name": "my-asset",
        "toolTypes": [
          "jupyter-notebook"
        ]
      },
      "environments": [
        {
          "id": "string",
          "name": "my-asset"
        }
      ],
      "compute": {
        "id": "string",
        "name": "my-asset"
      },
      "computes": [
        {
          "id": "string",
          "name": "my-asset"
        }
      ],
      "datasources": [
        {
          "id": "string",
          "name": "my-asset",
          "kind": "compute",
          "overrides": {
            "containerPath": "/container/directory"
          }
        }
      ]
    }
  },
  "usageTimes": {
    "lastUsedByWorkload": "2024-01-15T09:30:00Z"
  },
  "compliance": {
    "imposed": true,
    "compliance": true,
    "reason": [
      {
        "details": "string",
        "field": "string",
        "rule": "min"
      }
    ]
  },
  "status": {
    "status": "Creating",
    "issues": [
      {
        "scopeId": "string",
        "scopeType": "system",
        "issue": "ReplicationError"
      }
    ],
    "message": "string",
    "url": "string"
  }
}

Retrieve the details of S3 compatible datasource asset by id.

Authentication

AuthorizationBearer

Bearer authentication

Path parameters

AssetIdstringRequiredformat: "uuid">=1 character

Unique identifier of the asset.

Query parameters

usageInfobooleanOptional

Whether the query should include asset usage information as part of the response.

complyToProjectintegerOptional

Include workload creation compliance information of an asset, for a given project, as part of the response. To check compliance, you need to provide both project id and workload type.

complyToWorkloadTypeenumOptional

Include workload creation compliance information of an asset, for a given workload type, as part of the response. To check compliance, you need to provide both project id and workload type.

Allowed values:

statusInfobooleanOptional

Whether the query should include asset status information as part of the response.

complyToReplicaTypeenumOptional

Include workload creation compliance information of an asset, for a given replica type, as part of the response. To check compliance, you need to provide both project id and workload type. For distributed, replica type should be provided as well.

Allowed values:

Response

Request completed successfully.

metaobject

specobject

usedByobjectOptional

Details about resources that use the asset.

usageTimesobjectOptional

Details about times the asset has been used by workloads, etc.

complianceobjectOptional

Compliance of an asset with creation of workloads in a given project.

statusobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

503

Service Unavailable Error