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=GetGroupPolicy API

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

This API exposes 2 operations across 1 path, and defines 7 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 7 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=GetGroupPolicy 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=GetGroupPolicy 2
GET
/#Action=GetGroupPolicy
Retrieves the specified inline policy document that is embedded in the specified IAM group. Policies returned by this operation are URL-encoded compliant with RFC 3986 . You can use a URL decoding me…
GET_GetGroupPolicy 11 params → 200480481
POST
/#Action=GetGroupPolicy
Retrieves the specified inline policy document that is embedded in the specified IAM group. Policies returned by this operation are URL-encoded compliant with RFC 3986 . You can use a URL decoding me…
POST_GetGroupPolicy 9 params body → 200480481

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are GetGroupPolicyResponse (3 properties), GetGroupPolicyRequest (2 properties). Each schema is shown below with its type and property counts.

policyDocumentType
string
GetGroupPolicyRequest
object
2 properties 2 required
NoSuchEntityException
policyNameType
string
GetGroupPolicyResponse
object
Contains the response to a successful GetGroupPolicy request.
3 properties 3 required
ServiceFailureException
groupNameType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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