openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: 'APIs.io Engineering Platform Amazon API Gateway 2014 11 13 #Action=CreateGroup API'
description:
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: '#Action=CreateGroup' paths: /#Action=CreateGroup: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: x-aws-operation-name: CreateGroup operationId: GET_CreateGroup description:Creates a new group.
For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateGroupResponse' '480': description: LimitExceededException content: text/xml: schema: $ref: '#/components/schemas/LimitExceededException' '481': description: EntityAlreadyExistsException content: text/xml: schema: $ref: '#/components/schemas/EntityAlreadyExistsException' '482': description: NoSuchEntityException content: text/xml: schema: $ref: '#/components/schemas/NoSuchEntityException' '483': description: ServiceFailureException content: text/xml: schema: $ref: '#/components/schemas/ServiceFailureException' parameters: - name: Path in: query required: false description:The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The name of the group to create. Do not include the path in this value.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
schema: type: string pattern: '[\w+=,.@-]+' minLength: 1 maxLength: 128 - name: Action in: query required: true schema: type: string enum: - CreateGroup - name: Version in: query required: true schema: type: string enum: - 2010-05-08 tags: - '#Action=CreateGroup' post: x-aws-operation-name: CreateGroup operationId: POST_CreateGroup description:Creates a new group.
For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateGroupResponse' '480': description: LimitExceededException content: text/xml: schema: $ref: '#/components/schemas/LimitExceededException' '481': description: EntityAlreadyExistsException content: text/xml: schema: $ref: '#/components/schemas/EntityAlreadyExistsException' '482': description: NoSuchEntityException content: text/xml: schema: $ref: '#/components/schemas/NoSuchEntityException' '483': description: ServiceFailureException content: text/xml: schema: $ref: '#/components/schemas/ServiceFailureException' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateGroupRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateGroup - name: Version in: query required: true schema: type: string enum: - 2010-05-08 tags: - '#Action=CreateGroup' components: parameters: X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false schemas: arnType: type: string description:The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.
For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
minLength: 20 maxLength: 2048 groupNameType: type: string pattern: '[\w+=,.@-]+' minLength: 1 maxLength: 128 pathType: type: string pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) minLength: 1 maxLength: 512 Group: type: object required: - Path - GroupName - GroupId - Arn - CreateDate properties: Path: allOf: - $ref: '#/components/schemas/pathType' - description: 'The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide. ' GroupName: allOf: - $ref: '#/components/schemas/groupNameType' - description: The friendly name that identifies the group. GroupId: allOf: - $ref: '#/components/schemas/idType' - description: ' The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide. ' Arn: allOf: - $ref: '#/components/schemas/arnType' - description: ' The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide. ' CreateDate: allOf: - $ref: '#/components/schemas/dateType' - description: The date and time, in ISO 8601 date-time format, when the group was created. description:Contains information about an IAM group entity.
This data type is used as a response element in the following operations:
CreateGroupRequest: type: object required: - GroupName title: CreateGroupRequest properties: Path: allOf: - $ref: '#/components/schemas/pathType' - description:The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
The name of the group to create. Do not include the path in this value.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
LimitExceededException: {} idType: type: string pattern: '[\w]+' minLength: 16 maxLength: 128 NoSuchEntityException: {} dateType: type: string format: date-time ServiceFailureException: {} CreateGroupResponse: type: object required: - Group example: Group: Arn: arn:aws:iam::123456789012:group/Admins CreateDate: 2015-03-09 20:30:24.940000+00:00 GroupId: AIDGPMS9RO4H3FEXAMPLE GroupName: Admins Path: / properties: Group: allOf: - $ref: '#/components/schemas/Group' - description: A structure containing details about the new group. description: 'Contains the response to a successful CreateGroup request. ' EntityAlreadyExistsException: {} 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