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

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

This API exposes 2 operations across 1 path, and defines 39 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 39 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=SimulatePrincipalPolicy 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=SimulatePrincipalPolicy 2
GET
/#Action=SimulatePrincipalPolicy
Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be…
GET_SimulatePrincipalPolicy 21 params → 200480481482
POST
/#Action=SimulatePrincipalPolicy
Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be…
POST_SimulatePrincipalPolicy 11 params body → 200480481482

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are SimulatePrincipalPolicyRequest (12 properties), EvaluationResult (9 properties), ResourceSpecificResult (6 properties), Statement (4 properties). Each schema is shown below with its type and property counts.

ResourceSpecificResultListType
array
Position
object
Contains the row and column of a location of a Statement element in a policy document. This data type is used as a member of the Statement type.
2 properties
PolicyEvaluationException
InvalidInputException
ResourceHandlingOptionType
string
PolicySourceType
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…
responseMarkerType
string
OrganizationsDecisionDetail
object
Contains information about the effect that Organizations has on a policy simulation.
1 property
StatementListType
array
ContextKeyTypeEnum
string
ResourceNameType
string
markerType
string
EvaluationResult
object
Contains the results of a simulation. This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy .
9 properties 2 required
ActionNameType
string
booleanType
boolean
SimulatePrincipalPolicyRequest
object
12 properties 2 required
PermissionsBoundaryDecisionDetail
object
Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.
1 property
ContextKeyNamesResultListType
array
LineNumber
integer
policyDocumentType
string
SimulationPolicyListType
array
PolicyEvaluationDecisionType
string
NoSuchEntityException
SimulatePolicyResponse
object
Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.
3 properties
ContextKeyValueListType
array
Statement
object
Contains a reference to a Statement element in a policy document that determines the result of the simulation. This data type is used by the MatchedStatements…
4 properties
maxItemsType
integer
ContextEntry
object
Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple va…
3 properties
ContextKeyValueType
string
ActionNameListType
array
ResourceNameListType
array
EvalDecisionDetailsType
object
ResourceSpecificResult
object
Contains the result of the simulation of a single API operation call on a single resource. This data type is used by a member of the EvaluationResult data type.
6 properties 2 required
ColumnNumber
integer
ContextKeyNameType
string
ContextEntryListType
array
EvaluationResultsListType
array
PolicyIdentifierType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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