awscc.sagemaker_userprofile

Filters

  • event

  • reduce

  • value

Actions

delete

Parent base class for filters and actions.

properties:
  type:
    enum:
    - delete
required:
- type

Permissions - sagemaker:DeleteUserProfile, sagemaker:DescribeUserProfile

update

Parent base class for filters and actions.

definitions:
  CustomImage:
    additionalProperties: false
    description: A custom SageMaker image.
    properties:
      AppImageConfigName:
        description: The Name of the AppImageConfig.
        maxLength: 63
        pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
        type: string
      ImageName:
        description: The name of the CustomImage. Must be unique to your account.
        maxLength: 63
        pattern: ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$
        type: string
      ImageVersionNumber:
        description: The version number of the CustomImage.
        minimum: 0
        type: integer
    required:
    - AppImageConfigName
    - ImageName
    type: object
  JupyterServerAppSettings:
    additionalProperties: false
    description: The JupyterServer app settings.
    properties:
      DefaultResourceSpec:
        additionalProperties: false
        properties:
          InstanceType:
            description: The instance type that the image version runs on.
            enum:
            - system
            - ml.t3.micro
            - ml.t3.small
            - ml.t3.medium
            - ml.t3.large
            - ml.t3.xlarge
            - ml.t3.2xlarge
            - ml.m5.large
            - ml.m5.xlarge
            - ml.m5.2xlarge
            - ml.m5.4xlarge
            - ml.m5.8xlarge
            - ml.m5.12xlarge
            - ml.m5.16xlarge
            - ml.m5.24xlarge
            - ml.c5.large
            - ml.c5.xlarge
            - ml.c5.2xlarge
            - ml.c5.4xlarge
            - ml.c5.9xlarge
            - ml.c5.12xlarge
            - ml.c5.18xlarge
            - ml.c5.24xlarge
            - ml.p3.2xlarge
            - ml.p3.8xlarge
            - ml.p3.16xlarge
            - ml.g4dn.xlarge
            - ml.g4dn.2xlarge
            - ml.g4dn.4xlarge
            - ml.g4dn.8xlarge
            - ml.g4dn.12xlarge
            - ml.g4dn.16xlarge
            type: string
          SageMakerImageArn:
            description: The ARN of the SageMaker image that the image version belongs
              to.
            maxLength: 256
            pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$
            type: string
          SageMakerImageVersionArn:
            description: The ARN of the image version created on the instance.
            maxLength: 256
            pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$
            type: string
        type: object
    type: object
  KernelGatewayAppSettings:
    additionalProperties: false
    description: The kernel gateway app settings.
    properties:
      CustomImages:
        description: A list of custom SageMaker images that are configured to run
          as a KernelGateway app.
        items:
          additionalProperties: false
          description: A custom SageMaker image.
          properties:
            AppImageConfigName:
              description: The Name of the AppImageConfig.
              maxLength: 63
              pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
              type: string
            ImageName:
              description: The name of the CustomImage. Must be unique to your account.
              maxLength: 63
              pattern: ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$
              type: string
            ImageVersionNumber:
              description: The version number of the CustomImage.
              minimum: 0
              type: integer
          required:
          - AppImageConfigName
          - ImageName
          type: object
        maxItems: 30
        minItems: 0
        type: array
        uniqueItems: false
      DefaultResourceSpec:
        additionalProperties: false
        properties:
          InstanceType:
            description: The instance type that the image version runs on.
            enum:
            - system
            - ml.t3.micro
            - ml.t3.small
            - ml.t3.medium
            - ml.t3.large
            - ml.t3.xlarge
            - ml.t3.2xlarge
            - ml.m5.large
            - ml.m5.xlarge
            - ml.m5.2xlarge
            - ml.m5.4xlarge
            - ml.m5.8xlarge
            - ml.m5.12xlarge
            - ml.m5.16xlarge
            - ml.m5.24xlarge
            - ml.c5.large
            - ml.c5.xlarge
            - ml.c5.2xlarge
            - ml.c5.4xlarge
            - ml.c5.9xlarge
            - ml.c5.12xlarge
            - ml.c5.18xlarge
            - ml.c5.24xlarge
            - ml.p3.2xlarge
            - ml.p3.8xlarge
            - ml.p3.16xlarge
            - ml.g4dn.xlarge
            - ml.g4dn.2xlarge
            - ml.g4dn.4xlarge
            - ml.g4dn.8xlarge
            - ml.g4dn.12xlarge
            - ml.g4dn.16xlarge
            type: string
          SageMakerImageArn:
            description: The ARN of the SageMaker image that the image version belongs
              to.
            maxLength: 256
            pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$
            type: string
          SageMakerImageVersionArn:
            description: The ARN of the image version created on the instance.
            maxLength: 256
            pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$
            type: string
        type: object
    type: object
  ResourceSpec:
    additionalProperties: false
    properties:
      InstanceType:
        description: The instance type that the image version runs on.
        enum:
        - system
        - ml.t3.micro
        - ml.t3.small
        - ml.t3.medium
        - ml.t3.large
        - ml.t3.xlarge
        - ml.t3.2xlarge
        - ml.m5.large
        - ml.m5.xlarge
        - ml.m5.2xlarge
        - ml.m5.4xlarge
        - ml.m5.8xlarge
        - ml.m5.12xlarge
        - ml.m5.16xlarge
        - ml.m5.24xlarge
        - ml.c5.large
        - ml.c5.xlarge
        - ml.c5.2xlarge
        - ml.c5.4xlarge
        - ml.c5.9xlarge
        - ml.c5.12xlarge
        - ml.c5.18xlarge
        - ml.c5.24xlarge
        - ml.p3.2xlarge
        - ml.p3.8xlarge
        - ml.p3.16xlarge
        - ml.g4dn.xlarge
        - ml.g4dn.2xlarge
        - ml.g4dn.4xlarge
        - ml.g4dn.8xlarge
        - ml.g4dn.12xlarge
        - ml.g4dn.16xlarge
        type: string
      SageMakerImageArn:
        description: The ARN of the SageMaker image that the image version belongs
          to.
        maxLength: 256
        pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$
        type: string
      SageMakerImageVersionArn:
        description: The ARN of the image version created on the instance.
        maxLength: 256
        pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$
        type: string
    type: object
  SharingSettings:
    additionalProperties: false
    description: Specifies options when sharing an Amazon SageMaker Studio notebook.
      These settings are specified as part of DefaultUserSettings when the CreateDomain
      API is called, and as part of UserSettings when the CreateUserProfile API is
      called.
    properties:
      NotebookOutputOption:
        description: Whether to include the notebook cell output when sharing the
          notebook. The default is Disabled.
        enum:
        - Allowed
        - Disabled
        type: string
      S3KmsKeyId:
        description: When NotebookOutputOption is Allowed, the AWS Key Management
          Service (KMS) encryption key ID used to encrypt the notebook cell output
          in the Amazon S3 bucket.
        maxLength: 2048
        pattern: .*
        type: string
      S3OutputPath:
        description: When NotebookOutputOption is Allowed, the Amazon S3 bucket used
          to store the shared notebook snapshots.
        maxLength: 1024
        pattern: ^(https|s3)://([^/]+)/?(.*)$
        type: string
    type: object
  Tag:
    additionalProperties: false
    properties:
      Key:
        maxLength: 128
        minLength: 1
        type: string
      Value:
        maxLength: 128
        minLength: 1
        type: string
    required:
    - Key
    - Value
    type: object
  UserSettings:
    additionalProperties: false
    description: A collection of settings that apply to users of Amazon SageMaker
      Studio. These settings are specified when the CreateUserProfile API is called,
      and as DefaultUserSettings when the CreateDomain API is called.
    properties:
      ExecutionRole:
        description: The user profile Amazon Resource Name (ARN).
        maxLength: 2048
        minLength: 20
        pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
        type: string
      JupyterServerAppSettings:
        additionalProperties: false
        description: The JupyterServer app settings.
        properties:
          DefaultResourceSpec:
            additionalProperties: false
            properties:
              InstanceType:
                description: The instance type that the image version runs on.
                enum:
                - system
                - ml.t3.micro
                - ml.t3.small
                - ml.t3.medium
                - ml.t3.large
                - ml.t3.xlarge
                - ml.t3.2xlarge
                - ml.m5.large
                - ml.m5.xlarge
                - ml.m5.2xlarge
                - ml.m5.4xlarge
                - ml.m5.8xlarge
                - ml.m5.12xlarge
                - ml.m5.16xlarge
                - ml.m5.24xlarge
                - ml.c5.large
                - ml.c5.xlarge
                - ml.c5.2xlarge
                - ml.c5.4xlarge
                - ml.c5.9xlarge
                - ml.c5.12xlarge
                - ml.c5.18xlarge
                - ml.c5.24xlarge
                - ml.p3.2xlarge
                - ml.p3.8xlarge
                - ml.p3.16xlarge
                - ml.g4dn.xlarge
                - ml.g4dn.2xlarge
                - ml.g4dn.4xlarge
                - ml.g4dn.8xlarge
                - ml.g4dn.12xlarge
                - ml.g4dn.16xlarge
                type: string
              SageMakerImageArn:
                description: The ARN of the SageMaker image that the image version
                  belongs to.
                maxLength: 256
                pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$
                type: string
              SageMakerImageVersionArn:
                description: The ARN of the image version created on the instance.
                maxLength: 256
                pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$
                type: string
            type: object
        type: object
      KernelGatewayAppSettings:
        additionalProperties: false
        description: The kernel gateway app settings.
        properties:
          CustomImages:
            description: A list of custom SageMaker images that are configured to
              run as a KernelGateway app.
            items:
              additionalProperties: false
              description: A custom SageMaker image.
              properties:
                AppImageConfigName:
                  description: The Name of the AppImageConfig.
                  maxLength: 63
                  pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
                  type: string
                ImageName:
                  description: The name of the CustomImage. Must be unique to your
                    account.
                  maxLength: 63
                  pattern: ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$
                  type: string
                ImageVersionNumber:
                  description: The version number of the CustomImage.
                  minimum: 0
                  type: integer
              required:
              - AppImageConfigName
              - ImageName
              type: object
            maxItems: 30
            minItems: 0
            type: array
            uniqueItems: false
          DefaultResourceSpec:
            additionalProperties: false
            properties:
              InstanceType:
                description: The instance type that the image version runs on.
                enum:
                - system
                - ml.t3.micro
                - ml.t3.small
                - ml.t3.medium
                - ml.t3.large
                - ml.t3.xlarge
                - ml.t3.2xlarge
                - ml.m5.large
                - ml.m5.xlarge
                - ml.m5.2xlarge
                - ml.m5.4xlarge
                - ml.m5.8xlarge
                - ml.m5.12xlarge
                - ml.m5.16xlarge
                - ml.m5.24xlarge
                - ml.c5.large
                - ml.c5.xlarge
                - ml.c5.2xlarge
                - ml.c5.4xlarge
                - ml.c5.9xlarge
                - ml.c5.12xlarge
                - ml.c5.18xlarge
                - ml.c5.24xlarge
                - ml.p3.2xlarge
                - ml.p3.8xlarge
                - ml.p3.16xlarge
                - ml.g4dn.xlarge
                - ml.g4dn.2xlarge
                - ml.g4dn.4xlarge
                - ml.g4dn.8xlarge
                - ml.g4dn.12xlarge
                - ml.g4dn.16xlarge
                type: string
              SageMakerImageArn:
                description: The ARN of the SageMaker image that the image version
                  belongs to.
                maxLength: 256
                pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$
                type: string
              SageMakerImageVersionArn:
                description: The ARN of the image version created on the instance.
                maxLength: 256
                pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$
                type: string
            type: object
        type: object
      SecurityGroups:
        description: The security groups for the Amazon Virtual Private Cloud (VPC)
          that Studio uses for communication.
        items:
          maxLength: 32
          pattern: '[-0-9a-zA-Z]+'
          type: string
        maxItems: 5
        minItems: 0
        type: array
        uniqueItems: false
      SharingSettings:
        additionalProperties: false
        description: Specifies options when sharing an Amazon SageMaker Studio notebook.
          These settings are specified as part of DefaultUserSettings when the CreateDomain
          API is called, and as part of UserSettings when the CreateUserProfile API
          is called.
        properties:
          NotebookOutputOption:
            description: Whether to include the notebook cell output when sharing
              the notebook. The default is Disabled.
            enum:
            - Allowed
            - Disabled
            type: string
          S3KmsKeyId:
            description: When NotebookOutputOption is Allowed, the AWS Key Management
              Service (KMS) encryption key ID used to encrypt the notebook cell output
              in the Amazon S3 bucket.
            maxLength: 2048
            pattern: .*
            type: string
          S3OutputPath:
            description: When NotebookOutputOption is Allowed, the Amazon S3 bucket
              used to store the shared notebook snapshots.
            maxLength: 1024
            pattern: ^(https|s3)://([^/]+)/?(.*)$
            type: string
        type: object
    type: object
