Amazon SageMaker Sagemaker Workteam API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Workteam API
  version: '2017-07-24'
  description: Generated from AWS's published Smithy model for Amazon SageMaker Service. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://api.sagemaker.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateWorkteam:
    post:
      operationId: CreateWorkteam
      summary: Create Workteam
      description: Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user
        pools. You must first create the user pools before you can create a work team. You cannot create more than 25 work
        teams in an account and region.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateWorkteamResponse'
        '400':
          description: ResourceInUse; ResourceLimitExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.CreateWorkteam
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateWorkteamRequest'
      tags:
      - Workteam
  /#DeleteWorkteam:
    post:
      operationId: DeleteWorkteam
      summary: Delete Workteam
      description: Deletes an existing work team. This operation can't be undone.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteWorkteamResponse'
        '400':
          description: ResourceLimitExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceLimitExceeded'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DeleteWorkteam
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteWorkteamRequest'
      tags:
      - Workteam
  /#DescribeWorkteam:
    post:
      operationId: DescribeWorkteam
      summary: Describe Workteam
      description: Gets information about a specific work team. You can see information such as the creation date, the last
        updated date, membership information, and the work team's Amazon Resource Name (ARN).
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeWorkteamResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DescribeWorkteam
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeWorkteamRequest'
      tags:
      - Workteam
  /#ListWorkteams:
    post:
      operationId: ListWorkteams
      summary: List Workteams
      description: Gets a list of private work teams that you have defined in a region. The list may be empty if no work team
        satisfies the filter specified in the NameContains parameter.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListWorkteamsResponse'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListWorkteams
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListWorkteamsRequest'
      tags:
      - Workteam
  /#UpdateWorkteam:
    post:
      operationId: UpdateWorkteam
      summary: Update Workteam
      description: Updates an existing work team with new member definitions or description.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateWorkteamResponse'
        '400':
          description: ResourceLimitExceeded
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceLimitExceeded'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.UpdateWorkteam
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateWorkteamRequest'
      tags:
      - Workteam
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: sagemaker
  schemas:
    CognitoMemberDefinition:
      type: object
      properties:
        UserPool:
          type: string
          description: An identifier for a user pool. The user pool must be in the same region as the service that you are
            calling.
        UserGroup:
          type: string
          description: An identifier for a user group.
        ClientId:
          type: string
          description: An identifier for an application client. You must create the app client ID using Amazon Cognito.
      required:
      - UserPool
      - UserGroup
      - ClientId
    CreateWorkteamRequest:
      type: object
      properties:
        WorkteamName:
          type: string
          description: The name of the work team. Use this name to identify the work team.
        WorkforceName:
          type: string
          description: The name of the workforce.
        MemberDefinitions:
          type: array
          items:
            $ref: '#/components/schemas/MemberDefinition'
          description: A list of MemberDefinition objects that contains objects that identify the workers that make up the
            work team. Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private
            workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC
            identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single
            request. For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups
            within the user pool used to create a workforce. A
        Description:
          type: string
          description: A description of the work team.
        NotificationConfiguration:
          $ref: '#/components/schemas/NotificationConfiguration'
        WorkerAccessConfiguration:
          $ref: '#/components/schemas/WorkerAccessConfiguration'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array of key-value pairs. For more information, see Resource Tag and Using Cost Allocation Tags
            in the Amazon Web Services Billing and Cost Management User Guide.
      required:
      - WorkteamName
      - MemberDefinitions
      - Description
    CreateWorkteamResponse:
      type: object
      properties:
        WorkteamArn:
          type: string
          description: The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.
    DeleteWorkteamRequest:
      type: object
      properties:
        WorkteamName:
          type: string
          description: The name of the work team to delete.
      required:
      - WorkteamName
    DeleteWorkteamResponse:
      type: object
      properties:
        Success:
          type: boolean
          description: Returns true if the work team was successfully deleted; otherwise, returns false.
      required:
      - Success
    DescribeWorkteamRequest:
      type: object
      properties:
        WorkteamName:
          type: string
          description: The name of the work team to return a description of.
      required:
      - WorkteamName
    DescribeWorkteamResponse:
      type: object
      properties:
        Workteam:
          $ref: '#/components/schemas/Workteam'
      required:
      - Workteam
    IamPolicyConstraints:
      type: object
      properties:
        SourceIp:
          type: string
          enum:
          - Enabled
          - Disabled
          description: When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added
            to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon
            S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal.
        VpcSourceIp:
          type: string
          enum:
          - Enabled
          - Disabled
          description: When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal
            inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render
            the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint,
            and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private
            worker portal, see Use Amazon VPC mode from a private worker portal.
    ListWorkteamsRequest:
      type: object
      properties:
        SortBy:
          type: string
          enum:
          - Name
          - CreateDate
          description: The field to sort results by. The default is CreationTime.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order for results. The default is Ascending.
        NameContains:
          type: string
          description: A string in the work team's name. This filter returns only work teams whose name contains the specified
            string.
        NextToken:
          type: string
          description: If the result of the previous ListWorkteams request was truncated, the response includes a NextToken.
            To retrieve the next set of labeling jobs, use the token in the next request.
        MaxResults:
          type: integer
          description: The maximum number of work teams to return in each page of the response.
    ListWorkteamsResponse:
      type: object
      properties:
        Workteams:
          type: array
          items:
            $ref: '#/components/schemas/Workteam'
          description: An array of Workteam objects, each describing a work team.
        NextToken:
          type: string
          description: If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work
            teams, use it in the subsequent request.
      required:
      - Workteams
    MemberDefinition:
      type: object
      properties:
        CognitoMemberDefinition:
          $ref: '#/components/schemas/CognitoMemberDefinition'
        OidcMemberDefinition:
          $ref: '#/components/schemas/OidcMemberDefinition'
    NotificationConfiguration:
      type: object
      properties:
        NotificationTopicArn:
          type: string
          description: The ARN for the Amazon SNS topic to which notifications should be published.
    OidcMemberDefinition:
      type: object
      properties:
        Groups:
          type: array
          items:
            type: string
          description: A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is
            made up of a group of private workers.
    ResourceInUse:
      type: object
      properties:
        Message:
          type: string
    ResourceLimitExceeded:
      type: object
      properties:
        Message:
          type: string
    S3Presign:
      type: object
      properties:
        IamPolicyConstraints:
          $ref: '#/components/schemas/IamPolicyConstraints'
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag key. Tag keys must be unique per resource.
        Value:
          type: string
          description: The tag value.
      required:
      - Key
      - Value
    UpdateWorkteamRequest:
      type: object
      properties:
        WorkteamName:
          type: string
          description: The name of the work team to update.
        MemberDefinitions:
          type: array
          items:
            $ref: '#/components/schemas/MemberDefinition'
          description: A list of MemberDefinition objects that contains objects that identify the workers that make up the
            work team. Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private
            workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC
            identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of these parameters in
            a single request. For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito
            user groups within the user pool used to create a work
        Description:
          type: string
          description: An updated description for the work team.
        NotificationConfiguration:
          $ref: '#/components/schemas/NotificationConfiguration'
        WorkerAccessConfiguration:
          $ref: '#/components/schemas/WorkerAccessConfiguration'
      required:
      - WorkteamName
    UpdateWorkteamResponse:
      type: object
      properties:
        Workteam:
          $ref: '#/components/schemas/Workteam'
      required:
      - Workteam
    WorkerAccessConfiguration:
      type: object
      properties:
        S3Presign:
          $ref: '#/components/schemas/S3Presign'
    Workteam:
      type: object
      properties:
        WorkteamName:
          type: string
          description: The name of the work team.
        MemberDefinitions:
          type: array
          items:
            $ref: '#/components/schemas/MemberDefinition'
          description: A list of MemberDefinition objects that contains objects that identify the workers that make up the
            work team. Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private
            workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC
            identity provider (IdP) use OidcMemberDefinition.
        WorkteamArn:
          type: string
          description: The Amazon Resource Name (ARN) that identifies the work team.
        WorkforceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the workforce.
        ProductListingIds:
          type: array
          items:
            type: string
          description: The Amazon Marketplace identifier for a vendor's work team.
        Description:
          type: string
          description: A description of the work team.
        SubDomain:
          type: string
          description: The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.
        CreateDate:
          type: string
          format: date-time
          description: The date and time that the work team was created (timestamp).
        LastUpdatedDate:
          type: string
          format: date-time
          description: The date and time that the work team was last updated (timestamp).
        NotificationConfiguration:
          $ref: '#/components/schemas/NotificationConfiguration'
        WorkerAccessConfiguration:
          $ref: '#/components/schemas/WorkerAccessConfiguration'
      required:
      - WorkteamName
      - MemberDefinitions
      - WorkteamArn
      - Description
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/sagemaker/service/2017-07-24/sagemaker-2017-07-24.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)