Firebolt Aws.v2.tenants API

openapi: 3.2.0
info:
  title: Firebolt Aws.v2.tenants API
  version: 1.0.0
  x-logo:
    altText: Firebolt
    backgroundColor: '#FFFFFF'
    url: https://assets.website-files.com/5e8a264ceaf4870394477fc7/5e8a264ceaf4879f75477fdd_logo_website.svg
tags:
- name: aws.v2.tenants
  x-displayName: AWS Tenants
paths:
  /aws/v2/account/tenants:getTenantStatusByAccountId:
    post:
      tags:
      - aws.v2.tenants
      summary: Returns a tenant by account id without account id field.
      operationId: awsV2GetTenantStatusByAccountId
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firebolt.aws.v2.GetTenantStatusByAccountIdResponse'
        default:
          description: An unexpected error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
components:
  schemas:
    firebolt.aws.v2.TenantStatus:
      description: "SubscriptionStatus specifies the current status of subscription.\n\n - TENANT_STATUS_UNSPECIFIED: Tenant status not known.\n - TENANT_STATUS_CREATED: Tenant record created, but tenant creation process haven't been started\n - TENANT_STATUS_CREATING: Tenant record created, tenant creation started.\n - TENANT_STATUS_FAILED: Tenant creation failed\n - TENANT_STATUS_ACTIVE: Tenant created and could be used for further activities"
      type: string
      default: TENANT_STATUS_UNSPECIFIED
      enum:
      - TENANT_STATUS_UNSPECIFIED
      - TENANT_STATUS_CREATED
      - TENANT_STATUS_CREATING
      - TENANT_STATUS_FAILED
      - TENANT_STATUS_ACTIVE
    firebolt.aws.v2.GetTenantStatusByAccountIdResponse:
      type: object
      properties:
        status:
          description: Status of this tenant.
          $ref: '#/components/schemas/firebolt.aws.v2.TenantStatus'
    google.protobuf.Any:
      description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
      type: object
      properties:
        type_url:
          description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
          type: string
        value:
          description: Must be a valid serialized protocol buffer of the above specified type.
          type: string
          format: byte
    grpc.gateway.runtime.Error:
      type: object
      properties:
        code:
          type: integer
          format: int32
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
        error:
          type: string
        message:
          type: string
x-tagGroups:
- name: Getting Started
  tags:
  - auth.v1
- name: Identity & Access Management
  tags:
  - iam.v2.roles
  - iam.v2.permissions
  - iam.v2.policies
  - iam.v2.databaseGrants
  - iam.v2.accounts
  - iam.v2.users
  - iam.v2.accountMembers
  - iam.v2.serviceAccounts
  - iam.v2.actors
- name: Cloud Providers
  tags:
  - aws.v2.marketplace
- name: Compute Resources
  tags:
  - compute.v1.instanceTypes
  - compute.v1.regions
  - compute.v1.providers
- name: Databases & Engines
  tags:
  - core.v1.databases
  - core.v1.engines
  - core.v1.engineRevisions
  - core.v1.bindings
- name: SQL Editor
  tags:
  - editor.v1.scripts
x-provenance:
  method: harvested
  publisher: Firebolt
  source: https://api.app.firebolt.io/docs/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)