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

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

This API exposes 2 operations across 1 path, and defines 29 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 29 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=ListInstanceProfiles 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=ListInstanceProfiles 2
GET
/#Action=ListInstanceProfiles
Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see About instance profiles . IA…
GET_ListInstanceProfiles 12 params → 200480
POST
/#Action=ListInstanceProfiles
Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, see About instance profiles . IA…
POST_ListInstanceProfiles 11 params body → 200480

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Role (11 properties), InstanceProfile (7 properties), ListInstanceProfilesRequest (3 properties), ListInstanceProfilesResponse (3 properties). Each schema is shown below with its type and property counts.

roleListType
array
Contains a list of IAM roles. This data type is used as a response element in the ListRoles operation.
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
responseMarkerType
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…
pathType
string
InstanceProfile
object
Contains information about an instance profile. This data type is used as a response element in the following operations: CreateInstanceProfile GetInstanceProf…
7 properties 6 required
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
markerType
string
roleDescriptionType
string
tagKeyType
string
tagValueType
string
booleanType
boolean
stringType
string
idType
string
instanceProfileListType
array
Contains a list of instance profiles.
policyDocumentType
string
instanceProfileNameType
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
dateType
string
roleMaxSessionDurationType
integer
roleNameType
string
maxItemsType
integer
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
pathPrefixType
string
ListInstanceProfilesRequest
object
3 properties
PermissionsBoundaryAttachmentType
string
ListInstanceProfilesResponse
object
Contains the response to a successful ListInstanceProfiles request.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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