get_vertical_details¶

VerticalsApi.get_vertical_details(id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get a single vertical

Returns DynamoDB metadata for the vertical plus AccessType for the caller and UsersAttached (users whose AllowedApps contain VerticalType.lower()). Requires verticals.view on role_id and at least some ACL on the vertical. Missing vertical raises GE-1046. No ACL raises AUTH-1010. When VerticalType is bi, each attached user is annotated with QuickSightRole from QuickSight (empty string when not registered). This Lambda maps InvalidInputException and UnauthorizedUserException to HTTP 400. Example: GET /verticals/11111111-2222-3333-4444-555555555555

Parameters:

id (str) – VerticalId of the vertical to retrieve. (required)
role_id (str) – Amorphic role ID used to authorize the request. Must grant verticals.view. The caller must belong to the role. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

VerticalByIdResponseBody

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /verticals/{id}

Parameter examples¶

Name	In	Example
`id`	path	`"11111111-2222-3333-4444-555555555555"`
`role_id`	header	`"custom-role-123e4567-e89b-12d3-a456-426614174000"`

Success (HTTP 200)¶

Vertical metadata, AccessType, and UsersAttached.

Request / response example

{
  "VerticalId": "11111111-2222-3333-4444-555555555555",
  "VerticalName": "BI Application",
  "VerticalType": "bi",
  "AccessType": "owner",
  "UsersAttached": [
    {
      "UserId": "jane.doe",
      "FullName": "Jane Doe",
      "EmailId": "jane.doe@example.com",
      "AllowedApps": [
        "amorphic",
        "bi"
      ],
      "QuickSightRole": "AUTHOR"
    }
  ]
}

Errors¶

Documented error codes: AUTH-1001.

HTTP 400

InvalidInputException or UnauthorizedUserException. Body is {“Message”: “<CODE> - <text>”}.

missingRole

{
  "Message": "AUTH-1001 - Missing role information in event header"
}

HTTP 500

GenericFailure, InconsistentMetadata, or unhandled exception. Body is {“Message”: “<CODE> - <text>”} or a raw exception string.

unexpected

{
  "Message": "Unexpected error - <exception text>"
}