openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: 'APIs.io Engineering Platform Amazon API Gateway 2014 11 13 #Action=CreateInstanceProfile 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=CreateInstanceProfile' paths: /#Action=CreateInstanceProfile: 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: CreateInstanceProfile operationId: GET_CreateInstanceProfile description:Creates a new instance profile. For information about instance profiles, see Using roles for applications on Amazon EC2 in the IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.
For information about the number of instance profiles you can create, see IAM object quotas in the IAM User Guide.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateInstanceProfileResponse' '480': description: EntityAlreadyExistsException content: text/xml: schema: $ref: '#/components/schemas/EntityAlreadyExistsException' '481': description: InvalidInputException content: text/xml: schema: $ref: '#/components/schemas/InvalidInputException' '482': description: LimitExceededException content: text/xml: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ConcurrentModificationException content: text/xml: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: ServiceFailureException content: text/xml: schema: $ref: '#/components/schemas/ServiceFailureException' parameters: - name: InstanceProfileName in: query required: true description: 'The name of the instance profile to create.
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: 128 - name: Path in: query required: false description:The path to the instance profile. 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.
A list of tags that you want to attach to the newly created IAM instance profile. 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.
Creates a new instance profile. For information about instance profiles, see Using roles for applications on Amazon EC2 in the IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.
For information about the number of instance profiles you can create, see IAM object quotas in the IAM User Guide.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateInstanceProfileResponse' '480': description: EntityAlreadyExistsException content: text/xml: schema: $ref: '#/components/schemas/EntityAlreadyExistsException' '481': description: InvalidInputException content: text/xml: schema: $ref: '#/components/schemas/InvalidInputException' '482': description: LimitExceededException content: text/xml: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: ConcurrentModificationException content: text/xml: schema: $ref: '#/components/schemas/ConcurrentModificationException' '484': description: ServiceFailureException content: text/xml: schema: $ref: '#/components/schemas/ServiceFailureException' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateInstanceProfileRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateInstanceProfile - name: Version in: query required: true schema: type: string enum: - 2010-05-08 tags: - '#Action=CreateInstanceProfile' 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: InvalidInputException: {} roleListType: type: array description:Contains a list of IAM roles.
This data type is used as a response element in the ListRoles operation.
items: $ref: '#/components/schemas/Role' tagListType: type: array items: $ref: '#/components/schemas/Tag' maxItems: 50 Tag: type: object required: - Key - Value properties: Key: allOf: - $ref: '#/components/schemas/tagKeyType' - description: The key name that can be used to look up or retrieve the associated value. For example,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 InstanceProfile: type: object required: - Path - InstanceProfileName - InstanceProfileId - Arn - CreateDate - Roles properties: Path: allOf: - $ref: '#/components/schemas/pathType' - description: ' The path to the instance profile. For more information about paths, see IAM identifiers in the IAM User Guide. ' InstanceProfileName: allOf: - $ref: '#/components/schemas/instanceProfileNameType' - description: The name identifying the instance profile. InstanceProfileId: allOf: - $ref: '#/components/schemas/idType' - description: ' The stable and unique string identifying the instance profile. 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 instance profile. 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 when the instance profile was created. Roles: allOf: - $ref: '#/components/schemas/roleListType' - description: The role associated with the instance profile. Tags: allOf: - $ref: '#/components/schemas/tagListType' - description: A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide. description:Contains information about an instance profile.
This data type is used as a response element in the following operations:
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 CreateInstanceProfileRequest: type: object required: - InstanceProfileName title: CreateInstanceProfileRequest properties: InstanceProfileName: allOf: - $ref: '#/components/schemas/instanceProfileNameType' - description: 'The name of the instance profile to create.
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: _+=,.@-
' Path: allOf: - $ref: '#/components/schemas/pathType' - description:The path to the instance profile. 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.
A list of tags that you want to attach to the newly created IAM instance profile. 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.
Policy.'
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 ServiceFailureException: {} Role: type: object required: - Path - RoleName - RoleId - Arn - CreateDate 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. ' RoleName: allOf: - $ref: '#/components/schemas/roleNameType' - description: The friendly name that identifies the role. RoleId: allOf: - $ref: '#/components/schemas/idType' - description: ' The stable and unique string identifying the role. 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 role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide. ' CreateDate: allOf: - $ref: '#/components/schemas/dateType' - description: The date and time, in ISO 8601 date-time format, when the role was created. AssumeRolePolicyDocument: allOf: - $ref: '#/components/schemas/policyDocumentType' - description: The policy that grants an entity permission to assume the role. Description: allOf: - $ref: '#/components/schemas/roleDescriptionType' - description: A description of the role that you provide. MaxSessionDuration: allOf: - $ref: '#/components/schemas/roleMaxSessionDurationType' - description: The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optionalDurationSeconds 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: {} PermissionsBoundaryAttachmentType: type: string enum: - PermissionsBoundaryPolicy 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