Amazon Proton #X Amz Target=AwsProton20200720.GetRepositorySyncStatus API

openapi: 3.2.0
info:
  version: 2020-07-20
  x-release: v4
  title: 'AWS Proton #X Amz Target=AwsProton20200720.GetRepositorySync…'
  description: This is the Proton Service API Reference.
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: proton
  x-aws-signingName: proton
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/proton-2020-07-20.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://proton.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Proton multi-region endpoint
- url: https://proton.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Proton multi-region endpoint
- url: http://proton.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Proton endpoint for China (Beijing) and China (Ningxia)
- url: https://proton.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Proton endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AwsProton20200720.GetRepositorySyncStatus'
paths:
  /#X-Amz-Target=AwsProton20200720.GetRepositorySyncStatus:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: GetRepositorySyncStatus
      description: 'Get the sync status of a repository used for Proton template sync. For more information about template sync, see .


        A repository sync status isn''t tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can''t use these tags to control access to this action using Attribute-based access control (ABAC).


        For more information about ABAC, see ABAC in the Proton User Guide.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRepositorySyncStatusOutput'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '484':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetRepositorySyncStatusInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AwsProton20200720.GetRepositorySyncStatus
      summary: Amazon Proton Get Repository Sync Status
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AwsProton20200720.GetRepositorySyncStatus'
components:
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
  schemas:
    ValidationException: {}
    RepositoryName:
      type: string
      pattern: '[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*'
      minLength: 1
      maxLength: 100
    ResourceNotFoundException: {}
    GetRepositorySyncStatusInput:
      type: object
      required:
      - branch
      - repositoryName
      - repositoryProvider
      - syncType
      title: GetRepositorySyncStatusInput
      properties:
        branch:
          allOf:
          - $ref: '#/components/schemas/GitBranchName'
          - description: The repository branch.
        repositoryName:
          allOf:
          - $ref: '#/components/schemas/RepositoryName'
          - description: The repository name.
        repositoryProvider:
          allOf:
          - $ref: '#/components/schemas/RepositoryProvider'
          - description: The repository provider.
        syncType:
          allOf:
          - $ref: '#/components/schemas/SyncType'
          - description: The repository sync type.
    RepositorySyncStatus:
      type: string
      enum:
      - INITIATED
      - IN_PROGRESS
      - SUCCEEDED
      - FAILED
      - QUEUED
    RepositorySyncEvents:
      type: array
      items:
        $ref: '#/components/schemas/RepositorySyncEvent'
    String:
      type: string
    RepositoryProvider:
      type: string
      enum:
      - GITHUB
      - GITHUB_ENTERPRISE
      - BITBUCKET
    RepositorySyncAttempt:
      type: object
      required:
      - events
      - startedAt
      - status
      properties:
        events:
          allOf:
          - $ref: '#/components/schemas/RepositorySyncEvents'
          - description: Detail data for sync attempt events.
        startedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when the sync attempt started.
        status:
          allOf:
          - $ref: '#/components/schemas/RepositorySyncStatus'
          - description: The sync attempt status.
      description: Detail data for a repository sync attempt activated by a push to a repository.
    ThrottlingException: {}
    SyncType:
      type: string
      enum:
      - TEMPLATE_SYNC
      - SERVICE_SYNC
    Timestamp:
      type: string
      format: date-time
    RepositorySyncEvent:
      type: object
      required:
      - event
      - time
      - type
      properties:
        event:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Event detail for a repository sync attempt.
        externalId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The external ID of the sync event.
        time:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time that the sync event occurred.
        type:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The type of event.
      description: Repository sync event detail data for a sync attempt.
    GetRepositorySyncStatusOutput:
      type: object
      properties:
        latestSync:
          allOf:
          - $ref: '#/components/schemas/RepositorySyncAttempt'
          - description: The repository sync status detail data that's returned by Proton.
    AccessDeniedException: {}
    GitBranchName:
      type: string
      minLength: 1
      maxLength: 200
    InternalServerException: {}
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/proton/
x-hasEquivalentPaths: true