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=CreateRole' paths: /#Action=CreateRole: 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: CreateRole operationId: GET_CreateRole description: Creates a new role for your Amazon Web Services account. For more information about roles, see IAM roles. For information about quotas for role names and the number of roles you can create, see IAM and STS quotas in the IAM User Guide. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateRoleResponse' '480': description: LimitExceededException content: text/xml: schema: $ref: '#/components/schemas/LimitExceededException' '481': description: InvalidInputException content: text/xml: schema: $ref: '#/components/schemas/InvalidInputException' '482': description: EntityAlreadyExistsException content: text/xml: schema: $ref: '#/components/schemas/EntityAlreadyExistsException' '483': description: MalformedPolicyDocumentException content: text/xml: schema: $ref: '#/components/schemas/MalformedPolicyDocumentException' '484': description: ConcurrentModificationException content: text/xml: schema: $ref: '#/components/schemas/ConcurrentModificationException' '485': description: ServiceFailureException content: text/xml: schema: $ref: '#/components/schemas/ServiceFailureException' parameters: - name: Path in: query required: false description:The path to the role. 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 role to create.
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".
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' schema: type: string pattern: '[\w+=,.@-]+' minLength: 1 maxLength: 64 - name: AssumeRolePolicyDocument in: query required: true description:The trust relationship policy document that grants an entity permission to assume the role.
In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Upon success, the response includes the same trust policy in JSON format.
schema: type: string pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' minLength: 1 maxLength: 131072 - name: Description in: query required: false description: A description of the role. schema: type: string pattern: '[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*' maxLength: 1000 - name: MaxSessionDuration in: query required: false description:The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.
The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
schema: 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 - name: Tags in: query required: false description:A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
Department or Cost Center are common choices.
Value:
allOf:
- $ref: '#/components/schemas/tagValueType'
- description: The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.
Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
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 pathType: type: string pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) minLength: 1 maxLength: 512 RoleLastUsed: type: object properties: LastUsedDate: allOf: - $ref: '#/components/schemas/dateType' - description:The date and time, in ISO 8601 date-time format that the role was last used.
This field is null if the role has not been used within the IAM tracking period. For more information about the tracking period, see Regions where data is tracked in the IAM User Guide.
Region: allOf: - $ref: '#/components/schemas/stringType' - description: The name of the Amazon Web Services Region in which the role was last used. description: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 only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.
This data type is returned as a response element in the GetRole and GetAccountAuthorizationDetails operations.
roleDescriptionType: type: string pattern: '[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*' maxLength: 1000 tagKeyType: type: string pattern: '[\p{L}\p{Z}\p{N}_.:/=+\-@]+' minLength: 1 maxLength: 128 tagValueType: type: string pattern: '[\p{L}\p{Z}\p{N}_.:/=+\-@]*' minLength: 0 maxLength: 256 LimitExceededException: {} stringType: type: string idType: type: string pattern: '[\w]+' minLength: 16 maxLength: 128 policyDocumentType: type: string pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' minLength: 1 maxLength: 131072 ConcurrentModificationException: {} AttachedPermissionsBoundary: type: object properties: PermissionsBoundaryType: allOf: - $ref: '#/components/schemas/PermissionsBoundaryAttachmentType' - description: ' The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value ofPolicy.'
PermissionsBoundaryArn:
allOf:
- $ref: '#/components/schemas/arnType'
- description: ' The ARN of the policy used to set the permissions boundary for the user or role.'
description: 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 set the permissions boundary.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
dateType: type: string format: date-time roleMaxSessionDurationType: type: integer minimum: 3600 maximum: 43200 roleNameType: type: string pattern: '[\w+=,.@-]+' minLength: 1 maxLength: 64 CreateRoleRequest: type: object required: - RoleName - AssumeRolePolicyDocument title: CreateRoleRequest properties: Path: allOf: - $ref: '#/components/schemas/pathType' - description:The path to the role. 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 role to create.
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".
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
' AssumeRolePolicyDocument: allOf: - $ref: '#/components/schemas/policyDocumentType' - description:The trust relationship policy document that grants an entity permission to assume the role.
In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)
Upon success, the response includes the same trust policy in JSON format.
Description: allOf: - $ref: '#/components/schemas/roleDescriptionType' - description: A description of the role. MaxSessionDuration: allOf: - $ref: '#/components/schemas/roleMaxSessionDurationType' - description:The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
Anyone who assumes the role from the CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM roles in the IAM User Guide.
The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
Tags: allOf: - $ref: '#/components/schemas/tagListType' - description:A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
DurationSeconds API parameter or duration-seconds CLI parameter.
PermissionsBoundary:
allOf:
- $ref: '#/components/schemas/AttachedPermissionsBoundary'
- description: The ARN of the policy used to set the permissions boundary for the role.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
Tags: allOf: - $ref: '#/components/schemas/tagListType' - description: A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide. RoleLastUsed: allOf: - $ref: '#/components/schemas/RoleLastUsed' - description: 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 only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide. description: Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles. EntityAlreadyExistsException: {} CreateRoleResponse: type: object required: - Role example: Role: Arn: arn:aws:iam::123456789012:role/Test-Role AssumeRolePolicyDocument: