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-audit-manager:amazon-audit-manager-account-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: AWS Audit Manager Account API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS Audit Manager. 6 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://auditmanager.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Account
paths:
  /account/deregisterAccount:
    post:
      operationId: DeregisterAccount
      summary: Deregister Account
      description: Deregisters an account in Audit Manager. Before you deregister, you can use the UpdateSettings API operation to set your preferred data retention policy. By default, Audit Manager retains your data. If you want to delete your data, you can use the DeregistrationPolicy attribute to request the deletion of your data. For more information about data retention, see Data Protection in the Audit Manager User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeregisterAccountResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeregisterAccountRequest'
      tags:
      - Account
  /account/deregisterOrganizationAdminAccount:
    post:
      operationId: DeregisterOrganizationAdminAccount
      summary: Deregister Organization Admin Account
      description: 'Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager. When you remove a delegated administrator from your Audit Manager settings, you continue to have access to the evidence that you previously collected under that account. This is also the case when you deregister a delegated administrator from Organizations. However, Audit Manager stops collecting and attaching evidence to that delegated administrator account moving forward. Keep in mind the following cleanup task if you use evidence finder: Before you use your management account to remove a delegated administrator, make sure that the current delegated administrator account signs in to Audit Manager and disables evidence finder first. Disabling evidence finder automatically deletes the event data store that was created in their account when they enabled evidence finder. If this task isn’t completed, the event data store remains in their account. In this case, we recommend that the original delegated administrator goes to CloudTrail Lake and manually deletes the event data store. This cleanup task is necessary to ensure that you don''t end up with multiple event data stores. Audit Manager'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeregisterOrganizationAdminAccountResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeregisterOrganizationAdminAccountRequest'
      tags:
      - Account
  /account/status:
    get:
      operationId: GetAccountStatus
      summary: Get Account Status
      description: Gets the registration status of an account in Audit Manager.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountStatusResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAccountStatusRequest'
      tags:
      - Account
  /account/organizationAdminAccount:
    get:
      operationId: GetOrganizationAdminAccount
      summary: Get Organization Admin Account
      description: Gets the name of the delegated Amazon Web Services administrator account for a specified organization.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrganizationAdminAccountResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOrganizationAdminAccountRequest'
      tags:
      - Account
  /account/registerAccount:
    post:
      operationId: RegisterAccount
      summary: Register Account
      description: Enables Audit Manager for the specified Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterAccountResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterAccountRequest'
      tags:
      - Account
  /account/registerOrganizationAdminAccount:
    post:
      operationId: RegisterOrganizationAdminAccount
      summary: Register Organization Admin Account
      description: Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterOrganizationAdminAccountResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterOrganizationAdminAccountRequest'
      tags:
      - Account
components:
  schemas:
    RegisterOrganizationAdminAccountRequest:
      type: object
      properties:
        adminAccountId:
          type: string
          description: The identifier for the delegated administrator account.
      required:
      - adminAccountId
    GetOrganizationAdminAccountRequest:
      type: object
      properties: {}
    GetAccountStatusResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          - PENDING_ACTIVATION
          description: The status of the Amazon Web Services account.
    DeregisterAccountRequest:
      type: object
      properties: {}
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    RegisterAccountRequest:
      type: object
      properties:
        kmsKey:
          type: string
          description: The KMS key details.
        delegatedAdminAccount:
          type: string
          description: The delegated administrator account for Audit Manager.
    RegisterAccountResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          - PENDING_ACTIVATION
          description: The status of the account registration request.
    DeregisterOrganizationAdminAccountRequest:
      type: object
      properties:
        adminAccountId:
          type: string
          description: The identifier for the administrator account.
    GetAccountStatusRequest:
      type: object
      properties: {}
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the validation error.
        message:
          type: string
          description: The body of the error message.
      required:
      - name
      - message
    GetOrganizationAdminAccountResponse:
      type: object
      properties:
        adminAccountId:
          type: string
          description: The identifier for the administrator account.
        organizationId:
          type: string
          description: The identifier for the organization.
    RegisterOrganizationAdminAccountResponse:
      type: object
      properties:
        adminAccountId:
          type: string
          description: The identifier for the delegated administrator account.
        organizationId:
          type: string
          description: The identifier for the organization.
    DeregisterAccountResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          - PENDING_ACTIVATION
          description: The registration status of the account.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The unique identifier for the resource.
        resourceType:
          type: string
          description: The type of resource that's affected by the error.
      required:
      - message
      - resourceId
      - resourceType
    DeregisterOrganizationAdminAccountResponse:
      type: object
      properties: {}
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - unknownOperation
          - cannotParse
          - fieldValidationFailed
          - other
          description: The reason the request failed validation.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The fields that caused the error, if applicable.
      required:
      - message
  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: auditmanager
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/auditmanager/service/2017-07-25/auditmanager-2017-07-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)