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

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

This API exposes 2 operations across 1 path, and defines 21 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 21 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=GetRole 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=GetRole 2
GET
/#Action=GetRole
Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Work…
GET_GetRole 10 params → 200480481
POST
/#Action=GetRole
Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Work…
POST_GetRole 9 params body → 200480481

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Role (11 properties), AttachedPermissionsBoundary (2 properties), RoleLastUsed (2 properties), Tag (2 properties). Each schema is shown below with its type and property counts.

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
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…
GetRoleResponse
object
Contains the response to a successful GetRole request.
1 property 1 required
pathType
string
RoleLastUsed
object
Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is…
2 properties
roleDescriptionType
string
tagKeyType
string
tagValueType
string
stringType
string
idType
string
policyDocumentType
string
AttachedPermissionsBoundary
object
Contains information about an attached permissions boundary. An attached permissions boundary is a managed policy that has been attached to a user or role to s…
2 properties
NoSuchEntityException
dateType
string
roleMaxSessionDurationType
integer
roleNameType
string
GetRoleRequest
object
1 property 1 required
ServiceFailureException
Role
object
Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles.
11 properties 5 required
PermissionsBoundaryAttachmentType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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