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

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

This API exposes 2 operations across 1 path, and defines 19 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 19 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=GetPolicy 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=GetPolicy 2
GET
/#Action=GetPolicy
Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the…
GET_GetPolicy 10 params → 200480481482
POST
/#Action=GetPolicy
Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the…
POST_GetPolicy 9 params body → 200480481482

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Policy (12 properties), Tag (2 properties), GetPolicyRequest (1 property), GetPolicyResponse (1 property). Each schema is shown below with its type and property counts.

InvalidInputException
tagListType
array
Tag
object
A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources i…
2 properties 2 required
policyVersionIdType
string
policyDescriptionType
string
arnType
string
The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources. For more information about ARNs, go to Amazon Resource Names (AR…
policyPathType
string
GetPolicyResponse
object
Contains the response to a successful GetPolicy request.
1 property
tagKeyType
string
tagValueType
string
booleanType
boolean
idType
string
NoSuchEntityException
policyNameType
string
dateType
string
ServiceFailureException
GetPolicyRequest
object
1 property 1 required
attachmentCountType
integer
Policy
object
Contains information about a managed policy. This data type is used as a response element in the CreatePolicy , GetPolicy , and ListPolicies operations. For mo…
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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