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 Account Resource Groups API

The Account Resource Groups API from APIs.io Engineering Platform — 2 operation(s) for account resource groups.

This API exposes 5 operations across 2 paths, and defines 22 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.

5 operations 2 paths 22 schemas 1 DELETE2 GET1 POST1 PUT

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 Account Resource Groups 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Account Resource Groups 5
GET
/accounts/{account_id}/iam/resource_groups
APIs.io Engineering Platform List Resource Groups
account-resource-group-list 5 params → 4XX200
POST
/accounts/{account_id}/iam/resource_groups
APIs.io Engineering Platform Create Resource Group
account-resource-group-create 1 param body → 4XX200
DELETE
/accounts/{account_id}/iam/resource_groups/{resource_group_id}
APIs.io Engineering Platform Remove Resource Group
account-resource-group-delete 2 params body → 4XX200
GET
/accounts/{account_id}/iam/resource_groups/{resource_group_id}
APIs.io Engineering Platform Resource Group Details
account-resource-group-details 2 params → 4XX200
PUT
/accounts/{account_id}/iam/resource_groups/{resource_group_id}
APIs.io Engineering Platform Update Resource Group
account-resource-group-update 2 params body → 4XX200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are iam_result_info (4 properties), iam_resource_group (4 properties), iam_api-response-common-failure (4 properties), iam_created_resource_group_response (3 properties). Each schema is shown below with its type and property counts.

iam_scope
object
A scope is a combination of scope objects which provides additional context.
2 properties 2 required
iam_resource_group_components-schemas-identifier
string
Resource Group identifier tag.
iam_create_resource_group_scope_scope_object
object
A scope object represents any resource that can have actions applied against invite.
1 property 1 required
iam_scope_key
This is a combination of pre-defined resource name and identifier (like Account ID etc.)
iam_account_identifier
string
Account identifier tag.
iam_result_info
object
4 properties
iam_api-response-common
object
3 properties 3 required
iam_create-scope
object
A scope is a combination of scope objects which provides additional context.
2 properties 2 required
iam_api-response-common-failure
object
4 properties 4 required
iam_scope_object_key
This is a combination of pre-defined resource name and identifier (like Zone ID etc.)
iam_created_resource_group_response
object
A group of scoped resources.
3 properties
iam_common_components-schemas-identifier
string
Identifier
iam_api-response-collection
object
iam_create_resource_group
object
3 properties 1 required
iam_create_resource_group_scope_scope_key
This is a combination of pre-defined resource name and identifier (like Account ID etc.)
iam_create_resource_group_scope_scope_object_key
This is a combination of pre-defined resource name and identifier (like Zone ID etc.)
iam_collection_resource_groups_response
iam_resource_group
object
A group of scoped resources.
4 properties 2 required
iam_messages
array
iam_scope_object
object
A scope object represents any resource that can have actions applied against invite.
1 property 1 required
iam_resource_groups
array
A list of resource groups that the policy applies to.
iam_api-response-single-id
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-account-resource-groups-api-openapi.yml Raw ↑