Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Account Permission Groups paths: /accounts/{account_id}/iam/permission_groups: get: description: List all the permissions groups for an account. operationId: account-permission-group-list parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/iam_account_identifier' - in: query name: id schema: description: ID of the permission group to be fetched. example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 maxLength: 32 minLength: 32 type: string - in: query name: name schema: description: Name of the permission group to be fetched. example: NameOfThePermissionGroup type: string - in: query name: label schema: description: Label of the permission group to be fetched. example: labelOfThePermissionGroup type: string - in: query name: page schema: default: 1 description: Page number of paginated results. minimum: 1 type: number - in: query name: per_page schema: default: 20 description: Maximum number of results per page. maximum: 50 minimum: 5 type: number responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/iam_api-response-common-failure' description: List Permission Groups response failure '200': content: application/json: schema: $ref: '#/components/schemas/iam_collection_permission_groups_response' description: List Permission Groups response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform List Account Permission Groups tags: - Account Permission Groups x-api-token-group: - Cloudflare Zero Trust PII Read - DDoS Botnet Feed Write - DDoS Botnet Feed Read - Workers R2 Storage Write - Workers R2 Storage Read - DDoS Protection Write - DDoS Protection Read - Workers Tail Read - Workers KV Storage Write - Workers KV Storage Read - Workers Scripts Write - Workers Scripts Read - 'Load Balancing: Monitors and Pools Write' - 'Load Balancing: Monitors and Pools Read' - Account Firewall Access Rules Write - Account Firewall Access Rules Read - DNS Firewall Write - DNS Firewall Read - Billing Write - Billing Read - Account Settings Write - Account Settings Read x-cfPermissionsRequired: enum: - com.cloudflare.api.iam.permission-group.list x-cfPlanAvailability: business: true enterprise: true free: true pro: true /accounts/{account_id}/iam/permission_groups/{permission_group_id}: get: description: Get information about a specific permission group in an account. operationId: account-permission-group-details parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/iam_account_identifier' - in: path name: permission_group_id required: true schema: $ref: '#/components/schemas/iam_permission_group_components-schemas-identifier' responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/iam_api-response-common-failure' description: Permission Group Details response failure '200': content: application/json: schema: $ref: '#/components/schemas/iam_permission_group' description: Permission Group Details response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Permission Group Details tags: - Account Permission Groups x-api-token-group: - Cloudflare Zero Trust PII Read - DDoS Botnet Feed Write - DDoS Botnet Feed Read - Workers R2 Storage Write - Workers R2 Storage Read - DDoS Protection Write - DDoS Protection Read - Workers Tail Read - Workers KV Storage Write - Workers KV Storage Read - Workers Scripts Write - Workers Scripts Read - 'Load Balancing: Monitors and Pools Write' - 'Load Balancing: Monitors and Pools Read' - Account Firewall Access Rules Write - Account Firewall Access Rules Read - DNS Firewall Write - DNS Firewall Read - Billing Write - Billing Read - Account Settings Write - Account Settings Read x-cfPermissionsRequired: enum: - com.cloudflare.api.iam.permission-group.read x-cfPlanAvailability: business: true enterprise: true free: true pro: true components: schemas: iam_collection_permission_groups_response: allOf: - $ref: '#/components/schemas/iam_api-response-collection' - properties: result: $ref: '#/components/schemas/iam_permission_groups' type: object title: List of Resource groups iam_permission_groups: description: A set of permission groups that are specified to the policy. example: - id: c8fed203ed3043cba015a93ad1616f1f meta: label: load_balancer_admin scopes: com.cloudflare.api.account name: Zone Read - id: 82e64a83756745bbbb1c9c2701bf816b meta: label: fbm_user scopes: com.cloudflare.api.account name: Magic Network Monitoring items: $ref: '#/components/schemas/iam_permission_group' type: array iam_account_identifier: description: Account identifier tag. example: eb78d65290b24279ba6f44721b3ea3c4 maxLength: 32 readOnly: true type: string iam_api-response-collection: allOf: - $ref: '#/components/schemas/iam_api-response-common' - properties: result: items: {} nullable: true type: array result_info: $ref: '#/components/schemas/iam_result_info' type: object iam_result_info: properties: count: description: Total number of results for the requested service example: 1 type: number page: description: Current page within paginated list of results example: 1 type: number per_page: description: Number of results per page of results example: 20 type: number total_count: description: Total results available without any search parameters example: 2000 type: number type: object iam_permission_group_components-schemas-identifier: description: Permission Group identifier tag. example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 maxLength: 32 readOnly: true type: string iam_api-response-common: properties: errors: $ref: '#/components/schemas/iam_messages' messages: $ref: '#/components/schemas/iam_messages' success: description: Whether the API call was successful enum: - true example: true type: boolean required: - success - errors - messages type: object iam_api-response-common-failure: properties: errors: allOf: - $ref: '#/components/schemas/iam_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/iam_messages' example: [] result: enum: - null nullable: true type: object success: description: Whether the API call was successful enum: - false example: false type: boolean required: - success - errors - messages - result type: object iam_permission_group: description: A named group of permissions that map to a group of operations against resources. properties: id: description: Identifier of the group. example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1 readOnly: true type: string meta: description: Attributes associated to the permission group. example: label: load_balancer_admin scopes: com.cloudflare.api.account properties: key: type: string value: type: string type: object name: description: Name of the group. example: Load Balancer readOnly: true type: string required: - id type: object iam_messages: example: [] items: properties: code: minimum: 1000 type: integer message: type: string required: - code - message type: object uniqueItems: true type: array securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true