Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform #Action=GetOrganizationsAccessReport API

The #Action=GetOrganizationsAccessReport API from APIs.io Engineering Platform — 1 operation(s) for #action=getorganizationsaccessreport.

This API exposes 2 operations across 1 path, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

2 operations 1 paths 18 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform #Action=GetOrganizationsAccessReport API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

#Action=GetOrganizationsAccessReport 2
GET
/#Action=GetOrganizationsAccessReport
Retrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReport operation. This operation retrieves the status of your repo…
GET_GetOrganizationsAccessReport 13 params → 200480
POST
/#Action=GetOrganizationsAccessReport
Retrieves the service last accessed data report for Organizations that was previously generated using the GenerateOrganizationsAccessReport operation. This operation retrieves the status of your repo…
POST_GetOrganizationsAccessReport 9 params body → 200480

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are GetOrganizationsAccessReportResponse (9 properties), AccessDetail (6 properties), GetOrganizationsAccessReportRequest (4 properties), ErrorDetails (2 properties). Each schema is shown below with its type and property counts.

integerType
integer
GetOrganizationsAccessReportResponse
object
9 properties 2 required
AccessDetail
object
An object that contains details about when a principal in the reported Organizations entity last attempted to access an Amazon Web Services service. A principa…
6 properties 2 required
jobStatusType
string
markerType
string
sortKeyType
string
organizationsEntityPathType
string
serviceNamespaceType
string
booleanType
boolean
stringType
string
ErrorDetails
object
Contains information about the reason that the operation failed. This data type is used as a response element in the GetOrganizationsAccessReport , GetServiceL…
2 properties 2 required
serviceNameType
string
NoSuchEntityException
dateType
string
maxItemsType
integer
AccessDetails
array
GetOrganizationsAccessReportRequest
object
4 properties 1 required
jobIDType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-action-getorganizationsaccessreport-api-openapi.yml Raw ↑