Amazon Detective Invitations API

openapi: 3.1.0
info:
  title: Amazon Detective Invitations API
  version: '2018-10-26'
  description: Generated from AWS's published Smithy model for Amazon Detective. 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://api.detective.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /invitation:
    put:
      operationId: AcceptInvitation
      summary: Accept Invitation
      description: Accepts an invitation for the member account to contribute data to a behavior graph. This operation can
        only be called by an invited member account. The request provides the ARN of behavior graph. The member account status
        in the graph must be INVITED.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/AcceptInvitationRequest'
      tags:
      - Invitations
  /invitations/list:
    post:
      operationId: ListInvitations
      summary: List Invitations
      description: Retrieves the list of open and accepted behavior graph invitations for the member account. This operation
        can only be called by an invited member account. Open invitations are invitations that the member account has not
        responded to. The results do not include behavior graphs for which the member account declined the invitation. The
        results also do not include behavior graphs that the member account resigned from or was removed from.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInvitationsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListInvitationsRequest'
      tags:
      - Invitations
  /invitation/removal:
    post:
      operationId: RejectInvitation
      summary: Reject Invitation
      description: Rejects an invitation to contribute the account data to a behavior graph. This operation must be called
        by an invited member account that has the INVITED status. RejectInvitation cannot be called by an organization account
        in the organization behavior graph. In the organization behavior graph, organization accounts do not receive an invitation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/RejectInvitationRequest'
      tags:
      - Invitations
  /membership/removal:
    post:
      operationId: DisassociateMembership
      summary: Disassociate Membership
      description: Removes the member account from the specified behavior graph. This operation can only be called by an invited
        member account that has the ENABLED status. DisassociateMembership cannot be called by an organization account in
        the organization behavior graph. For the organization behavior graph, the Detective administrator account determines
        which organization accounts to enable or disable as member accounts.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/DisassociateMembershipRequest'
      tags:
      - Invitations
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: detective
  schemas:
    AcceptInvitationRequest:
      type: object
      properties:
        GraphArn:
          type: string
          description: The ARN of the behavior graph that the member account is accepting the invitation for. The member account
            status in the behavior graph must be INVITED.
      required:
      - GraphArn
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        ErrorCode:
          type: string
          enum:
          - INVALID_GRAPH_ARN
          - INVALID_REQUEST_BODY
          - INTERNAL_ERROR
          description: The SDK default error code associated with the access denied exception.
        ErrorCodeReason:
          type: string
          description: The SDK default explanation of why access was denied.
        SubErrorCode:
          type: string
          enum:
          - INVALID_GRAPH_ARN
          - INVALID_REQUEST_BODY
          - INTERNAL_ERROR
          description: The error code associated with the access denied exception.
        SubErrorCodeReason:
          type: string
          description: An explanation of why access was denied.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    DatasourcePackageUsageInfo:
      type: object
      properties:
        VolumeUsageInBytes:
          type: integer
          description: Total volume of data in bytes per day ingested for a given data source package.
        VolumeUsageUpdateTime:
          type: string
          format: date-time
          description: The data and time when the member account data volume was last updated. The value is an ISO8601 formatted
            string. For example, 2021-08-18T16:35:56.284Z.
    DisassociateMembershipRequest:
      type: object
      properties:
        GraphArn:
          type: string
          description: The ARN of the behavior graph to remove the member account from. The member account's member status
            in the behavior graph must be ENABLED.
      required:
      - GraphArn
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ListInvitationsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: For requests to retrieve the next page of results, the pagination token that was returned with the
            previous page of results. The initial request does not include a pagination token.
        MaxResults:
          type: integer
          description: The maximum number of behavior graph invitations to return in the response. The total must be less
            than the overall limit on the number of results to return, which is currently 200.
    ListInvitationsResponse:
      type: object
      properties:
        Invitations:
          type: array
          items:
            $ref: '#/components/schemas/MemberDetail'
          description: The list of behavior graphs for which the member account has open or accepted invitations.
        NextToken:
          type: string
          description: If there are more behavior graphs remaining in the results, then this is the pagination token to use
            to request the next page of behavior graphs.
    MemberDetail:
      type: object
      properties:
        AccountId:
          type: string
          description: The Amazon Web Services account identifier for the member account.
        EmailAddress:
          type: string
          description: The Amazon Web Services account root user email address for the member account.
        GraphArn:
          type: string
          description: The ARN of the behavior graph.
        MasterId:
          type: string
          description: The Amazon Web Services account identifier of the administrator account for the behavior graph.
        AdministratorId:
          type: string
          description: The Amazon Web Services account identifier of the administrator account for the behavior graph.
        Status:
          type: string
          enum:
          - INVITED
          - VERIFICATION_IN_PROGRESS
          - VERIFICATION_FAILED
          - ENABLED
          - ACCEPTED_BUT_DISABLED
          description: 'The current membership status of the member account. The status can have one of the following values:
            INVITED - For invited accounts only. Indicates that the member was sent an invitation but has not yet responded.
            VERIFICATION_IN_PROGRESS - For invited accounts only, indicates that Detective is verifying that the account identifier
            and email address provided for the member account match. If they do match, then Detective sends the invitation.
            If the email address and account identifier don''t match, then the member cannot be added to the behavior graph.
            For organization accounts in the organiza'
        DisabledReason:
          type: string
          enum:
          - VOLUME_TOO_HIGH
          - VOLUME_UNKNOWN
          description: 'For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is
            not enabled. The reason can have one of the following values: VOLUME_TOO_HIGH - Indicates that adding the member
            account would cause the data volume for the behavior graph to be too high. VOLUME_UNKNOWN - Indicates that Detective
            is unable to verify the data volume for the member account. This is usually because the member account is not
            enrolled in Amazon GuardDuty.'
        InvitedTime:
          type: string
          format: date-time
          description: For invited accounts, the date and time that Detective sent the invitation to the account. The value
            is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
        UpdatedTime:
          type: string
          format: date-time
          description: The date and time that the member account was last updated. The value is an ISO8601 formatted string.
            For example, 2021-08-18T16:35:56.284Z.
        VolumeUsageInBytes:
          type: integer
          description: The data volume in bytes per day for the member account.
        VolumeUsageUpdatedTime:
          type: string
          format: date-time
          description: The data and time when the member account data volume was last updated. The value is an ISO8601 formatted
            string. For example, 2021-08-18T16:35:56.284Z.
        PercentOfGraphUtilization:
          type: number
          description: The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent,
            and 100 indicates 100 percent. Note that this is not the percentage of the behavior graph data volume. For example,
            the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data
            volume for the member account is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of the
            maximum allowed data volume.
        PercentOfGraphUtilizationUpdatedTime:
          type: string
          format: date-time
          description: The date and time when the graph utilization percentage was last updated. The value is an ISO8601 formatted
            string. For example, 2021-08-18T16:35:56.284Z.
        InvitationType:
          type: string
          enum:
          - INVITATION
          - ORGANIZATION
          description: The type of behavior graph membership. For an organization account in the organization behavior graph,
            the type is ORGANIZATION. For an account that was invited to a behavior graph, the type is INVITATION.
        VolumeUsageByDatasourcePackage:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DatasourcePackageUsageInfo'
          description: Details on the volume of usage for each data source package in a behavior graph.
        DatasourcePackageIngestStates:
          type: object
          additionalProperties:
            type: string
            enum:
            - STARTED
            - STOPPED
            - DISABLED
          description: The state of a data source package for the behavior graph.
    RejectInvitationRequest:
      type: object
      properties:
        GraphArn:
          type: string
          description: The ARN of the behavior graph to reject the invitation to. The member account's current member status
            in the behavior graph must be INVITED.
      required:
      - GraphArn
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ValidationException:
      type: object
      properties:
        Message:
          type: string
        ErrorCode:
          type: string
          enum:
          - INVALID_GRAPH_ARN
          - INVALID_REQUEST_BODY
          - INTERNAL_ERROR
          description: The error code associated with the validation failure.
        ErrorCodeReason:
          type: string
          description: An explanation of why validation failed.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/detective/service/2018-10-26/detective-2018-10-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)