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-personalize:amazon-personalize-metric-attribution-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 Personalize Metric Attribution API
  version: '2018-05-22'
  description: Generated from AWS's published Smithy model for Amazon Personalize. 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://personalize.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Metric Attribution
paths:
  /#CreateMetricAttribution:
    post:
      operationId: CreateMetricAttribution
      summary: Create Metric Attribution
      description: Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateMetricAttributionResponse'
        '400':
          description: InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '409':
          description: LimitExceededException; ResourceInUseException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '403':
          description: ResourceAlreadyExistsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.CreateMetricAttribution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateMetricAttributionRequest'
      tags:
      - Metric Attribution
  /#DeleteMetricAttribution:
    post:
      operationId: DeleteMetricAttribution
      summary: Delete Metric Attribution
      description: Deletes a metric attribution.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '409':
          description: ResourceInUseException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.DeleteMetricAttribution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteMetricAttributionRequest'
      tags:
      - Metric Attribution
  /#DescribeMetricAttribution:
    post:
      operationId: DescribeMetricAttribution
      summary: Describe Metric Attribution
      description: Describes a metric attribution.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeMetricAttributionResponse'
        '400':
          description: InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.DescribeMetricAttribution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeMetricAttributionRequest'
      tags:
      - Metric Attribution
  /#ListMetricAttributions:
    post:
      operationId: ListMetricAttributions
      summary: List Metric Attributions
      description: Lists metric attributions.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListMetricAttributionsResponse'
        '400':
          description: InvalidInputException; InvalidNextTokenException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.ListMetricAttributions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListMetricAttributionsRequest'
      tags:
      - Metric Attribution
  /#UpdateMetricAttribution:
    post:
      operationId: UpdateMetricAttribution
      summary: Update Metric Attribution
      description: Updates a metric attribution.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateMetricAttributionResponse'
        '400':
          description: InvalidInputException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '403':
          description: ResourceAlreadyExistsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
        '409':
          description: ResourceInUseException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonPersonalize.UpdateMetricAttribution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateMetricAttributionRequest'
      tags:
      - Metric Attribution
components:
  schemas:
    DescribeMetricAttributionResponse:
      type: object
      properties:
        metricAttribution:
          $ref: '#/components/schemas/MetricAttribution'
    MetricAttribute:
      type: object
      properties:
        eventType:
          type: string
          description: The metric's event type.
        metricName:
          type: string
          description: The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
        expression:
          type: string
          description: The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
      required:
      - eventType
      - metricName
      - expression
    MetricAttributionSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the metric attribution.
        metricAttributionArn:
          type: string
          description: The metric attribution's Amazon Resource Name (ARN).
        status:
          type: string
          description: The metric attribution's status.
        creationDateTime:
          type: string
          format: date-time
          description: The metric attribution's creation date time.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The metric attribution's last updated date time.
        failureReason:
          type: string
          description: The metric attribution's failure reason.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    CreateMetricAttributionResponse:
      type: object
      properties:
        metricAttributionArn:
          type: string
          description: The Amazon Resource Name (ARN) for the new metric attribution.
    MetricAttributionOutput:
      type: object
      properties:
        s3DataDestination:
          $ref: '#/components/schemas/S3DataConfig'
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see Measuring impact of recommendations.
      required:
      - roleArn
    DescribeMetricAttributionRequest:
      type: object
      properties:
        metricAttributionArn:
          type: string
          description: The metric attribution's Amazon Resource Name (ARN).
      required:
      - metricAttributionArn
    ResourceAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
    MetricAttribution:
      type: object
      properties:
        name:
          type: string
          description: The metric attribution's name.
        metricAttributionArn:
          type: string
          description: The metric attribution's Amazon Resource Name (ARN).
        datasetGroupArn:
          type: string
          description: The metric attribution's dataset group Amazon Resource Name (ARN).
        metricsOutputConfig:
          $ref: '#/components/schemas/MetricAttributionOutput'
        status:
          type: string
          description: The metric attribution's status.
        creationDateTime:
          type: string
          format: date-time
          description: The metric attribution's creation date time.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The metric attribution's last updated date time.
        failureReason:
          type: string
          description: The metric attribution's failure reason.
    ListMetricAttributionsRequest:
      type: object
      properties:
        datasetGroupArn:
          type: string
          description: The metric attributions' dataset group Amazon Resource Name (ARN).
        nextToken:
          type: string
          description: Specify the pagination token from a previous request to retrieve the next page of results.
        maxResults:
          type: integer
          description: The maximum number of metric attributions to return in one page of results.
    UpdateMetricAttributionResponse:
      type: object
      properties:
        metricAttributionArn:
          type: string
          description: The Amazon Resource Name (ARN) for the metric attribution that you updated.
    UpdateMetricAttributionRequest:
      type: object
      properties:
        addMetrics:
          type: array
          items:
            $ref: '#/components/schemas/MetricAttribute'
          description: Add new metric attributes to the metric attribution.
        removeMetrics:
          type: array
          items:
            type: string
          description: Remove metric attributes from the metric attribution.
        metricsOutputConfig:
          $ref: '#/components/schemas/MetricAttributionOutput'
        metricAttributionArn:
          type: string
          description: The Amazon Resource Name (ARN) for the metric attribution to update.
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    CreateMetricAttributionRequest:
      type: object
      properties:
        name:
          type: string
          description: A name for the metric attribution.
        datasetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/MetricAttribute'
          description: A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
        metricsOutputConfig:
          $ref: '#/components/schemas/MetricAttributionOutput'
      required:
      - name
      - datasetGroupArn
      - metrics
      - metricsOutputConfig
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
    S3DataConfig:
      type: object
      properties:
        path:
          type: string
          description: The file path of the Amazon S3 bucket.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
      required:
      - path
    ResourceInUseException:
      type: object
      properties:
        message:
          type: string
    ListMetricAttributionsResponse:
      type: object
      properties:
        metricAttributions:
          type: array
          items:
            $ref: '#/components/schemas/MetricAttributionSummary'
          description: The list of metric attributions.
        nextToken:
          type: string
          description: Specify the pagination token from a previous request to retrieve the next page of results.
    DeleteMetricAttributionRequest:
      type: object
      properties:
        metricAttributionArn:
          type: string
          description: The metric attribution's Amazon Resource Name (ARN).
      required:
      - metricAttributionArn
  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: personalize
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/personalize/service/2018-05-22/personalize-2018-05-22.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)