find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-connect:amazon-connect-stop-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Amazon Connect Service Stop API
  version: '2017-08-08'
  description: Generated from AWS's published Smithy model for Amazon Connect Service. 4 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://profile.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /campaigns/{id}/stop:
    post:
      operationId: StopCampaign
      summary: Stop Campaign
      description: Stops a campaign for the specified Amazon Connect account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '409':
          description: ConflictException; InvalidCampaignStateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopCampaignRequest'
      tags:
      - Stop
      servers:
      - url: https://connect-campaigns.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_connect_campaigns: []
  /v2/campaigns/{id}/stop:
    post:
      operationId: StopCampaign
      summary: Stop Campaign
      description: Stops a campaign for the specified Amazon Connect account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsAccessDeniedException'
        '409':
          description: ConflictException; InvalidCampaignStateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectCampaignsValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopCampaignRequest'
      tags:
      - Stop
      servers:
      - url: https://connect-campaigns.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
      security:
      - sigv4_connect_campaigns: []
  /domains/{DomainName}/recommenders/{RecommenderName}/stop:
    put:
      operationId: StopRecommender
      summary: Stop Recommender
      description: Stops a recommender, suspending its ability to generate recommendations. The recommender can be restarted
        later using StartRecommender.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopRecommenderResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopRecommenderRequest'
      tags:
      - Stop
  /domains/{DomainName}/upload-jobs/{JobId}/stop:
    put:
      operationId: StopUploadJob
      summary: Stop Upload Job
      description: This API stops the processing of an upload job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopUploadJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopUploadJobRequest'
      tags:
      - Stop
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: profile
    sigv4_connect_campaigns:
      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: connect-campaigns
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
    ConnectCampaignsAccessDeniedException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsConflictException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsInternalServerException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsThrottlingException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ConnectCampaignsValidationException:
      type: object
      properties:
        message:
          type: string
        xAmzErrorType:
          type: string
      required:
      - message
    ProfileInternalServerException:
      type: object
      properties:
        Message:
          type: string
    ProfileResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    StopCampaignRequest:
      type: object
      properties:
        id:
          type: string
      required:
      - id
    StopRecommenderRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain.
        RecommenderName:
          type: string
          description: The name of the recommender to stop.
      required:
      - DomainName
      - RecommenderName
    StopRecommenderResponse:
      type: object
      properties: {}
    StopUploadJobRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The unique name of the domain containing the upload job to stop.
        JobId:
          type: string
          description: The unique identifier of the upload job to stop.
      required:
      - DomainName
      - JobId
    StopUploadJobResponse:
      type: object
      properties: {}
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/customer-profiles/service/2020-08-15/customer-profiles-2020-08-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/customer-profiles/service/2020-08-15/customer-profiles-2020-08-15.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcampaigns/service/2021-01-30/connectcampaigns-2021-01-30.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/connectcampaignsv2/service/2024-04-23/connectcampaignsv2-2024-04-23.json