Cloud Providers

Tenyks SDK can rely on all 3 major cloud providers for ingestion of images, annotations and predictions, and a specific format of dictionaries with credentials to access your provider of choice.

AWS

Bases: BaseModel

Represents AWS credentials required for accessing AWS services.

Attributes:

aws_access_key_id (SecretStr):
    AWS access key ID.

    **Examples**: ["AKIA*************AMPLE"]


aws_secret_access_key (SecretStr):
    AWS secret access key.

    **Examples**: ["wJalrXUtnFEMI/************EXAMPLEKEY"]


region_name (str):
    AWS region name.

    **Examples**: ["eu-central-1"]

Bases: BaseModel

Represents an AWS location, specifically an S3 URI, along with the necessary AWS credentials.

Attributes:

Name	Type	Description
type	str	AWS location type. This is frozen and defaults to CloudLocationType.AWS_S3.value. Default: "aws_s3"
s3_uri	str	S3 URI indicating the location in the AWS S3 service. Examples: ["s3://bucket-name/path/to/folder_or_file"] Constraints: Must match the S3 URI pattern and will have whitespace stripped.
credentials	AWSCredentials	AWS credentials required to access the specified S3 URI. Examples: - AWSCredentials( aws_access_key_id="AKIA***AMPLE", aws_secret_access_key="wJalrXUtnFEMI/****EXAMPLEKEY", region_name="eu-central-1", )

GCS

Bases: BaseModel

Represents a Google Cloud Storage (GCS) location, including a URI and the necessary service account credentials.

Attributes:

type (str):

    GCS location type. This is frozen and defaults to `CloudLocationType.GCS.value`.
    **Default**: "gcs"

gcs_uri (str):

    GCS URI indicating the location in Google Cloud Storage.

    **Examples**: ["gs://bucket-name/path/to/folder_or_file"]

    **Constraints**: Must match the GCS URI pattern and will have whitespace stripped.

credentials (Dict[str, SecretStr]):

    GCS service account credentials in JSON format.

    **Examples**:
        - {
            "type": "service_account",
            "project_id": "my-project-id",
            "private_key_id": "************",
            "private_key": "-----BEGIN PRIVATE KEY-----\n...",
            "client_email": "my-service-account@example.com",
            "client_id": "************",
            "auth_uri": "https://accounts.google.com/o/oauth2/auth",
            "token_uri": "https://oauth2.googleapis.com/token",
            "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
            "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/my-service-account@example.com",
          }

Azure

Bases: BaseModel

Represents Azure credentials required for accessing Azure services.

Attributes:

    type (AzureTokenType):

            Azure token type, indicating the type of authentication used.

            **Examples**: [AzureTokenType.CONNECTION_STRING, AzureTokenType.SAS_TOKEN]


    value (SecretStr):

            Azure token value, which could be a connection string or a SAS token.

            **Examples**:
                    - "DefaultEndpointsProtocol=https;AccountName=your_account_name;AccountKey=*************;"
                        "EndpointSuffix=core.windows.net"

                    - "sv=2020-08-04&ss=b&srt=sco&sp=rwdlacx&se=2022-12-31T23:59:59Z&st=2022-01-01T00:00:00Z&"
                        "spr=https&sig=abcd************ijkl9012mnop3456qrst7890uvwx1234yzab************"

Bases: BaseModel

Represents an Azure location, including a URI and the necessary Azure credentials.

Attributes:

Name	Type	Description
type	str	Azure location type. This is frozen and defaults to CloudLocationType.AZURE.value. Default: "azure"
azure_uri	str	Azure URI indicating the location in Azure services (e.g., Blob, File, Queue, or Table storage). Examples: - "https://account_name.blob.core.windows.net/container_name/blob_name" - "https://account_name.file.core.windows.net/share_name/directory_name/file_name" - "https://account_name.queue.core.windows.net/queue_name" - "https://account_name.table.core.windows.net/table_name" Constraints: Must match the Azure URI pattern and will have whitespace stripped.
credentials	AzureCredentials	Azure credentials required to access the specified Azure URI. Examples: - AzureCredentials( type=AzureTokenType.CONNECTION_STRING, value=( "DefaultEndpointsProtocol=https;AccountName=your_account_name;" "AccountKey=*************;EndpointSuffix=core.windows.net" ), )