Amazon Web Services, Inc.

AWS Artifact

This reference provides descriptions of the low-level AWS Artifact Service API.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This reference provides descriptions of the low-level AWS Artifact Service API.

Endpoints 17

Compliance inquiry

  • POSTCreate compliance inquiry/v1/compliance-inquiry/createCreate a new compliance inquiry.
  • POSTExport compliance inquiry/v1/compliance-inquiry/exportExport a compliance inquiry report.
  • GETGet compliance inquiry metadata/v1/compliance-inquiry/getMetadata?complianceInquiryId=stringGet the metadata for a single compliance inquiry.
  • GETList compliance inquiries/v1/compliance-inquiry/list?maxResults=0&nextToken=stringList available compliance inquiries.
  • GETList compliance inquiry queries/v1/compliance-inquiry/listQueries?complianceInquiryId=string&maxResults=0&nextToken=stringList queries within a compliance inquiry.
  • PUTPut compliance inquiry feedback/v1/compliance-inquiry/putFeedbackSubmits feedback on a compliance inquiry response.

Account settings

  • GETGet account settings/v1/account-settings/getGet the account settings for Artifact.
  • PUTPut account settings/v1/account-settings/putPut the account settings for Artifact.

Report

  • GETGet report/v1/report/get?reportId=string&reportVersion=0&termToken=stringGet the content for a single report.
  • GETGet report metadata/v1/report/getMetadata?reportId=string&reportVersion=0Get the metadata for a single report.
  • GETGet term for report/v1/report/getTermForReport?reportId=string&reportVersion=0Get the Term content associated with a single report.
  • GETList report versions/v1/report/listVersions?reportId=string&maxResults=0&nextToken=stringList available report versions for a given report.
  • GETList reports/v1/report/list?maxResults=0&nextToken=stringList available reports.

Customer agreement

  • GETList customer agreements/v1/customer-agreement/list?maxResults=0&nextToken=stringList active customer-agreements applicable to calling identity.
  • GETList tags for resource/tags/:resourceArnList tags for a resource.
  • POSTTag resource/tags/:resourceArnAdd tags to a resource.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Remove tags from a resource.

API details

Base URL
https://artifact.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
17 operations on 15 pathsGET 11POST 3PUT 2DELETE 1
Main resources
Compliance inquiry 6Report 5Account settings 2Customer agreement 1
Description format
AWS Smithy model, API version 2018-05-10

How to test the AWS Artifact in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Artifact collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create compliance inquiry” (POST /v1/compliance-inquiry/create), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Artifact?

This reference provides descriptions of the low-level AWS Artifact Service API. It is listed under Developer tools and has 17 endpoints.

Who publishes the AWS Artifact?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Artifact?

Requests go to https://artifact.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Artifact?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Artifact have?

17 operations on 15 paths (11 GET, 3 POST, 2 PUT, 1 DELETE). The largest groups are Compliance inquiry, Report, Account settings, Customer agreement.

Is forking the AWS Artifact free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.