Amazon Proton #X Amz Target=AwsProton20200720.GetServiceSyncBlockerSummary API

openapi: 3.2.0
info:
  version: 2020-07-20
  x-release: v4
  title: 'AWS Proton #X Amz Target=AwsProton20200720.GetServiceSyncBlo…'
  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.GetServiceSyncBlockerSummary'
paths:
  /#X-Amz-Target=AwsProton20200720.GetServiceSyncBlockerSummary:
    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: GetServiceSyncBlockerSummary
      description: Get detailed data for the service sync blocker summary.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetServiceSyncBlockerSummaryOutput'
        '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/GetServiceSyncBlockerSummaryInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AwsProton20200720.GetServiceSyncBlockerSummary
      summary: Amazon Proton Get Service Sync Blocker Summary
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AwsProton20200720.GetServiceSyncBlockerSummary'
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:
    ResourceName:
      type: string
      pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
      minLength: 1
      maxLength: 100
    ValidationException: {}
    ResourceNotFoundException: {}
    GetServiceSyncBlockerSummaryOutput:
      type: object
      properties:
        serviceSyncBlockerSummary:
          allOf:
          - $ref: '#/components/schemas/ServiceSyncBlockerSummary'
          - description: The detailed data of the requested service sync blocker summary.
    String:
      type: string
    BlockerType:
      type: string
      enum:
      - AUTOMATED
    ServiceSyncBlockerSummary:
      type: object
      required:
      - serviceName
      properties:
        latestBlockers:
          allOf:
          - $ref: '#/components/schemas/LatestSyncBlockers'
          - description: The latest active blockers for the synced service.
        serviceInstanceName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the service instance that you want sync your service configuration with.
        serviceName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The name of the service that you want to get the sync blocker summary for. If given a service instance name and a service name, it will return the blockers only applying to the instance that is blocked.</p> <p>If given only a service name, it will return the blockers that apply to all of the instances. In order to get the blockers for a single instance, you will need to make two distinct calls, one to get the sync blocker summary for the service and the other to get the sync blocker for the service instance.</p>
      description: <p>If a service instance is manually updated, Proton wants to prevent accidentally overriding a manual change.</p> <p>A blocker is created because of the manual update or deletion of a service instance. The summary describes the blocker as being active or resolved.</p>
    GetServiceSyncBlockerSummaryInput:
      type: object
      required:
      - serviceName
      title: GetServiceSyncBlockerSummaryInput
      properties:
        serviceInstanceName:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: The name of the service instance that you want to get the service sync blocker summary for. If given bothe the instance name and the service name, only the instance is blocked.
        serviceName:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: The name of the service that you want to get the service sync blocker summary for. If given only the service name, all instances are blocked.
    SyncBlockerContexts:
      type: array
      items:
        $ref: '#/components/schemas/SyncBlockerContext'
    ThrottlingException: {}
    SyncBlockerContext:
      type: object
      required:
      - key
      - value
      properties:
        key:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The key for the sync blocker context.
        value:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The value of the sync blocker context.
      description: Detailed data of the context of the sync blocker.
    Timestamp:
      type: string
      format: date-time
    LatestSyncBlockers:
      type: array
      items:
        $ref: '#/components/schemas/SyncBlocker'
    BlockerStatus:
      type: string
      enum:
      - ACTIVE
      - RESOLVED
    SyncBlocker:
      type: object
      required:
      - createdAt
      - createdReason
      - id
      - status
      - type
      properties:
        contexts:
          allOf:
          - $ref: '#/components/schemas/SyncBlockerContexts'
          - description: The contexts for the sync blocker.
        createdAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when the sync blocker was created.
        createdReason:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The reason why the sync blocker was created.
        id:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The ID of the sync blocker.
        resolvedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time the sync blocker was resolved.
        resolvedReason:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The reason the sync blocker was resolved.
        status:
          allOf:
          - $ref: '#/components/schemas/BlockerStatus'
          - description: The status of the sync blocker.
        type:
          allOf:
          - $ref: '#/components/schemas/BlockerType'
          - description: The type of the sync blocker.
      description: Detailed data of the sync blocker.
    AccessDeniedException: {}
    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