properties:
  UserSettings:
    additionalProperties: false
    description: A collection of settings that apply to users of Amazon SageMaker
      Studio. These settings are specified when the CreateUserProfile API is called,
      and as DefaultUserSettings when the CreateDomain API is called.
    properties:
      ExecutionRole:
        description: The user profile Amazon Resource Name (ARN).
        maxLength: 2048
        minLength: 20
        pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
        type: string
      JupyterServerAppSettings:
        additionalProperties: false
        description: The JupyterServer app settings.
        properties:
          DefaultResourceSpec:
            additionalProperties: false
            properties:
              InstanceType:
                description: The instance type that the image version runs on.
                enum:
                - system
                - ml.t3.micro
                - ml.t3.small
                - ml.t3.medium
                - ml.t3.large
                - ml.t3.xlarge
                - ml.t3.2xlarge
                - ml.m5.large
                - ml.m5.xlarge
                - ml.m5.2xlarge
                - ml.m5.4xlarge
                - ml.m5.8xlarge
                - ml.m5.12xlarge
                - ml.m5.16xlarge
                - ml.m5.24xlarge
                - ml.c5.large
                - ml.c5.xlarge
                - ml.c5.2xlarge
                - ml.c5.4xlarge
                - ml.c5.9xlarge
                - ml.c5.12xlarge
                - ml.c5.18xlarge
                - ml.c5.24xlarge
                - ml.p3.2xlarge
                - ml.p3.8xlarge
                - ml.p3.16xlarge
                - ml.g4dn.xlarge
                - ml.g4dn.2xlarge
                - ml.g4dn.4xlarge
                - ml.g4dn.8xlarge
                - ml.g4dn.12xlarge
                - ml.g4dn.16xlarge
                type: string
              SageMakerImageArn:
                description: The ARN of the SageMaker image that the image version
                  belongs to.
                maxLength: 256
                pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$
                type: string
              SageMakerImageVersionArn:
                description: The ARN of the image version created on the instance.
                maxLength: 256
                pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$
                type: string
            type: object
        type: object
      KernelGatewayAppSettings:
        additionalProperties: false
        description: The kernel gateway app settings.
        properties:
          CustomImages:
            description: A list of custom SageMaker images that are configured to
              run as a KernelGateway app.
            items:
              additionalProperties: false
              description: A custom SageMaker image.
              properties:
                AppImageConfigName:
                  description: The Name of the AppImageConfig.
                  maxLength: 63
                  pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
                  type: string
                ImageName:
                  description: The name of the CustomImage. Must be unique to your
                    account.
                  maxLength: 63
                  pattern: ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$
                  type: string
                ImageVersionNumber:
                  description: The version number of the CustomImage.
                  minimum: 0
                  type: integer
              required:
              - AppImageConfigName
              - ImageName
              type: object
            maxItems: 30
            minItems: 0
            type: array
            uniqueItems: false
          DefaultResourceSpec:
            additionalProperties: false
            properties:
              InstanceType:
                description: The instance type that the image version runs on.
                enum:
                - system
                - ml.t3.micro
                - ml.t3.small
                - ml.t3.medium
                - ml.t3.large
                - ml.t3.xlarge
                - ml.t3.2xlarge
                - ml.m5.large
                - ml.m5.xlarge
                - ml.m5.2xlarge
                - ml.m5.4xlarge
                - ml.m5.8xlarge
                - ml.m5.12xlarge
                - ml.m5.16xlarge
                - ml.m5.24xlarge
                - ml.c5.large
                - ml.c5.xlarge
                - ml.c5.2xlarge
                - ml.c5.4xlarge
                - ml.c5.9xlarge
                - ml.c5.12xlarge
                - ml.c5.18xlarge
                - ml.c5.24xlarge
                - ml.p3.2xlarge
                - ml.p3.8xlarge
                - ml.p3.16xlarge
                - ml.g4dn.xlarge
                - ml.g4dn.2xlarge
                - ml.g4dn.4xlarge
                - ml.g4dn.8xlarge
                - ml.g4dn.12xlarge
                - ml.g4dn.16xlarge
                type: string
              SageMakerImageArn:
                description: The ARN of the SageMaker image that the image version
                  belongs to.
                maxLength: 256
                pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$
                type: string
              SageMakerImageVersionArn:
                description: The ARN of the image version created on the instance.
                maxLength: 256
                pattern: ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$
                type: string
            type: object
        type: object
      SecurityGroups:
        description: The security groups for the Amazon Virtual Private Cloud (VPC)
          that Studio uses for communication.
        items:
          maxLength: 32
          pattern: '[-0-9a-zA-Z]+'
          type: string
        maxItems: 5
        minItems: 0
        type: array
        uniqueItems: false
      SharingSettings:
        additionalProperties: false
        description: Specifies options when sharing an Amazon SageMaker Studio notebook.
          These settings are specified as part of DefaultUserSettings when the CreateDomain
          API is called, and as part of UserSettings when the CreateUserProfile API
          is called.
        properties:
          NotebookOutputOption:
            description: Whether to include the notebook cell output when sharing
              the notebook. The default is Disabled.
            enum:
            - Allowed
            - Disabled
            type: string
          S3KmsKeyId:
            description: When NotebookOutputOption is Allowed, the AWS Key Management
              Service (KMS) encryption key ID used to encrypt the notebook cell output
              in the Amazon S3 bucket.
            maxLength: 2048
            pattern: .*
            type: string
          S3OutputPath:
            description: When NotebookOutputOption is Allowed, the Amazon S3 bucket
              used to store the shared notebook snapshots.
            maxLength: 1024
            pattern: ^(https|s3)://([^/]+)/?(.*)$
            type: string
        type: object
    type: object
  type:
    enum:
    - update

Permissions - sagemaker:UpdateUserProfile, sagemaker:DescribeUserProfile, sagemaker:DescribeImage, sagemaker:DescribeImageVersion, iam:PassRole