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-fraud-detector:amazon-fraud-detector-external-model-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.2.0
info:
  title: Amazon Fraud Detector External Model API
  version: '2019-11-15'
  description: Generated from AWS's published Smithy model for Amazon Fraud Detector. 3 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://frauddetector.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: External Model
paths:
  /#DeleteExternalModel:
    post:
      operationId: DeleteExternalModel
      summary: Delete External Model
      description: Removes a SageMaker model from Amazon Fraud Detector. You can remove an Amazon SageMaker model if it is not associated with a detector version. Removing a SageMaker model disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteExternalModelResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSHawksNestServiceFacade.DeleteExternalModel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteExternalModelRequest'
      tags:
      - External Model
  /#GetExternalModels:
    post:
      operationId: GetExternalModels
      summary: Get External Models
      description: Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetExternalModelsResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSHawksNestServiceFacade.GetExternalModels
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetExternalModelsRequest'
      tags:
      - External Model
  /#PutExternalModel:
    post:
      operationId: PutExternalModel
      summary: Put External Model
      description: Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutExternalModelResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSHawksNestServiceFacade.PutExternalModel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutExternalModelRequest'
      tags:
      - External Model
components:
  schemas:
    GetExternalModelsRequest:
      type: object
      properties:
        modelEndpoint:
          type: string
          description: The Amazon SageMaker model endpoint.
        nextToken:
          type: string
          description: The next page token for the request.
        maxResults:
          type: integer
          description: The maximum number of objects to return for the request.
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteExternalModelRequest:
      type: object
      properties:
        modelEndpoint:
          type: string
          description: The endpoint of the Amazon Sagemaker model to delete.
      required:
      - modelEndpoint
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteExternalModelResult:
      type: object
      properties: {}
    ModelOutputConfiguration:
      type: object
      properties:
        format:
          type: string
          enum:
          - TEXT_CSV
          - APPLICATION_JSONLINES
          description: The format of the model output configuration.
        jsonKeyToVariableMap:
          type: object
          additionalProperties:
            type: string
          description: A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.
        csvIndexToVariableMap:
          type: object
          additionalProperties:
            type: string
          description: A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.
      required:
      - format
    GetExternalModelsResult:
      type: object
      properties:
        externalModels:
          type: array
          items:
            $ref: '#/components/schemas/ExternalModel'
          description: Gets the Amazon SageMaker models.
        nextToken:
          type: string
          description: The next page token to be used in subsequent requests.
    PutExternalModelResult:
      type: object
      properties: {}
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ExternalModel:
      type: object
      properties:
        modelEndpoint:
          type: string
          description: The Amazon SageMaker model endpoints.
        modelSource:
          type: string
          enum:
          - SAGEMAKER
          description: The source of the model.
        invokeModelEndpointRoleArn:
          type: string
          description: The role used to invoke the model.
        inputConfiguration:
          $ref: '#/components/schemas/ModelInputConfiguration'
        outputConfiguration:
          $ref: '#/components/schemas/ModelOutputConfiguration'
        modelEndpointStatus:
          type: string
          enum:
          - ASSOCIATED
          - DISSOCIATED
          description: The Amazon Fraud Detector status for the external model endpoint
        lastUpdatedTime:
          type: string
          description: Timestamp of when the model was last updated.
        createdTime:
          type: string
          description: Timestamp of when the model was last created.
        arn:
          type: string
          description: The model ARN.
    PutExternalModelRequest:
      type: object
      properties:
        modelEndpoint:
          type: string
          description: The model endpoints name.
        modelSource:
          type: string
          enum:
          - SAGEMAKER
          description: The source of the model.
        invokeModelEndpointRoleArn:
          type: string
          description: The IAM role used to invoke the model endpoint.
        inputConfiguration:
          $ref: '#/components/schemas/ModelInputConfiguration'
        outputConfiguration:
          $ref: '#/components/schemas/ModelOutputConfiguration'
        modelEndpointStatus:
          type: string
          enum:
          - ASSOCIATED
          - DISSOCIATED
          description: The model endpoint’s status in Amazon Fraud Detector.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A collection of key and value pairs.
      required:
      - modelEndpoint
      - modelSource
      - invokeModelEndpointRoleArn
      - inputConfiguration
      - outputConfiguration
      - modelEndpointStatus
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ModelInputConfiguration:
      type: object
      properties:
        eventTypeName:
          type: string
          description: The event type name.
        format:
          type: string
          enum:
          - TEXT_CSV
          - APPLICATION_JSON
          description: The format of the model input configuration. The format differs depending on if it is passed through to SageMaker or constructed by Amazon Fraud Detector.
        useEventVariables:
          type: boolean
          description: The event variables.
        jsonInputTemplate:
          type: string
          description: Template for constructing the JSON input-data sent to SageMaker. At event-evaluation, the placeholders for variable names in the template will be replaced with the variable values before being sent to SageMaker.
        csvInputTemplate:
          type: string
          description: Template for constructing the CSV input-data sent to SageMaker. At event-evaluation, the placeholders for variable-names in the template will be replaced with the variable values before being sent to SageMaker.
      required:
      - useEventVariables
    Tag:
      type: object
      properties:
        key:
          type: string
          description: A tag key.
        value:
          type: string
          description: A value assigned to a tag key.
      required:
      - key
      - value
  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: frauddetector
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/frauddetector/service/2019-11-15/frauddetector-2019-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)