Amazon SageMaker Sagemaker Code Repository API

openapi: 3.1.0
info:
  title: Amazon SageMaker Service Code Repository 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:
  /#CreateCodeRepository:
    post:
      operationId: CreateCodeRepository
      summary: Create Code Repository
      description: Creates a Git repository as a resource in your SageMaker AI account. You can associate the repository with
        notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource
        in your SageMaker AI account, so it can be associated with more than one notebook instance, and it persists independently
        from the lifecycle of any notebook instances it is associated with. The repository can be hosted either in Amazon
        Web Services CodeCommit or in any other Git repository.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateCodeRepositoryOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.CreateCodeRepository
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateCodeRepositoryInput'
      tags:
      - Code Repository
  /#DeleteCodeRepository:
    post:
      operationId: DeleteCodeRepository
      summary: Delete Code Repository
      description: Deletes the specified Git repository from your account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DeleteCodeRepository
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteCodeRepositoryInput'
      tags:
      - Code Repository
  /#DescribeCodeRepository:
    post:
      operationId: DescribeCodeRepository
      summary: Describe Code Repository
      description: Gets details about the specified Git repository.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeCodeRepositoryOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.DescribeCodeRepository
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeCodeRepositoryInput'
      tags:
      - Code Repository
  /#ListCodeRepositories:
    post:
      operationId: ListCodeRepositories
      summary: List Code Repositories
      description: Gets a list of the Git repositories in your account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListCodeRepositoriesOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.ListCodeRepositories
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListCodeRepositoriesInput'
      tags:
      - Code Repository
  /#UpdateCodeRepository:
    post:
      operationId: UpdateCodeRepository
      summary: Update Code Repository
      description: Updates the specified Git repository with the specified values.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateCodeRepositoryOutput'
        '400':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - SageMaker.UpdateCodeRepository
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateCodeRepositoryInput'
      tags:
      - Code Repository
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:
    CodeRepositorySummary:
      type: object
      properties:
        CodeRepositoryName:
          type: string
          description: The name of the Git repository.
        CodeRepositoryArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Git repository.
        CreationTime:
          type: string
          format: date-time
          description: The date and time that the Git repository was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time that the Git repository was last modified.
        GitConfig:
          $ref: '#/components/schemas/GitConfig'
      required:
      - CodeRepositoryName
      - CodeRepositoryArn
      - CreationTime
      - LastModifiedTime
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateCodeRepositoryInput:
      type: object
      properties:
        CodeRepositoryName:
          type: string
          description: The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z,
            0-9, and - (hyphen).
        GitConfig:
          $ref: '#/components/schemas/GitConfig'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different
            ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
      required:
      - CodeRepositoryName
      - GitConfig
    CreateCodeRepositoryOutput:
      type: object
      properties:
        CodeRepositoryArn:
          type: string
          description: The Amazon Resource Name (ARN) of the new repository.
      required:
      - CodeRepositoryArn
    DeleteCodeRepositoryInput:
      type: object
      properties:
        CodeRepositoryName:
          type: string
          description: The name of the Git repository to delete.
      required:
      - CodeRepositoryName
    DescribeCodeRepositoryInput:
      type: object
      properties:
        CodeRepositoryName:
          type: string
          description: The name of the Git repository to describe.
      required:
      - CodeRepositoryName
    DescribeCodeRepositoryOutput:
      type: object
      properties:
        CodeRepositoryName:
          type: string
          description: The name of the Git repository.
        CodeRepositoryArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Git repository.
        CreationTime:
          type: string
          format: date-time
          description: The date and time that the repository was created.
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time that the repository was last changed.
        GitConfig:
          $ref: '#/components/schemas/GitConfig'
      required:
      - CodeRepositoryName
      - CodeRepositoryArn
      - CreationTime
      - LastModifiedTime
    GitConfig:
      type: object
      properties:
        RepositoryUrl:
          type: string
          description: The URL where the Git repository is located.
        Branch:
          type: string
          description: The default branch for the Git repository.
        SecretArn:
          type: string
          description: 'The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the
            credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be
            in the following format: {"username": UserName, "password": Password}'
      required:
      - RepositoryUrl
    GitConfigForUpdate:
      type: object
      properties:
        SecretArn:
          type: string
          description: 'The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the
            credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be
            in the following format: {"username": UserName, "password": Password}'
    ListCodeRepositoriesInput:
      type: object
      properties:
        CreationTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only Git repositories that were created after the specified time.
        CreationTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only Git repositories that were created before the specified time.
        LastModifiedTimeAfter:
          type: string
          format: date-time
          description: A filter that returns only Git repositories that were last modified after the specified time.
        LastModifiedTimeBefore:
          type: string
          format: date-time
          description: A filter that returns only Git repositories that were last modified before the specified time.
        MaxResults:
          type: integer
          description: The maximum number of Git repositories to return in the response.
        NameContains:
          type: string
          description: A string in the Git repositories name. This filter returns only repositories whose name contains the
            specified string.
        NextToken:
          type: string
          description: If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken.
            To get the next set of Git repositories, use the token in the next request.
        SortBy:
          type: string
          enum:
          - Name
          - CreationTime
          - LastModifiedTime
          description: The field to sort results by. The default is Name.
        SortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order for results. The default is Ascending.
    ListCodeRepositoriesOutput:
      type: object
      properties:
        CodeRepositorySummaryList:
          type: array
          items:
            $ref: '#/components/schemas/CodeRepositorySummary'
          description: 'Gets a list of summaries of the Git repositories. Each summary specifies the following values for
            the repository: Name Amazon Resource Name (ARN) Creation time Last modified time Configuration information, including
            the URL location of the repository and the ARN of the Amazon Web Services Secrets Manager secret that contains
            the credentials used to access the repository.'
        NextToken:
          type: string
          description: If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken.
            To get the next set of Git repositories, use the token in the next request.
      required:
      - CodeRepositorySummaryList
    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
    UpdateCodeRepositoryInput:
      type: object
      properties:
        CodeRepositoryName:
          type: string
          description: The name of the Git repository to update.
        GitConfig:
          $ref: '#/components/schemas/GitConfigForUpdate'
      required:
      - CodeRepositoryName
    UpdateCodeRepositoryOutput:
      type: object
      properties:
        CodeRepositoryArn:
          type: string
          description: The ARN of the Git repository.
      required:
      - CodeRepositoryArn
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)