register

autogluon.cloud.register(*, role: str, bucket: str, region: str, backend: Literal['sagemaker'] = 'sagemaker', stack_name: str | None = None, session: Session | None = None) → None[source]

Save an existing IAM role and S3 bucket to ~/.autogluon/cloud.yaml.

Use this instead of bootstrap() if the resources already exist, e.g. provisioned by your platform team. Overwrites any existing entry for backend.

Parameters:

  • role (str) – ARN of the SageMaker execution role.

  • bucket (str) – Name of the S3 bucket for artifacts, without s3:// or a prefix. Must be in region.

  • region (str) – AWS region where jobs and endpoints run.

  • backend (BackendName, default = "sagemaker") – Backend the resources are used for.

  • stack_name (str | None, default = None) – CloudFormation stack that owns the resources. If set, teardown() deletes this stack; otherwise it only removes the config entry.

  • session (boto3.Session | None, default = None) – Session used to verify the bucket region. If None, uses the default boto3 session.