Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.
Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.
Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.'
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RestoreBackupResponse'
+ '480':
+ description: CloudHsmAccessDeniedException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmAccessDeniedException'
+ '481':
+ description: CloudHsmInternalFailureException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmInternalFailureException'
+ '482':
+ description: CloudHsmInvalidRequestException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmInvalidRequestException'
+ '483':
+ description: CloudHsmResourceNotFoundException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmResourceNotFoundException'
+ '484':
+ description: CloudHsmServiceException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmServiceException'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RestoreBackupRequest'
+ parameters:
+ - name: X-Amz-Target
+ in: header
+ required: true
+ schema:
+ type: string
+ enum:
+ - BaldrApiService.RestoreBackup
+ 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'
+ /#X-Amz-Target=BaldrApiService.TagResource:
+ post:
+ operationId: TagResource
+ description: Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TagResourceResponse'
+ '480':
+ description: CloudHsmAccessDeniedException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmAccessDeniedException'
+ '481':
+ description: CloudHsmInternalFailureException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmInternalFailureException'
+ '482':
+ description: CloudHsmInvalidRequestException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmInvalidRequestException'
+ '483':
+ description: CloudHsmResourceNotFoundException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmResourceNotFoundException'
+ '484':
+ description: CloudHsmServiceException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmServiceException'
+ '485':
+ description: CloudHsmTagException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmTagException'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TagResourceRequest'
+ parameters:
+ - name: X-Amz-Target
+ in: header
+ required: true
+ schema:
+ type: string
+ enum:
+ - BaldrApiService.TagResource
+ 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'
+ /#X-Amz-Target=BaldrApiService.UntagResource:
+ post:
+ operationId: UntagResource
+ description: Removes the specified tag or tags from the specified AWS CloudHSM cluster.
+ responses:
+ '200':
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UntagResourceResponse'
+ '480':
+ description: CloudHsmAccessDeniedException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmAccessDeniedException'
+ '481':
+ description: CloudHsmInternalFailureException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmInternalFailureException'
+ '482':
+ description: CloudHsmInvalidRequestException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmInvalidRequestException'
+ '483':
+ description: CloudHsmResourceNotFoundException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmResourceNotFoundException'
+ '484':
+ description: CloudHsmServiceException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmServiceException'
+ '485':
+ description: CloudHsmTagException
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudHsmTagException'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UntagResourceRequest'
+ parameters:
+ - name: X-Amz-Target
+ in: header
+ required: true
+ schema:
+ type: string
+ enum:
+ - BaldrApiService.UntagResource
+ 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'
+components:
+ parameters:
+ X-Amz-Content-Sha256:
+ name: X-Amz-Content-Sha256
+ in: header
+ schema:
+ type: string
+ required: false
+ X-Amz-Date:
+ name: X-Amz-Date
+ in: header
+ schema:
+ type: string
+ required: false
+ X-Amz-Algorithm:
+ name: X-Amz-Algorithm
+ in: header
+ schema:
+ type: string
+ required: false
+ X-Amz-Credential:
+ name: X-Amz-Credential
+ 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-Signature:
+ name: X-Amz-Signature
+ in: header
+ schema:
+ type: string
+ required: false
+ X-Amz-SignedHeaders:
+ name: X-Amz-SignedHeaders
+ in: header
+ schema:
+ type: string
+ required: false
+ securitySchemes:
+ hmac:
+ type: apiKey
+ name: Authorization
+ in: header
+ description: Amazon Signature authorization v4
+ x-amazon-apigateway-authtype: awsSigv4
+ schemas:
+ CopyBackupToRegionResponse:
+ type: object
+ properties:
+ DestinationBackup:
+ allOf:
+ - $ref: '#/components/schemas/DestinationBackup'
+ - description: 'Information on the backup that will be copied to the destination region, including CreateTimestamp, SourceBackup, SourceCluster, and Source Region. CreateTimestamp of the destination backup will be the same as that of the source backup.
You will need to use the sourceBackupID returned in this operation to use the DescribeBackups operation on the backup that will be copied to the destination region.
hsm1.medium.
+ SourceBackupId:
+ allOf:
+ - $ref: '#/components/schemas/BackupId'
+ - description: 'The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.'
+ SubnetIds:
+ allOf:
+ - $ref: '#/components/schemas/SubnetIds'
+ - description: 'The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:
All subnets must be in the same virtual private cloud (VPC).
You can specify only one subnet per Availability Zone.
Backup object deleted.
+ DeleteBackupRequest:
+ type: object
+ required:
+ - BackupId
+ title: DeleteBackupRequest
+ properties:
+ BackupId:
+ allOf:
+ - $ref: '#/components/schemas/BackupId'
+ - description: 'The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.'
+ DeleteClusterResponse:
+ type: object
+ properties:
+ Cluster:
+ allOf:
+ - $ref: '#/components/schemas/Cluster'
+ - description: Information about the cluster that was deleted.
+ DeleteClusterRequest:
+ type: object
+ required:
+ - ClusterId
+ title: DeleteClusterRequest
+ properties:
+ ClusterId:
+ allOf:
+ - $ref: '#/components/schemas/ClusterId'
+ - description: 'The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.'
+ DeleteHsmResponse:
+ type: object
+ properties:
+ HsmId:
+ allOf:
+ - $ref: '#/components/schemas/HsmId'
+ - description: The identifier (ID) of the HSM that was deleted.
+ DeleteHsmRequest:
+ type: object
+ required:
+ - ClusterId
+ title: DeleteHsmRequest
+ properties:
+ ClusterId:
+ allOf:
+ - $ref: '#/components/schemas/ClusterId'
+ - description: The identifier (ID) of the cluster that contains the HSM that you are deleting.
+ HsmId:
+ allOf:
+ - $ref: '#/components/schemas/HsmId'
+ - description: The identifier (ID) of the HSM that you are deleting.
+ EniId:
+ allOf:
+ - $ref: '#/components/schemas/EniId'
+ - description: The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.
+ EniIp:
+ allOf:
+ - $ref: '#/components/schemas/IpAddress'
+ - description: The IP address of the elastic network interface (ENI) of the HSM that you are deleting.
+ DescribeBackupsResponse:
+ type: object
+ properties:
+ Backups:
+ type: array
+ items:
+ $ref: '#/components/schemas/Backup'
+ NextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups.
+ DescribeBackupsRequest:
+ type: object
+ title: DescribeBackupsRequest
+ properties:
+ NextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The NextToken value that you received in the previous response. Use this value to get more backups.
+ MaxResults:
+ allOf:
+ - $ref: '#/components/schemas/BackupsMaxSize'
+ - description: 'The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.'
+ Filters:
+ allOf:
+ - $ref: '#/components/schemas/Filters'
+ - description: One or more filters to limit the items returned in the response.
Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).
Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.
Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).
Use the states filter to return only backups that match the specified state.
Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.
DescribeClusters request to get more clusters.
+ DescribeClustersRequest:
+ type: object
+ title: DescribeClustersRequest
+ properties:
+ Filters:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/Strings'
+ NextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The NextToken value that you received in the previous response. Use this value to get more clusters.
+ MaxResults:
+ allOf:
+ - $ref: '#/components/schemas/ClustersMaxSize'
+ - description: 'The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.'
+ InitializeClusterResponse:
+ type: object
+ properties:
+ State:
+ allOf:
+ - $ref: '#/components/schemas/ClusterState'
+ - description: The cluster's state.
+ StateMessage:
+ allOf:
+ - $ref: '#/components/schemas/StateMessage'
+ - description: A description of the cluster's state.
+ InitializeClusterRequest:
+ type: object
+ required:
+ - ClusterId
+ - SignedCert
+ - TrustAnchor
+ title: InitializeClusterRequest
+ properties:
+ ClusterId:
+ allOf:
+ - $ref: '#/components/schemas/ClusterId'
+ - description: 'The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.'
+ SignedCert:
+ allOf:
+ - $ref: '#/components/schemas/Cert'
+ - description: The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.
+ TrustAnchor:
+ allOf:
+ - $ref: '#/components/schemas/Cert'
+ - description: 'The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the root certificate. The certificate must be in PEM format and can contain a maximum of 5000 characters.'
+ ListTagsResponse:
+ type: object
+ required:
+ - TagList
+ properties:
+ TagList:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: A list of tags.
+ NextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent ListTags request to get more tags.
+ ListTagsRequest:
+ type: object
+ required:
+ - ResourceId
+ title: ListTagsRequest
+ properties:
+ ResourceId:
+ allOf:
+ - $ref: '#/components/schemas/ResourceId'
+ - description: 'The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.'
+ NextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The NextToken value that you received in the previous response. Use this value to get more tags.
+ MaxResults:
+ allOf:
+ - $ref: '#/components/schemas/MaxSize'
+ - description: 'The maximum number of tags to return in the response. When there are more tags than the number you specify, the response contains a NextToken value.'
+ ModifyBackupAttributesResponse:
+ type: object
+ properties:
+ Backup:
+ $ref: '#/components/schemas/Backup'
+ ModifyBackupAttributesRequest:
+ type: object
+ required:
+ - BackupId
+ - NeverExpires
+ title: ModifyBackupAttributesRequest
+ properties:
+ BackupId:
+ allOf:
+ - $ref: '#/components/schemas/BackupId'
+ - description: 'The identifier (ID) of the backup to modify. To find the ID of a backup, use the DescribeBackups operation.'
+ NeverExpires:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.
+ ModifyClusterResponse:
+ type: object
+ properties:
+ Cluster:
+ $ref: '#/components/schemas/Cluster'
+ ModifyClusterRequest:
+ type: object
+ required:
+ - BackupRetentionPolicy
+ - ClusterId
+ title: ModifyClusterRequest
+ properties:
+ BackupRetentionPolicy:
+ allOf:
+ - $ref: '#/components/schemas/BackupRetentionPolicy'
+ - description: A policy that defines how the service retains backups.
+ ClusterId:
+ allOf:
+ - $ref: '#/components/schemas/ClusterId'
+ - description: 'The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use DescribeClusters.'
+ RestoreBackupResponse:
+ type: object
+ properties:
+ Backup:
+ allOf:
+ - $ref: '#/components/schemas/Backup'
+ - description: Information on the Backup object created.
+ RestoreBackupRequest:
+ type: object
+ required:
+ - BackupId
+ title: RestoreBackupRequest
+ properties:
+ BackupId:
+ allOf:
+ - $ref: '#/components/schemas/BackupId'
+ - description: 'The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.'
+ TagResourceResponse:
+ type: object
+ properties: {}
+ TagResourceRequest:
+ type: object
+ required:
+ - ResourceId
+ - TagList
+ title: TagResourceRequest
+ properties:
+ ResourceId:
+ allOf:
+ - $ref: '#/components/schemas/ResourceId'
+ - description: 'The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.'
+ TagList:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: A list of one or more tags.
+ UntagResourceResponse:
+ type: object
+ properties: {}
+ UntagResourceRequest:
+ type: object
+ required:
+ - ResourceId
+ - TagKeyList
+ title: UntagResourceRequest
+ properties:
+ ResourceId:
+ allOf:
+ - $ref: '#/components/schemas/ResourceId'
+ - description: 'The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.'
+ TagKeyList:
+ allOf:
+ - $ref: '#/components/schemas/TagKeyList'
+ - description: 'A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.'
+ BackupId:
+ type: string
+ pattern: 'backup-[2-7a-zA-Z]{11,16}'
+ BackupState:
+ type: string
+ enum:
+ - CREATE_IN_PROGRESS
+ - READY
+ - DELETED
+ - PENDING_DELETION
+ ClusterId:
+ type: string
+ pattern: 'cluster-[2-7a-zA-Z]{11,16}'
+ Timestamp:
+ type: string
+ format: date-time
+ Boolean:
+ type: boolean
+ Region:
+ type: string
+ pattern: '[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\d'
+ TagList:
+ type: array
+ items:
+ $ref: '#/components/schemas/Tag'
+ minItems: 1
+ maxItems: 50
+ Backup:
+ type: object
+ required:
+ - BackupId
+ properties:
+ BackupId:
+ allOf:
+ - $ref: '#/components/schemas/BackupId'
+ - description: The identifier (ID) of the backup.
+ BackupState:
+ allOf:
+ - $ref: '#/components/schemas/BackupState'
+ - description: The state of the backup.
+ ClusterId:
+ allOf:
+ - $ref: '#/components/schemas/ClusterId'
+ - description: The identifier (ID) of the cluster that was backed up.
+ CreateTimestamp:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: The date and time when the backup was created.
+ CopyTimestamp:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: The date and time when the backup was copied from a source backup.
+ NeverExpires:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.
+ SourceRegion:
+ allOf:
+ - $ref: '#/components/schemas/Region'
+ - description: The AWS Region that contains the source backup from which the new backup was copied.
+ SourceBackup:
+ allOf:
+ - $ref: '#/components/schemas/BackupId'
+ - description: The identifier (ID) of the source backup from which the new backup was copied.
+ SourceCluster:
+ allOf:
+ - $ref: '#/components/schemas/ClusterId'
+ - description: The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
+ DeleteTimestamp:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: The date and time when the backup will be permanently deleted.
+ TagList:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The list of tags for the backup.
+ description: 'Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.'
+ BackupPolicy:
+ type: string
+ enum:
+ - DEFAULT
+ BackupRetentionType:
+ type: string
+ enum:
+ - DAYS
+ BackupRetentionValue:
+ type: string
+ pattern: '[0-9]+'
+ minLength: 1
+ maxLength: 3
+ BackupRetentionPolicy:
+ type: object
+ properties:
+ Type:
+ allOf:
+ - $ref: '#/components/schemas/BackupRetentionType'
+ - description: 'The type of backup retention policy. For the DAYS type, the value is the number of days to retain backups.'
+ Value:
+ allOf:
+ - $ref: '#/components/schemas/BackupRetentionValue'
+ - description: Use a value between 7 - 379.
+ description: A policy that defines the number of days to retain backups.
+ Backups:
+ type: array
+ items:
+ $ref: '#/components/schemas/Backup'
+ BackupsMaxSize:
+ type: integer
+ minimum: 1
+ maximum: 50
+ Cert:
+ type: string
+ pattern: '[a-zA-Z0-9+-/=\s]*'
+ maxLength: 5000
+ Certificates:
+ type: object
+ properties:
+ ClusterCsr:
+ allOf:
+ - $ref: '#/components/schemas/Cert'
+ - description: The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED.
+ HsmCertificate:
+ allOf:
+ - $ref: '#/components/schemas/Cert'
+ - description: The HSM certificate issued (signed) by the HSM hardware.
+ AwsHardwareCertificate:
+ allOf:
+ - $ref: '#/components/schemas/Cert'
+ - description: The HSM hardware certificate issued (signed) by AWS CloudHSM.
+ ManufacturerHardwareCertificate:
+ allOf:
+ - $ref: '#/components/schemas/Cert'
+ - description: The HSM hardware certificate issued (signed) by the hardware manufacturer.
+ ClusterCertificate:
+ allOf:
+ - $ref: '#/components/schemas/Cert'
+ - description: The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
+ description: Contains one or more certificates or a certificate signing request (CSR).
+ Hsms:
+ type: array
+ items:
+ $ref: '#/components/schemas/Hsm'
+ HsmType:
+ type: string
+ pattern: (hsm1\.medium)
+ PreCoPassword:
+ type: string
+ minLength: 7
+ maxLength: 32
+ SecurityGroup:
+ type: string
+ pattern: 'sg-[0-9a-fA-F]{8,17}'
+ ClusterState:
+ type: string
+ enum:
+ - CREATE_IN_PROGRESS
+ - UNINITIALIZED
+ - INITIALIZE_IN_PROGRESS
+ - INITIALIZED
+ - ACTIVE
+ - UPDATE_IN_PROGRESS
+ - DELETE_IN_PROGRESS
+ - DELETED
+ - DEGRADED
+ StateMessage:
+ type: string
+ pattern: .*
+ maxLength: 300
+ ExternalSubnetMapping:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/SubnetId'
+ VpcId:
+ type: string
+ pattern: 'vpc-[0-9a-fA-F]'
+ Cluster:
+ type: object
+ properties:
+ BackupPolicy:
+ allOf:
+ - $ref: '#/components/schemas/BackupPolicy'
+ - description: The cluster's backup policy.
+ BackupRetentionPolicy:
+ allOf:
+ - $ref: '#/components/schemas/BackupRetentionPolicy'
+ - description: A policy that defines how the service retains backups.
+ ClusterId:
+ allOf:
+ - $ref: '#/components/schemas/ClusterId'
+ - description: The cluster's identifier (ID).
+ CreateTimestamp:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: The date and time when the cluster was created.
+ Hsms:
+ allOf:
+ - $ref: '#/components/schemas/Hsms'
+ - description: Contains information about the HSMs in the cluster.
+ HsmType:
+ allOf:
+ - $ref: '#/components/schemas/HsmType'
+ - description: The type of HSM that the cluster contains.
+ PreCoPassword:
+ allOf:
+ - $ref: '#/components/schemas/PreCoPassword'
+ - description: The default password for the cluster's Pre-Crypto Officer (PRECO) user.
+ SecurityGroup:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroup'
+ - description: The identifier (ID) of the cluster's security group.
+ SourceBackupId:
+ allOf:
+ - $ref: '#/components/schemas/BackupId'
+ - description: The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
+ State:
+ allOf:
+ - $ref: '#/components/schemas/ClusterState'
+ - description: The cluster's state.
+ StateMessage:
+ allOf:
+ - $ref: '#/components/schemas/StateMessage'
+ - description: A description of the cluster's state.
+ SubnetMapping:
+ allOf:
+ - $ref: '#/components/schemas/ExternalSubnetMapping'
+ - description: A map from availability zone to the cluster’s subnet in that availability zone.
+ VpcId:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
+ Certificates:
+ allOf:
+ - $ref: '#/components/schemas/Certificates'
+ - description: Contains one or more certificates or a certificate signing request (CSR).
+ TagList:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The list of tags for the cluster.
+ description: Contains information about an AWS CloudHSM cluster.
+ Clusters:
+ type: array
+ items:
+ $ref: '#/components/schemas/Cluster'
+ ClustersMaxSize:
+ type: integer
+ minimum: 1
+ maximum: 25
+ DestinationBackup:
+ type: object
+ properties:
+ CreateTimestamp:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: The date and time when both the source backup was created.
+ SourceRegion:
+ allOf:
+ - $ref: '#/components/schemas/Region'
+ - description: The AWS region that contains the source backup from which the new backup was copied.
+ SourceBackup:
+ allOf:
+ - $ref: '#/components/schemas/BackupId'
+ - description: The identifier (ID) of the source backup from which the new backup was copied.
+ SourceCluster:
+ allOf:
+ - $ref: '#/components/schemas/ClusterId'
+ - description: The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
+ description: Contains information about the backup that will be copied and created by the CopyBackupToRegion operation.
+ SubnetIds:
+ type: array
+ items:
+ $ref: '#/components/schemas/SubnetId'
+ minItems: 1
+ maxItems: 10
+ ExternalAz:
+ type: string
+ pattern: '[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\d[a-z]'
+ IpAddress:
+ type: string
+ pattern: '\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}'
+ Hsm:
+ type: object
+ required:
+ - HsmId
+ properties:
+ AvailabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/ExternalAz'
+ - description: The Availability Zone that contains the HSM.
+ ClusterId:
+ allOf:
+ - $ref: '#/components/schemas/ClusterId'
+ - description: The identifier (ID) of the cluster that contains the HSM.
+ SubnetId:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - description: The subnet that contains the HSM's elastic network interface (ENI).
+ EniId:
+ allOf:
+ - $ref: '#/components/schemas/EniId'
+ - description: The identifier (ID) of the HSM's elastic network interface (ENI).
+ EniIp:
+ allOf:
+ - $ref: '#/components/schemas/IpAddress'
+ - description: The IP address of the HSM's elastic network interface (ENI).
+ HsmId:
+ allOf:
+ - $ref: '#/components/schemas/HsmId'
+ - description: The HSM's identifier (ID).
+ State:
+ allOf:
+ - $ref: '#/components/schemas/HsmState'
+ - description: The HSM's state.
+ StateMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the HSM's state.
+ description: Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.
+ HsmId:
+ type: string
+ pattern: 'hsm-[2-7a-zA-Z]{11,16}'
+ EniId:
+ type: string
+ pattern: 'eni-[0-9a-fA-F]{8,17}'
+ NextToken:
+ type: string
+ pattern: .*
+ maxLength: 256
+ Filters:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/Strings'
+ SubnetId:
+ type: string
+ pattern: 'subnet-[0-9a-fA-F]{8,17}'
+ Field:
+ type: string
+ pattern: '[a-zA-Z0-9_-]+'
+ Strings:
+ type: array
+ items:
+ $ref: '#/components/schemas/String'
+ HsmState:
+ type: string
+ enum:
+ - CREATE_IN_PROGRESS
+ - ACTIVE
+ - DEGRADED
+ - DELETE_IN_PROGRESS
+ - DELETED
+ String:
+ type: string
+ ResourceId:
+ type: string
+ pattern: '(?:cluster|backup)-[2-7a-zA-Z]{11,16}'
+ MaxSize:
+ type: integer
+ minimum: 1
+ maximum: 100
+ TagKey:
+ type: string
+ pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$'
+ minLength: 1
+ maxLength: 128
+ TagValue:
+ type: string
+ pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$'
+ minLength: 0
+ maxLength: 256
+ Tag:
+ type: object
+ required:
+ - Key
+ - Value
+ properties:
+ Key:
+ allOf:
+ - $ref: '#/components/schemas/TagKey'
+ - description: The key of the tag.
+ Value:
+ allOf:
+ - $ref: '#/components/schemas/TagValue'
+ - description: The value of the tag.
+ description: Contains a tag. A tag is a key-value pair.
+ TagKeyList:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagKey'
+ minItems: 1
+ maxItems: 50
+ x-stackQL-resources:
+ clusters:
+ name: clusters
+ methods:
+ create_cluster:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.CreateCluster/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ delete_cluster:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.DeleteCluster/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ describe_clusters:
+ operation:
+ $ref: '#/paths/~1/post'
+ request:
+ mediaType: application/x-amz-json-1.1
+ default: |
+ {
+ "Filters": {}
+ }
+ response:
+ objectKey: '$.Clusters'
+ mediaType: application/json
+ openAPIDocKey: '200'
+ initialize_cluster:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.InitializeCluster/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ modify_cluster:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.ModifyCluster/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ id: aws.cloudhsm.clusters
+ sqlVerbs:
+ delete:
+ - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_cluster'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/clusters/methods/create_cluster'
+ select:
+ - $ref: '#/components/x-stackQL-resources/clusters/methods/describe_clusters'
+ update: []
+ title: clusters
+ hsm:
+ name: hsm
+ methods:
+ create_hsm:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.CreateHsm/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ delete_hsm:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.DeleteHsm/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ id: aws.cloudhsm.hsm
+ sqlVerbs:
+ delete:
+ - $ref: '#/components/x-stackQL-resources/hsm/methods/delete_hsm'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/hsm/methods/create_hsm'
+ select: []
+ update: []
+ title: hsm
+ backups:
+ name: backups
+ methods:
+ copy_backup_to_region:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.CopyBackupToRegion/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ delete_backup:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.DeleteBackup/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ describe_backups:
+ operation:
+ $ref: '#/paths/~1?__X-Amz-Target=BaldrApiService.DescribeBackups/post'
+ request:
+ mediaType: application/x-amz-json-1.1
+ default: |
+ {
+ "Filters": {}
+ }
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.Backups
+ modify_backup_attributes:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.ModifyBackupAttributes/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ restore_backup:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.RestoreBackup/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ id: aws.cloudhsm.backups
+ sqlVerbs:
+ delete:
+ - $ref: '#/components/x-stackQL-resources/backups/methods/delete_backup'
+ insert: []
+ select:
+ - $ref: '#/components/x-stackQL-resources/backups/methods/describe_backups'
+ update: []
+ title: backups
+ tags:
+ name: tags
+ methods:
+ list_tags:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.ListTags/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ # objectKey: $.ResourceDescriptions
+ tag_resource:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.TagResource/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ untag_resource:
+ operation:
+ $ref: '#/paths/~1#X-Amz-Target=BaldrApiService.UntagResource/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ id: aws.cloudhsm.tags
+ sqlVerbs:
+ delete: []
+ insert: []
+ select:
+ - $ref: '#/components/x-stackQL-resources/tags/methods/list_tags'
+ update: []
+ title: tags
+security:
+ - hmac: []
+x-stackQL-config:
+ requestTranslate:
+ algorithm: drop_double_underscore_params
\ No newline at end of file
diff --git a/providers/src/aws/v00.00.00000/services/cloudwatch_api.yaml b/providers/src/aws/v00.00.00000/services/cloudwatch_api.yaml
new file mode 100644
index 00000000..97ffe447
--- /dev/null
+++ b/providers/src/aws/v00.00.00000/services/cloudwatch_api.yaml
@@ -0,0 +1,4741 @@
+openapi: 3.0.0
+info:
+ version: '2014-03-28'
+ x-release: v4
+ title: Amazon CloudWatch Logs
+ description: 'You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
You can use CloudWatch Logs to:
Monitor logs from EC2 instances in real time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs. Then, it can send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring so no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException"). You can also count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.
Monitor CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can use the notification to perform troubleshooting.
Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events earlier than this setting are automatically deleted. The CloudWatch Logs agent helps to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.
Associates the specified KMS key with the specified log group.
Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS keyis still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.
Cancels the specified export task.
The task must be in the PENDING or RUNNING state.
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
Creates a log group with the specified name. You can create up to 20,000 log groups per account.
You must use the following guidelines when naming a log group:
Log group names must be unique within a Region for an Amazon Web Services account.
Log group names can be between 1 and 512 characters long.
Log group names consist of the following characters: a-z, A-Z, 0-9, ''_'' (underscore), ''-'' (hyphen), ''/'' (forward slash), ''.'' (period), and ''#'' (number sign)
When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
If you attempt to associate a KMS key with the log group but the KMS keydoes not exist or the KMS key is disabled, you receive an InvalidParameterException error.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.
You must use the following guidelines when naming a log stream:
Log stream names must be unique within the log group.
Log stream names can be between 1 and 512 characters long.
Don''t use '':'' (colon) or ''*'' (asterisk) characters.
Deletes the data protection policy from the specified log group.
For more information about data protection policies, see PutDataProtectionPolicy.
' + responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '482': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteDataProtectionPolicyRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DeleteDataProtectionPolicy + 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' + /#X-Amz-Target=Logs_20140328.DeleteDestination: + post: + operationId: DeleteDestination + description: 'Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.' + responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteDestinationRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DeleteDestination + 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' + /#X-Amz-Target=Logs_20140328.DeleteLogGroup: + post: + operationId: DeleteLogGroup + description: Deletes the specified log group and permanently deletes all the archived log events associated with the log group. + responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteLogGroupRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DeleteLogGroup + 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' + /#X-Amz-Target=Logs_20140328.DeleteLogStream: + post: + operationId: DeleteLogStream + description: Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream. + responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteLogStreamRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DeleteLogStream + 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' + /#X-Amz-Target=Logs_20140328.DeleteMetricFilter: + post: + operationId: DeleteMetricFilter + description: Deletes the specified metric filter. + responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteMetricFilterRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DeleteMetricFilter + 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' + /#X-Amz-Target=Logs_20140328.DeleteQueryDefinition: + post: + operationId: DeleteQueryDefinition + description: 'Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.
Each DeleteQueryDefinition operation can delete one query definition.
You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
+ responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteRetentionPolicyRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DeleteRetentionPolicy + 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' + /#X-Amz-Target=Logs_20140328.DeleteSubscriptionFilter: + post: + operationId: DeleteSubscriptionFilter + description: Deletes the specified subscription filter. + responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteSubscriptionFilterRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DeleteSubscriptionFilter + 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' + /#X-Amz-Target=Logs_20140328.DescribeDestinations: + post: + operationId: DescribeDestinations + description: Lists all your destinations. The results are ASCII-sorted by destination name. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeDestinationsResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeDestinationsRequest' + parameters: + - name: limit + in: query + schema: + type: string + description: Pagination limit + required: false + - name: nextToken + in: query + schema: + type: string + description: Pagination token + required: false + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DescribeDestinations + 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' + /#X-Amz-Target=Logs_20140328.DescribeExportTasks: + post: + operationId: DescribeExportTasks + description: Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeExportTasksResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeExportTasksRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DescribeExportTasks + 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' + /#X-Amz-Target=Logs_20140328.DescribeLogGroups: + post: + operationId: DescribeLogGroups + description: 'Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeLogGroupsResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeLogGroupsRequest' + parameters: + - name: limit + in: query + schema: + type: string + description: Pagination limit + required: false + - name: nextToken + in: query + schema: + type: string + description: Pagination token + required: false + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DescribeLogGroups + 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' + /#X-Amz-Target=Logs_20140328.DescribeLogStreams: + post: + operationId: DescribeLogStreams + description: 'Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.
You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can''t include both.
This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeLogStreamsResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeLogStreamsRequest' + parameters: + - name: limit + in: query + schema: + type: string + description: Pagination limit + required: false + - name: nextToken + in: query + schema: + type: string + description: Pagination token + required: false + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DescribeLogStreams + 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' + /#X-Amz-Target=Logs_20140328.DescribeMetricFilters: + post: + operationId: DescribeMetricFilters + description: 'Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeMetricFiltersResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeMetricFiltersRequest' + parameters: + - name: limit + in: query + schema: + type: string + description: Pagination limit + required: false + - name: nextToken + in: query + schema: + type: string + description: Pagination token + required: false + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DescribeMetricFilters + 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' + /#X-Amz-Target=Logs_20140328.DescribeQueries: + post: + operationId: DescribeQueries + description: 'Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeQueriesResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeQueriesRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DescribeQueries + 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' + /#X-Amz-Target=Logs_20140328.DescribeQueryDefinitions: + post: + operationId: DescribeQueryDefinitions + description:This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string.
Disassociates the associated KMS key from the specified log group.
After the KMS key is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the KMS key whenever the encrypted data is requested.
Note that it can take up to 5 minutes for this operation to take effect.
' + responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DisassociateKmsKeyRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.DisassociateKmsKey + 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' + /#X-Amz-Target=Logs_20140328.FilterLogEvents: + post: + operationId: FilterLogEvents + description: 'Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.
You must have the logs;FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can''t include both.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/FilterLogEventsResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/FilterLogEventsRequest' + parameters: + - name: limit + in: query + schema: + type: string + description: Pagination limit + required: false + - name: nextToken + in: query + schema: + type: string + description: Pagination token + required: false + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.FilterLogEvents + 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' + /#X-Amz-Target=Logs_20140328.GetDataProtectionPolicy: + post: + operationId: GetDataProtectionPolicy + description: Returns information about a log group data protection policy. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetDataProtectionPolicyResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '482': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/GetDataProtectionPolicyRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.GetDataProtectionPolicy + 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' + /: + post: + operationId: GetLogEvents + description: 'Lists log events from the specified log stream. You can list all of the log events or filter using a time range.
By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can''t include both.
Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.
You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must specify one of these parameters, but you can''t specify both.
In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.
The response results are sorted by the frequency percentage, starting with the highest percentage.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetLogGroupFieldsResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: LimitExceededException + content: + application/json: + schema: + $ref: '#/components/schemas/LimitExceededException' + '482': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/GetLogGroupFieldsRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.GetLogGroupFields + 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' + /#X-Amz-Target=Logs_20140328.GetLogRecord: + post: + operationId: GetLogRecord + description: 'Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.
The full unparsed log event is returned within @message.
Returns the results from the specified query.
Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.
GetQueryResults does not start running a query. To run a query, use StartQuery.
If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.
' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetQueryResultsResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/GetQueryResultsRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.GetQueryResults + 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' + /#X-Amz-Target=Logs_20140328.ListTagsForResource: + post: + operationId: ListTagsForResource + description: 'Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListTagsForResourceResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ListTagsForResourceRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.ListTagsForResource + 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' + /#X-Amz-Target=Logs_20140328.ListTagsLogGroup: + post: + deprecated: true + operationId: ListTagsLogGroup + description: 'The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
Lists the tags for the specified log group.
' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListTagsLogGroupResponse' + '480': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '481': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ListTagsLogGroupRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.ListTagsLogGroup + 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' + /#X-Amz-Target=Logs_20140328.PutDataProtectionPolicy: + post: + operationId: PutDataProtectionPolicy + description: 'Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that''s ingested by the log group by auditing and masking the sensitive log data.
Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.
' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PutDataProtectionPolicyResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: LimitExceededException + content: + application/json: + schema: + $ref: '#/components/schemas/LimitExceededException' + '482': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '483': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '484': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PutDataProtectionPolicyRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.PutDataProtectionPolicy + 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' + /#X-Amz-Target=Logs_20140328.PutDestination: + post: + operationId: PutDestination + description: 'Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.
A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.
Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.
To perform a PutDestination operation, you must also have the iam:PassRole permission.
Uploads a batch of log events to the specified log stream.
The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.
If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.
Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.
The maximum number of metric filters that can be associated with a log group is 100.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don''t specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups.
You must have the logs:PutQueryDefinition permission to be able to perform this operation.
Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.
To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination that belongs to a different account, for cross-account delivery.
An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName.
To perform a PutSubscriptionFilter operation, you must also have the iam:PassRole permission.
Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.
For more information, see CloudWatch Logs Insights Query Syntax.
Queries time out after 15 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query definition must be defined in the monitoring account.
You can have up to 20 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/StartQueryResponse' + '480': + description: MalformedQueryException + content: + application/json: + schema: + $ref: '#/components/schemas/MalformedQueryException' + '481': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '482': + description: LimitExceededException + content: + application/json: + schema: + $ref: '#/components/schemas/LimitExceededException' + '483': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '484': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/StartQueryRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.StartQuery + 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' + /#X-Amz-Target=Logs_20140328.StopQuery: + post: + operationId: StopQuery + description: 'Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/StopQueryResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/StopQueryRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.StopQuery + 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' + /#X-Amz-Target=Logs_20140328.TagLogGroup: + post: + deprecated: true + operationId: TagLogGroup + description: 'The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don''t have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch Logs resource.
' + responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '483': + description: TooManyTagsException + content: + application/json: + schema: + $ref: '#/components/schemas/TooManyTagsException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TagResourceRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.TagResource + 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' + /#X-Amz-Target=Logs_20140328.TestMetricFilter: + post: + operationId: TestMetricFilter + description: Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/TestMetricFilterResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TestMetricFilterRequest' + parameters: + - name: X-Amz-Target + in: header + required: true + schema: + type: string + enum: + - Logs_20140328.TestMetricFilter + 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' + /#X-Amz-Target=Logs_20140328.UntagLogGroup: + post: + deprecated: true + operationId: UntagLogGroup + description: 'The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.
Removes the specified tags from the specified log group.
To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.
CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys.
Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported.'
+ to:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.
You must specify a time that is not earlier than when this log group was created.
' + destination: + allOf: + - $ref: '#/components/schemas/ExportDestinationBucket' + - description: The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region. + destinationPrefix: + allOf: + - $ref: '#/components/schemas/ExportDestinationPrefix' + - description: 'The prefix used as the start of the key for every object exported. If you don''t specify a value, the default isexportedlogs.'
+ LimitExceededException: {}
+ ResourceAlreadyExistsException: {}
+ CreateLogGroupRequest:
+ type: object
+ required:
+ - logGroupName
+ title: CreateLogGroupRequest
+ properties:
+ logGroupName:
+ allOf:
+ - $ref: '#/components/schemas/LogGroupName'
+ - description: The name of the log group.
+ kmsKeyId:
+ allOf:
+ - $ref: '#/components/schemas/KmsKeyId'
+ - description: 'The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names.'
+ tags:
+ allOf:
+ - $ref: '#/components/schemas/Tags'
+ - description: 'The key-value pairs to use for the tags.
You can grant users access to certain log groups while preventing them from accessing other log groups. To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when you create a log group, you must have either the logs:TagResource or logs:TagLogGroup permission. For more information about tagging, see Tagging Amazon Web Services resources. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
The log groups.
If the retentionInDays value is not included for a log group, then that log group''s events do not expire.
includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array. '
+ logGroupNamePrefix:
+ allOf:
+ - $ref: '#/components/schemas/LogGroupName'
+ - description: The prefix to match.
logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.
If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.
logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.
If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.
If you specify includeLinkedAccounts in your request, then metricFilterCount, retentionInDays, and storedBytes are not included in the response.
The name of the log group.
You must include either logGroupIdentifier or logGroupName, but not both.
Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
You must include either logGroupIdentifier or logGroupName, but not both.
The prefix to match.
If orderBy is LastEventTime, you cannot specify this parameter.
If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.
If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.
lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.
logGroupName parameter in your request.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next set of items to return. (You received this token from a previous call.)
+ limit:
+ allOf:
+ - $ref: '#/components/schemas/DescribeLimit'
+ - description: 'The maximum number of items returned. If you don''t specify a value, the default is up to 50 items.'
+ metricName:
+ allOf:
+ - $ref: '#/components/schemas/MetricName'
+ - description: 'Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the metricNamespace parameter.'
+ metricNamespace:
+ allOf:
+ - $ref: '#/components/schemas/MetricNamespace'
+ - description: 'Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the metricName parameter.'
+ DescribeQueriesResponse:
+ type: object
+ properties:
+ queries:
+ allOf:
+ - $ref: '#/components/schemas/QueryInfoList'
+ - description: The list of queries that match the request.
+ nextToken:
+ $ref: '#/components/schemas/NextToken'
+ DescribeQueriesRequest:
+ type: object
+ title: DescribeQueriesRequest
+ properties:
+ logGroupName:
+ allOf:
+ - $ref: '#/components/schemas/LogGroupName'
+ - description: Limits the returned queries to only those for the specified log group.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/QueryStatus'
+ - description: 'Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.'
+ maxResults:
+ allOf:
+ - $ref: '#/components/schemas/DescribeQueriesMaxResults'
+ - description: Limits the number of returned queries to the specified number.
+ nextToken:
+ $ref: '#/components/schemas/NextToken'
+ DescribeQueryDefinitionsResponse:
+ type: object
+ properties:
+ queryDefinitions:
+ allOf:
+ - $ref: '#/components/schemas/QueryDefinitionList'
+ - description: The list of query definitions that match your request.
+ nextToken:
+ $ref: '#/components/schemas/NextToken'
+ DescribeQueryDefinitionsRequest:
+ type: object
+ title: DescribeQueryDefinitionsRequest
+ properties:
+ queryDefinitionNamePrefix:
+ allOf:
+ - $ref: '#/components/schemas/QueryDefinitionName'
+ - description: Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.
+ maxResults:
+ allOf:
+ - $ref: '#/components/schemas/QueryListMaxResults'
+ - description: Limits the number of returned query definitions to the specified number.
+ nextToken:
+ $ref: '#/components/schemas/NextToken'
+ DescribeResourcePoliciesResponse:
+ type: object
+ properties:
+ resourcePolicies:
+ allOf:
+ - $ref: '#/components/schemas/ResourcePolicies'
+ - description: The resource policies that exist in this account.
+ nextToken:
+ $ref: '#/components/schemas/NextToken'
+ DescribeResourcePoliciesRequest:
+ type: object
+ title: DescribeResourcePoliciesRequest
+ properties:
+ nextToken:
+ $ref: '#/components/schemas/NextToken'
+ limit:
+ allOf:
+ - $ref: '#/components/schemas/DescribeLimit'
+ - description: The maximum number of resource policies to be displayed with one call of this API.
+ DescribeSubscriptionFiltersResponse:
+ type: object
+ properties:
+ subscriptionFilters:
+ allOf:
+ - $ref: '#/components/schemas/SubscriptionFilters'
+ - description: The subscription filters.
+ nextToken:
+ $ref: '#/components/schemas/NextToken'
+ DescribeSubscriptionFiltersRequest:
+ type: object
+ required:
+ - logGroupName
+ title: DescribeSubscriptionFiltersRequest
+ properties:
+ logGroupName:
+ allOf:
+ - $ref: '#/components/schemas/LogGroupName'
+ - description: The name of the log group.
+ filterNamePrefix:
+ allOf:
+ - $ref: '#/components/schemas/FilterName'
+ - description: 'The prefix to match. If you don''t specify a value, no prefix filter is applied.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next set of items to return. (You received this token from a previous call.)
+ limit:
+ allOf:
+ - $ref: '#/components/schemas/DescribeLimit'
+ - description: 'The maximum number of items returned. If you don''t specify a value, the default is up to 50 items.'
+ DisassociateKmsKeyRequest:
+ type: object
+ required:
+ - logGroupName
+ title: DisassociateKmsKeyRequest
+ properties:
+ logGroupName:
+ allOf:
+ - $ref: '#/components/schemas/LogGroupName'
+ - description: The name of the log group.
+ FilterLogEventsResponse:
+ type: object
+ properties:
+ events:
+ allOf:
+ - $ref: '#/components/schemas/FilteredLogEvents'
+ - description: The matched events.
+ searchedLogStreams:
+ allOf:
+ - $ref: '#/components/schemas/SearchedLogStreams'
+ - description: 'Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list.
Indicates which log streams have been searched and whether each has been searched completely.
' + nextToken: + allOf: + - $ref: '#/components/schemas/NextToken' + - description: The token to use when requesting the next set of items. The token expires after 24 hours. + FilterLogEventsRequest: + type: object + title: FilterLogEventsRequest + properties: + logGroupName: + allOf: + - $ref: '#/components/schemas/LogGroupName' + - description: 'The name of the log group to search.
You must include either logGroupIdentifier or logGroupName, but not both.
Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
You must include either logGroupIdentifier or logGroupName, but not both.
Filters the results to only logs from the log streams in this list.
If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.
Filters the results to include only events from log streams that have names starting with this prefix.
If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.
Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.'
+ endTime:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.'
+ filterPattern:
+ allOf:
+ - $ref: '#/components/schemas/FilterPattern'
+ - description: 'The filter pattern to use. For more information, see Filter and Pattern Syntax.
If not provided, all the events are matched.
' + nextToken: + allOf: + - $ref: '#/components/schemas/NextToken' + - description: The token for the next set of events to return. (You received this token from a previous call.) + limit: + allOf: + - $ref: '#/components/schemas/EventsLimit' + - description: 'The maximum number of events to return. The default is 10,000 events.' + interleaved: + allOf: + - $ref: '#/components/schemas/Interleaved' + - deprecated: true + description: 'If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.
Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group.' + unmask: + allOf: + - $ref: '#/components/schemas/Unmask' + - description: 'Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.
To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.
The name of the log group.
You must include either logGroupIdentifier or logGroupName, but not both.
Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
You must include either logGroupIdentifier or logGroupName, but not both.
Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next set of items to return. (You received this token from a previous call.)
+ limit:
+ allOf:
+ - $ref: '#/components/schemas/EventsLimit'
+ - description: 'The maximum number of log events returned. If you don''t specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).'
+ startFromHead:
+ allOf:
+ - $ref: '#/components/schemas/StartFromHead'
+ - description: 'If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.
If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.
Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.
To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.
The name of the log group to search.
You must include either logGroupIdentifier or logGroupName, but not both.
The time to set as the center of the query. If you specify time, the 15 minutes before this time are queries. If you omit time, the 8 minutes before and 8 minutes after this time are searched.
The time value is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.
Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.
You must include either logGroupIdentifier or logGroupName, but not both.
GetQueryResults operation. In that response, the value of the @ptr field for a log event is the value to use as logRecordPointer to retrieve that complete log event record.'
+ unmask:
+ allOf:
+ - $ref: '#/components/schemas/Unmask'
+ - description: 'Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.
To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.
The log events that matched the query criteria during the most recent time it ran.
The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.
The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.
Queries time out after 15 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.
' + GetQueryResultsRequest: + type: object + required: + - queryId + title: GetQueryResultsRequest + properties: + queryId: + allOf: + - $ref: '#/components/schemas/QueryId' + - description: The ID number of the query. + ListTagsForResourceResponse: + type: object + properties: + tags: + allOf: + - $ref: '#/components/schemas/Tags' + - description: The list of tags associated with the requested resource.> + ListTagsForResourceRequest: + type: object + required: + - resourceArn + title: ListTagsForResourceRequest + properties: + resourceArn: + allOf: + - $ref: '#/components/schemas/AmazonResourceName' + - description: 'The ARN of the resource that you want to view tags for.
The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name
The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name
For more information about ARN format, see CloudWatch Logs resources and operations.
' + ListTagsLogGroupResponse: + type: object + deprecated: true + properties: + tags: + allOf: + - $ref: '#/components/schemas/Tags' + - description: The tags for the log group. + description: Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse + ListTagsLogGroupRequest: + type: object + required: + - logGroupName + deprecated: true + title: ListTagsLogGroupRequest + properties: + logGroupName: + allOf: + - $ref: '#/components/schemas/LogGroupName' + - description: The name of the log group. + description: Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse + PutDataProtectionPolicyResponse: + type: object + properties: + logGroupIdentifier: + allOf: + - $ref: '#/components/schemas/LogGroupIdentifier' + - description: The log group name or ARN that you specified in your request. + policyDocument: + allOf: + - $ref: '#/components/schemas/DataProtectionPolicyDocument' + - description: The data protection policy used for this log group. + lastUpdatedTime: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: The date and time that this policy was most recently updated. + PutDataProtectionPolicyRequest: + type: object + required: + - logGroupIdentifier + - policyDocument + title: PutDataProtectionPolicyRequest + properties: + logGroupIdentifier: + allOf: + - $ref: '#/components/schemas/LogGroupIdentifier' + - description: Specify either the log group name or log group ARN. + policyDocument: + allOf: + - $ref: '#/components/schemas/DataProtectionPolicyDocument' + - description: 'Specify the data protection policy, in JSON.
This policy must include two JSON blocks:
The first block must include both a DataIdentifer array and an Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask.
The Operation property with an Audit action is required to find the sensitive data terms. This Audit action must contain a FindingsDestination object. You can optionally use that FindingsDestination object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, they must already exist.
The second block must include both a DataIdentifer array and an Operation property with an Deidentify action. The DataIdentifer array must exactly match the DataIdentifer array in the first block of the policy.
The Operation property with the Deidentify action is what actually masks the data, and it must contain the "MaskConfig": {} object. The "MaskConfig": {} object must be empty.
For an example data protection policy, see the Examples section on this page.
The contents of two DataIdentifer arrays must match exactly.
PutRecord operation on the destination stream.
+ tags:
+ allOf:
+ - $ref: '#/components/schemas/Tags'
+ - description: 'An optional list of key-value pairs to associate with the resource.
For more information about tagging, see Tagging Amazon Web Services resources
' + PutDestinationPolicyRequest: + type: object + required: + - destinationName + - accessPolicy + title: PutDestinationPolicyRequest + properties: + destinationName: + allOf: + - $ref: '#/components/schemas/DestinationName' + - description: A name for an existing destination. + accessPolicy: + allOf: + - $ref: '#/components/schemas/AccessPolicy' + - description: An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes. + forceUpdate: + allOf: + - $ref: '#/components/schemas/ForceUpdate' + - description: 'Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual AWS accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying true for forceUpdate, you are affirming that you have already updated the subscription filters. For more information, see Updating an existing cross-account subscription
If you omit this parameter, the default of false is used.
The next sequence token.
This field has been deprecated.
The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream and you do not need to wait for the response of a previous PutLogEvents action to obtain the nextSequenceToken value.
The sequence token obtained from the response of the previous PutLogEvents call.
The sequenceToken parameter is now ignored in PutLogEvents actions. PutLogEvents actions are now accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid.
queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.'
+ queryDefinitionId:
+ allOf:
+ - $ref: '#/components/schemas/QueryId'
+ - description: 'If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.
If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.
' + logGroupNames: + allOf: + - $ref: '#/components/schemas/LogGroupNames' + - description: 'Use this parameter to include specific log groups as part of your query definition.
If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.
' + queryString: + allOf: + - $ref: '#/components/schemas/QueryDefinitionString' + - description: 'The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.' + PutResourcePolicyResponse: + type: object + properties: + resourcePolicy: + allOf: + - $ref: '#/components/schemas/ResourcePolicy' + - description: The new policy. + PutResourcePolicyRequest: + type: object + title: PutResourcePolicyRequest + properties: + policyName: + allOf: + - $ref: '#/components/schemas/PolicyName' + - description: Name of the new policy. This parameter is required. + policyDocument: + allOf: + - $ref: '#/components/schemas/PolicyDocument' + - description: "Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required.
The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.
CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.
In the example resource policy, you would replace the value of SourceArn with the resource making the call from Route\_53 to CloudWatch Logs. You would also replace the value of SourceAccount with the Amazon Web Services account ID making that call.
{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Sid\": \"Route53LogsToCloudWatchLogs\", \"Effect\": \"Allow\", \"Principal\": { \"Service\": [ \"route53.amazonaws.com\" ] }, \"Action\": \"logs:PutLogEvents\", \"Resource\": \"logArn\", \"Condition\": { \"ArnLike\": { \"aws:SourceArn\": \"myRoute53ResourceArn\" }, \"StringEquals\": { \"aws:SourceAccount\": \"myAwsAccountId\" } } } ] }
filterName. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.'
+ filterPattern:
+ allOf:
+ - $ref: '#/components/schemas/FilterPattern'
+ - description: A filter pattern for subscribing to a filtered stream of log events.
+ destinationArn:
+ allOf:
+ - $ref: '#/components/schemas/DestinationArn'
+ - description: 'The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:
An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.
If you''re setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.
A Kinesis Data Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.
A Lambda function belonging to the same account as the subscription filter, for same-account delivery.
The log group on which to perform the query.
A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames or logGroupIdentifiers.
The list of log groups to be queried. You can include up to 50 log groups.
A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames or logGroupIdentifiers.
The list of log groups to query. You can include up to 50 log groups.
You can specify them by the log group name or ARN. If a log group that you''re querying is in a source account and you''re using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.
If you specify an ARN, the ARN can''t end with an asterisk (*).
A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames or logGroupIdentifiers.
January 1, 1970, 00:00:00 UTC.'
+ endTime:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.'
+ queryString:
+ allOf:
+ - $ref: '#/components/schemas/QueryString'
+ - description: 'The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.'
+ limit:
+ allOf:
+ - $ref: '#/components/schemas/EventsLimit'
+ - description: 'The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.'
+ MalformedQueryException: {}
+ StopQueryResponse:
+ type: object
+ properties:
+ success:
+ allOf:
+ - $ref: '#/components/schemas/Success'
+ - description: This is true if the query was stopped by the StopQuery operation.
+ StopQueryRequest:
+ type: object
+ required:
+ - queryId
+ title: StopQueryRequest
+ properties:
+ queryId:
+ allOf:
+ - $ref: '#/components/schemas/QueryId'
+ - description: 'The ID number of the query to stop. To find this ID number, use DescribeQueries.'
+ TagLogGroupRequest:
+ type: object
+ required:
+ - logGroupName
+ - tags
+ deprecated: true
+ title: TagLogGroupRequest
+ properties:
+ logGroupName:
+ allOf:
+ - $ref: '#/components/schemas/LogGroupName'
+ - description: The name of the log group.
+ tags:
+ allOf:
+ - $ref: '#/components/schemas/Tags'
+ - description: The key-value pairs to use for the tags.
+ description: Please use the generic tagging API model TagResourceRequest
+ TagResourceRequest:
+ type: object
+ required:
+ - resourceArn
+ - tags
+ title: TagResourceRequest
+ properties:
+ resourceArn:
+ allOf:
+ - $ref: '#/components/schemas/AmazonResourceName'
+ - description: 'The ARN of the resource that you''re adding tags to.
The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name
The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name
For more information about ARN format, see CloudWatch Logs resources and operations.
' + tags: + allOf: + - $ref: '#/components/schemas/Tags' + - description: The list of key-value pairs to associate with the resource. + TooManyTagsException: {} + TestMetricFilterResponse: + type: object + properties: + matches: + allOf: + - $ref: '#/components/schemas/MetricFilterMatches' + - description: The matched events. + TestMetricFilterRequest: + type: object + required: + - filterPattern + - logEventMessages + title: TestMetricFilterRequest + properties: + filterPattern: + $ref: '#/components/schemas/FilterPattern' + logEventMessages: + allOf: + - $ref: '#/components/schemas/TestEventMessages' + - description: The log event messages to test. + UntagLogGroupRequest: + type: object + required: + - logGroupName + - tags + deprecated: true + title: UntagLogGroupRequest + properties: + logGroupName: + allOf: + - $ref: '#/components/schemas/LogGroupName' + - description: The name of the log group. + tags: + allOf: + - $ref: '#/components/schemas/TagList' + - description: The tag keys. The corresponding tags are removed from the log group. + description: Please use the generic tagging API model UntagResourceRequest + UntagResourceRequest: + type: object + required: + - resourceArn + - tagKeys + title: UntagResourceRequest + properties: + resourceArn: + allOf: + - $ref: '#/components/schemas/AmazonResourceName' + - description: 'The ARN of the CloudWatch Logs resource that you''re removing tags from.
The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name
The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name
For more information about ARN format, see CloudWatch Logs resources and operations.
' + tagKeys: + allOf: + - $ref: '#/components/schemas/TagKeyList' + - description: The list of tag keys to remove from the resource. + AccessPolicy: + type: string + minLength: 1 + AccountId: + type: string + pattern: '^\d{12}$' + minLength: 12 + maxLength: 12 + AccountIds: + type: array + items: + $ref: '#/components/schemas/AccountId' + minItems: 0 + maxItems: 20 + AmazonResourceName: + type: string + pattern: '[\w+=/:,.@-]*' + minLength: 1 + maxLength: 1011 + Arn: + type: string + LogGroupName: + type: string + pattern: '[\.\-_/#A-Za-z0-9]+' + minLength: 1 + maxLength: 512 + KmsKeyId: + type: string + maxLength: 256 + ExportTaskId: + type: string + minLength: 1 + maxLength: 512 + ExportTaskName: + type: string + minLength: 1 + maxLength: 512 + LogStreamName: + type: string + pattern: '[^:*]*' + minLength: 1 + maxLength: 512 + Timestamp: + type: number + minimum: 0 + ExportDestinationBucket: + type: string + minLength: 1 + maxLength: 512 + ExportDestinationPrefix: + type: string + Tags: + type: object + minProperties: 1 + maxProperties: 50 + additionalProperties: + $ref: '#/components/schemas/TagValue' + DataProtectionPolicyDocument: + type: string + DataProtectionStatus: + type: string + enum: + - ACTIVATED + - DELETED + - ARCHIVED + - DISABLED + Days: + type: integer + description: 'The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.
To set a log group so that its log events do not expire, use DeleteRetentionPolicy.
' + DefaultValue: + type: number + format: double + LogGroupIdentifier: + type: string + pattern: '[\w#+=/:,.@-]*' + minLength: 1 + maxLength: 2048 + DestinationName: + type: string + pattern: '[^:*]*' + minLength: 1 + maxLength: 512 + FilterName: + type: string + pattern: '[^:*]*' + minLength: 1 + maxLength: 512 + QueryId: + type: string + minLength: 0 + maxLength: 256 + Success: + type: boolean + PolicyName: + type: string + Descending: + type: boolean + NextToken: + type: string + description: The token for the next set of items to return. The token expires after 24 hours. + minLength: 1 + DescribeLimit: + type: integer + minimum: 1 + maximum: 50 + Destinations: + type: array + items: + $ref: '#/components/schemas/Destination' + ExportTaskStatusCode: + type: string + enum: + - CANCELLED + - COMPLETED + - FAILED + - PENDING + - PENDING_CANCEL + - RUNNING + ExportTasks: + type: array + items: + $ref: '#/components/schemas/ExportTask' + LogGroupNamePattern: + type: string + pattern: '[\.\-_/#A-Za-z0-9]*' + minLength: 0 + maxLength: 512 + IncludeLinkedAccounts: + type: boolean + LogGroups: + type: array + items: + $ref: '#/components/schemas/LogGroup' + OrderBy: + type: string + enum: + - LogStreamName + - LastEventTime + LogStreams: + type: array + items: + $ref: '#/components/schemas/LogStream' + MetricName: + type: string + pattern: '[^:*$]*' + description: 'The name of the CloudWatch metric to which the monitored log information should be published. For example, you might publish to a metric named ErrorCount.' + maxLength: 255 + MetricNamespace: + type: string + pattern: '[^:*$]*' + maxLength: 255 + MetricFilters: + type: array + items: + $ref: '#/components/schemas/MetricFilter' + DescribeQueriesMaxResults: + type: integer + minimum: 1 + maximum: 1000 + QueryStatus: + type: string + enum: + - Scheduled + - Running + - Complete + - Failed + - Cancelled + - Timeout + - Unknown + QueryInfoList: + type: array + items: + $ref: '#/components/schemas/QueryInfo' + QueryDefinitionName: + type: string + minLength: 1 + maxLength: 255 + QueryListMaxResults: + type: integer + minimum: 1 + maximum: 1000 + QueryDefinitionList: + type: array + items: + $ref: '#/components/schemas/QueryDefinition' + ResourcePolicies: + type: array + items: + $ref: '#/components/schemas/ResourcePolicy' + SubscriptionFilters: + type: array + items: + $ref: '#/components/schemas/SubscriptionFilter' + TargetArn: + type: string + minLength: 1 + RoleArn: + type: string + minLength: 1 + Destination: + type: object + properties: + destinationName: + allOf: + - $ref: '#/components/schemas/DestinationName' + - description: The name of the destination. + targetArn: + allOf: + - $ref: '#/components/schemas/TargetArn' + - description: 'The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).' + roleArn: + allOf: + - $ref: '#/components/schemas/RoleArn' + - description: 'A role for impersonation, used when delivering log events to the target.' + accessPolicy: + allOf: + - $ref: '#/components/schemas/AccessPolicy' + - description: An IAM policy document that governs which Amazon Web Services accounts can create subscription filters against this destination. + arn: + allOf: + - $ref: '#/components/schemas/Arn' + - description: The ARN of this destination. + creationTime: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: 'The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' + description: Represents a cross-account destination that receives subscription log events. + DestinationArn: + type: string + minLength: 1 + DimensionsValue: + type: string + maxLength: 255 + Dimensions: + type: object + additionalProperties: + $ref: '#/components/schemas/DimensionsValue' + DimensionsKey: + type: string + maxLength: 255 + Distribution: + type: string + enum: + - Random + - ByLogStream + description: 'The method used to distribute log data to the destination, which can be either random or grouped by log stream.' + EventId: + type: string + EventMessage: + type: string + minLength: 1 + EventNumber: + type: integer + EventsLimit: + type: integer + minimum: 1 + maximum: 10000 + ExportTaskStatus: + type: object + properties: + code: + allOf: + - $ref: '#/components/schemas/ExportTaskStatusCode' + - description: The status code of the export task. + message: + allOf: + - $ref: '#/components/schemas/ExportTaskStatusMessage' + - description: The status message related to the status code. + description: Represents the status of an export task. + ExportTaskExecutionInfo: + type: object + properties: + creationTime: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: 'The creation time of the export task, expressed as the number of milliseconds afterJan 1, 1970 00:00:00 UTC.'
+ completionTime:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.'
+ description: Represents the status of an export task.
+ ExportTask:
+ type: object
+ properties:
+ taskId:
+ allOf:
+ - $ref: '#/components/schemas/ExportTaskId'
+ - description: The ID of the export task.
+ taskName:
+ allOf:
+ - $ref: '#/components/schemas/ExportTaskName'
+ - description: The name of the export task.
+ logGroupName:
+ allOf:
+ - $ref: '#/components/schemas/LogGroupName'
+ - description: The name of the log group from which logs data was exported.
+ from:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not exported.'
+ to:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.'
+ destination:
+ allOf:
+ - $ref: '#/components/schemas/ExportDestinationBucket'
+ - description: The name of the S3 bucket to which the log data was exported.
+ destinationPrefix:
+ allOf:
+ - $ref: '#/components/schemas/ExportDestinationPrefix'
+ - description: The prefix that was used as the start of Amazon S3 key for every object exported.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ExportTaskStatus'
+ - description: The status of the export task.
+ executionInfo:
+ allOf:
+ - $ref: '#/components/schemas/ExportTaskExecutionInfo'
+ - description: Execution information about the export task.
+ description: Represents an export task.
+ ExportTaskStatusMessage:
+ type: string
+ Value:
+ type: string
+ ExtractedValues:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/Value'
+ Field:
+ type: string
+ FilterCount:
+ type: integer
+ InputLogStreamNames:
+ type: array
+ items:
+ $ref: '#/components/schemas/LogStreamName'
+ minItems: 1
+ maxItems: 100
+ FilterPattern:
+ type: string
+ description: 'A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.'
+ minLength: 0
+ maxLength: 1024
+ Interleaved:
+ type: boolean
+ Unmask:
+ type: boolean
+ FilteredLogEvents:
+ type: array
+ items:
+ $ref: '#/components/schemas/FilteredLogEvent'
+ SearchedLogStreams:
+ type: array
+ items:
+ $ref: '#/components/schemas/SearchedLogStream'
+ FilteredLogEvent:
+ type: object
+ properties:
+ logStreamName:
+ allOf:
+ - $ref: '#/components/schemas/LogStreamName'
+ - description: The name of the log stream to which this event belongs.
+ timestamp:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.'
+ message:
+ allOf:
+ - $ref: '#/components/schemas/EventMessage'
+ - description: The data contained in the log event.
+ ingestionTime:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.'
+ eventId:
+ allOf:
+ - $ref: '#/components/schemas/EventId'
+ - description: The ID of the event.
+ description: Represents a matched event.
+ ForceUpdate:
+ type: boolean
+ StartFromHead:
+ type: boolean
+ OutputLogEvents:
+ type: array
+ items:
+ $ref: '#/components/schemas/OutputLogEvent'
+ LogGroupFieldList:
+ type: array
+ items:
+ $ref: '#/components/schemas/LogGroupField'
+ LogRecordPointer:
+ type: string
+ LogRecord:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/Value'
+ QueryResults:
+ type: array
+ items:
+ $ref: '#/components/schemas/ResultRows'
+ QueryStatistics:
+ type: object
+ properties:
+ recordsMatched:
+ allOf:
+ - $ref: '#/components/schemas/StatsValue'
+ - description: The number of log events that matched the query string.
+ recordsScanned:
+ allOf:
+ - $ref: '#/components/schemas/StatsValue'
+ - description: The total number of log events scanned during the query.
+ bytesScanned:
+ allOf:
+ - $ref: '#/components/schemas/StatsValue'
+ - description: The total number of bytes in the log events scanned during the query.
+ description: 'Contains the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned.'
+ InputLogEvent:
+ type: object
+ required:
+ - timestamp
+ - message
+ properties:
+ timestamp:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.'
+ message:
+ allOf:
+ - $ref: '#/components/schemas/EventMessage'
+ - description: The raw event message.
+ description: 'Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.'
+ InputLogEvents:
+ type: array
+ items:
+ $ref: '#/components/schemas/InputLogEvent'
+ minItems: 1
+ maxItems: 10000
+ LogEventIndex:
+ type: integer
+ StoredBytes:
+ type: integer
+ minimum: 0
+ LogGroup:
+ type: object
+ properties:
+ logGroupName:
+ allOf:
+ - $ref: '#/components/schemas/LogGroupName'
+ - description: The name of the log group.
+ creationTime:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.'
+ retentionInDays:
+ $ref: '#/components/schemas/Days'
+ metricFilterCount:
+ allOf:
+ - $ref: '#/components/schemas/FilterCount'
+ - description: The number of metric filters.
+ arn:
+ allOf:
+ - $ref: '#/components/schemas/Arn'
+ - description: The Amazon Resource Name (ARN) of the log group.
+ storedBytes:
+ allOf:
+ - $ref: '#/components/schemas/StoredBytes'
+ - description: The number of bytes stored.
+ kmsKeyId:
+ allOf:
+ - $ref: '#/components/schemas/KmsKeyId'
+ - description: The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
+ dataProtectionStatus:
+ allOf:
+ - $ref: '#/components/schemas/DataProtectionStatus'
+ - description: 'Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.'
+ description: Represents a log group.
+ Percentage:
+ type: integer
+ minimum: 0
+ maximum: 100
+ LogGroupField:
+ type: object
+ properties:
+ name:
+ allOf:
+ - $ref: '#/components/schemas/Field'
+ - description: The name of a log field.
+ percent:
+ allOf:
+ - $ref: '#/components/schemas/Percentage'
+ - description: The percentage of log events queried that contained the field.
+ description: 'The fields contained in log events found by a GetLogGroupFields operation, along with the percentage of queried log events in which each field appears.'
+ LogGroupIdentifiers:
+ type: array
+ items:
+ $ref: '#/components/schemas/LogGroupIdentifier'
+ LogGroupNames:
+ type: array
+ items:
+ $ref: '#/components/schemas/LogGroupName'
+ SequenceToken:
+ type: string
+ minLength: 1
+ LogStream:
+ type: object
+ properties:
+ logStreamName:
+ allOf:
+ - $ref: '#/components/schemas/LogStreamName'
+ - description: The name of the log stream.
+ creationTime:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.'
+ firstEventTimestamp:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.'
+ lastEventTimestamp:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.'
+ lastIngestionTime:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC The lastIngestionTime value updates on an eventual consistency basis. It typically updates in less than an hour after ingestion, but in rare situations might take longer.'
+ uploadSequenceToken:
+ allOf:
+ - $ref: '#/components/schemas/SequenceToken'
+ - description: The sequence token.
The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted regardless of receiving an invalid sequence token. You don't need to obtain uploadSequenceToken to use a PutLogEvents action.
The number of bytes stored.
Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.
Jan 1, 1970 00:00:00 UTC.'
+ logGroupName:
+ allOf:
+ - $ref: '#/components/schemas/LogGroupName'
+ - description: The name of the log group.
+ description: Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.
+ MetricFilterMatchRecord:
+ type: object
+ properties:
+ eventNumber:
+ allOf:
+ - $ref: '#/components/schemas/EventNumber'
+ - description: The event number.
+ eventMessage:
+ allOf:
+ - $ref: '#/components/schemas/EventMessage'
+ - description: The raw event data.
+ extractedValues:
+ allOf:
+ - $ref: '#/components/schemas/ExtractedValues'
+ - description: The values extracted from the event data by the filter.
+ description: Represents a matched event.
+ MetricFilterMatches:
+ type: array
+ items:
+ $ref: '#/components/schemas/MetricFilterMatchRecord'
+ MetricValue:
+ type: string
+ description: 'The value to publish to the CloudWatch metric. For example, if you''re counting the occurrences of a term like Error, the value is 1 for each occurrence. If you''re counting the bytes transferred, the value is the value in the log event.'
+ maxLength: 100
+ StandardUnit:
+ type: string
+ enum:
+ - Seconds
+ - Microseconds
+ - Milliseconds
+ - Bytes
+ - Kilobytes
+ - Megabytes
+ - Gigabytes
+ - Terabytes
+ - Bits
+ - Kilobits
+ - Megabits
+ - Gigabits
+ - Terabits
+ - Percent
+ - Count
+ - Bytes/Second
+ - Kilobytes/Second
+ - Megabytes/Second
+ - Gigabytes/Second
+ - Terabytes/Second
+ - Bits/Second
+ - Kilobits/Second
+ - Megabits/Second
+ - Gigabits/Second
+ - Terabits/Second
+ - Count/Second
+ - None
+ MetricTransformation:
+ type: object
+ required:
+ - metricName
+ - metricNamespace
+ - metricValue
+ properties:
+ metricName:
+ allOf:
+ - $ref: '#/components/schemas/MetricName'
+ - description: The name of the CloudWatch metric.
+ metricNamespace:
+ allOf:
+ - $ref: '#/components/schemas/MetricNamespace'
+ - description: 'A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.'
+ metricValue:
+ allOf:
+ - $ref: '#/components/schemas/MetricValue'
+ - description: The value to publish to the CloudWatch metric when a filter pattern matches a log event.
+ defaultValue:
+ allOf:
+ - $ref: '#/components/schemas/DefaultValue'
+ - description: (Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
+ dimensions:
+ allOf:
+ - $ref: '#/components/schemas/Dimensions'
+ - description: 'The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
None.'
+ description: Indicates how to transform ingested log events to metric data in a CloudWatch metric.
+ OutputLogEvent:
+ type: object
+ properties:
+ timestamp:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.'
+ message:
+ allOf:
+ - $ref: '#/components/schemas/EventMessage'
+ - description: The data contained in the log event.
+ ingestionTime:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.'
+ description: Represents a log event.
+ PolicyDocument:
+ type: string
+ minLength: 1
+ maxLength: 5120
+ RejectedLogEventsInfo:
+ type: object
+ properties:
+ tooNewLogEventStartIndex:
+ allOf:
+ - $ref: '#/components/schemas/LogEventIndex'
+ - description: The log events that are too new.
+ tooOldLogEventEndIndex:
+ allOf:
+ - $ref: '#/components/schemas/LogEventIndex'
+ - description: The log events that are dated too far in the past.
+ expiredLogEventEndIndex:
+ allOf:
+ - $ref: '#/components/schemas/LogEventIndex'
+ - description: The expired log events.
+ description: Represents the rejected events.
+ QueryDefinitionString:
+ type: string
+ minLength: 1
+ maxLength: 10000
+ ResourcePolicy:
+ type: object
+ properties:
+ policyName:
+ allOf:
+ - $ref: '#/components/schemas/PolicyName'
+ - description: The name of the resource policy.
+ policyDocument:
+ allOf:
+ - $ref: '#/components/schemas/PolicyDocument'
+ - description: The details of the policy.
+ lastUpdatedTime:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: 'Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.'
+ description: A policy enabling one or more entities to put logs to a log group in this account.
+ QueryDefinition:
+ type: object
+ properties:
+ queryDefinitionId:
+ allOf:
+ - $ref: '#/components/schemas/QueryId'
+ - description: The unique ID of the query definition.
+ name:
+ allOf:
+ - $ref: '#/components/schemas/QueryDefinitionName'
+ - description: The name of the query definition.
+ queryString:
+ allOf:
+ - $ref: '#/components/schemas/QueryDefinitionString'
+ - description: 'The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.'
+ lastModified:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: The date that the query definition was most recently modified.
+ logGroupNames:
+ allOf:
+ - $ref: '#/components/schemas/LogGroupNames'
+ - description: 'If this query definition contains a list of log groups that it is limited to, that list appears here.'
+ description: This structure contains details about a saved CloudWatch Logs Insights query definition.
+ QueryString:
+ type: string
+ minLength: 0
+ maxLength: 10000
+ QueryInfo:
+ type: object
+ properties:
+ queryId:
+ allOf:
+ - $ref: '#/components/schemas/QueryId'
+ - description: The unique ID number of this query.
+ queryString:
+ allOf:
+ - $ref: '#/components/schemas/QueryString'
+ - description: The query string used in this query.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/QueryStatus'
+ - description: 'The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.'
+ createTime:
+ allOf:
+ - $ref: '#/components/schemas/Timestamp'
+ - description: The date and time that this query was created.
+ logGroupName:
+ allOf:
+ - $ref: '#/components/schemas/LogGroupName'
+ - description: The name of the log group scanned by this query.
+ description: 'Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation. '
+ ResultRows:
+ type: array
+ items:
+ $ref: '#/components/schemas/ResultField'
+ StatsValue:
+ type: number
+ format: double
+ ResultField:
+ type: object
+ properties:
+ field:
+ allOf:
+ - $ref: '#/components/schemas/Field'
+ - description: The log event field.
+ value:
+ allOf:
+ - $ref: '#/components/schemas/Value'
+ - description: The value of this field.
+ description: 'Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.
For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.
' + SearchedLogStream: + type: object + properties: + logStreamName: + allOf: + - $ref: '#/components/schemas/LogStreamName' + - description: The name of the log stream. + searchedCompletely: + allOf: + - $ref: '#/components/schemas/LogStreamSearchedCompletely' + - description: Indicates whether all the events in this log stream were searched. + description: Represents the search status of a log stream. + SubscriptionFilter: + type: object + properties: + filterName: + allOf: + - $ref: '#/components/schemas/FilterName' + - description: The name of the subscription filter. + logGroupName: + allOf: + - $ref: '#/components/schemas/LogGroupName' + - description: The name of the log group. + filterPattern: + $ref: '#/components/schemas/FilterPattern' + destinationArn: + allOf: + - $ref: '#/components/schemas/DestinationArn' + - description: The Amazon Resource Name (ARN) of the destination. + roleArn: + allOf: + - $ref: '#/components/schemas/RoleArn' + - description: + distribution: + $ref: '#/components/schemas/Distribution' + creationTime: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: 'The creation time of the subscription filter, expressed as the number of milliseconds afterJan 1, 1970 00:00:00 UTC.'
+ description: Represents a subscription filter.
+ TagKey:
+ type: string
+ pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$'
+ minLength: 1
+ maxLength: 128
+ TagKeyList:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagKey'
+ minItems: 0
+ maxItems: 50
+ TagList:
+ type: array
+ items:
+ $ref: '#/components/schemas/TagKey'
+ minItems: 1
+ TagValue:
+ type: string
+ pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$'
+ maxLength: 256
+ TestEventMessages:
+ type: array
+ items:
+ $ref: '#/components/schemas/EventMessage'
+ minItems: 1
+ maxItems: 50
+ Token:
+ type: string
+ x-stackQL-resources:
+ log_events:
+ id: aws.cloudwatch_api.log_events
+ methods:
+ GetLogEvents:
+ operation:
+ $ref: '#/paths/~1/post'
+ request:
+ mediaType: application/json
+ response:
+ mediaType: application/json
+ # objectKey: /*/OutputLogEvents
+ objectKey: $.events
+ openAPIDocKey: '200'
+ name: log_events
+ sqlVerbs:
+ delete: []
+ insert: []
+ select:
+ - $ref: '#/components/x-stackQL-resources/log_events/methods/GetLogEvents'
+ update: []
+ title: log_events
+security:
+ - hmac: []
+x-stackQL-config:
+ # queryParamTranspose:
+ # algorithm: AWSCanonical
+ # requestTranslate:
+ # algorithm: get_query_to_post_form_utf_8
\ No newline at end of file
diff --git a/providers/src/aws/v00.00.00000/services/ec2.yaml b/providers/src/aws/v00.00.00000/services/ec2.yaml
index 0bf6354e..e59928ae 100644
--- a/providers/src/aws/v00.00.00000/services/ec2.yaml
+++ b/providers/src/aws/v00.00.00000/services/ec2.yaml
@@ -1,80193 +1,14780 @@
openapi: 3.0.0
info:
- version: '2016-11-15'
- x-release: v4
- title: Amazon Elastic Compute Cloud api
- description: 'Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the Amazon Web Services Cloud. Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the Amazon Web Services Cloud where you can launch Amazon Web Services resources in a virtual network that you''ve defined. Amazon Elastic Block Store (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available and reliable storage volumes that can be attached to any running instance and used like a hard drive.
To learn more, see the following resources:
Amazon EC2: AmazonEC2 product page, Amazon EC2 documentation
Amazon EBS: Amazon EBS product page, Amazon EBS documentation
Amazon VPC: Amazon VPC product page, Amazon VPC documentation
Amazon Web Services VPN: Amazon Web Services VPN product page, Amazon Web Services VPN documentation
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ReservedInstanceId
- in: query
- required: true
- description: The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservationId'
- - xml:
- name: ReservedInstanceId
- - name: TargetConfiguration
- in: query
- required: false
- description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TargetConfigurationRequest'
- - xml:
- name: TargetConfigurationRequest
- 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'
- post:
- x-aws-operation-name: AcceptReservedInstancesExchangeQuote
- operationId: POST_AcceptReservedInstancesExchangeQuote
- description: Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AcceptReservedInstancesExchangeQuoteResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AcceptReservedInstancesExchangeQuoteRequest'
- parameters: []
- /?Action=AcceptTransitGatewayMulticastDomainAssociations&Version=2016-11-15:
- get:
- x-aws-operation-name: AcceptTransitGatewayMulticastDomainAssociations
- operationId: GET_AcceptTransitGatewayMulticastDomainAssociations
- description: Accepts a request to associate subnets with a transit gateway multicast domain.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AcceptTransitGatewayMulticastDomainAssociationsResult'
- parameters:
- - name: TransitGatewayMulticastDomainId
- in: query
- required: false
- description: The ID of the transit gateway multicast domain.
- schema:
- type: string
- - name: TransitGatewayAttachmentId
- in: query
- required: false
- description: The ID of the transit gateway attachment.
- schema:
- type: string
- - name: SubnetIds
- in: query
- required: false
- description: The IDs of the subnets to associate with the transit gateway multicast domain.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AcceptTransitGatewayMulticastDomainAssociations
- operationId: POST_AcceptTransitGatewayMulticastDomainAssociations
- description: Accepts a request to associate subnets with a transit gateway multicast domain.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AcceptTransitGatewayMulticastDomainAssociationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AcceptTransitGatewayMulticastDomainAssociationsRequest'
- parameters: []
- /?Action=AcceptTransitGatewayPeeringAttachment&Version=2016-11-15:
- get:
- x-aws-operation-name: AcceptTransitGatewayPeeringAttachment
- operationId: GET_AcceptTransitGatewayPeeringAttachment
- description: Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentResult'
- parameters:
- - name: TransitGatewayAttachmentId
- in: query
- required: true
- description: The ID of the transit gateway attachment.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AcceptTransitGatewayPeeringAttachment
- operationId: POST_AcceptTransitGatewayPeeringAttachment
- description: Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentRequest'
- parameters: []
- /?Action=AcceptTransitGatewayVpcAttachment&Version=2016-11-15:
- get:
- x-aws-operation-name: AcceptTransitGatewayVpcAttachment
- operationId: GET_AcceptTransitGatewayVpcAttachment
- description: Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AcceptTransitGatewayVpcAttachment
- operationId: POST_AcceptTransitGatewayVpcAttachment
- description: Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ServiceId
- in: query
- required: true
- description: The ID of the VPC endpoint service.
- schema:
- type: string
- - name: VpcEndpointId
- in: query
- required: true
- description: The IDs of one or more interface VPC endpoints.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointId'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: AcceptVpcEndpointConnections
- operationId: POST_AcceptVpcEndpointConnections
- description: Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AcceptVpcEndpointConnectionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AcceptVpcEndpointConnectionsRequest'
- parameters: []
- /?Action=AcceptVpcPeeringConnection&Version=2016-11-15:
- get:
- x-aws-operation-name: AcceptVpcPeeringConnection
- operationId: GET_AcceptVpcPeeringConnection
- description: 'Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptVpcPeeringConnectionResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcPeeringConnectionId
- in: query
- required: false
- description: The ID of the VPC peering connection. You must specify this parameter in the request.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: AcceptVpcPeeringConnection
- operationId: POST_AcceptVpcPeeringConnection
- description: 'Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptVpcPeeringConnectionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptVpcPeeringConnectionRequest' - parameters: [] - /?Action=AdvertiseByoipCidr&Version=2016-11-15: - get: - x-aws-operation-name: AdvertiseByoipCidr - operationId: GET_AdvertiseByoipCidr - description: 'Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.
It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AdvertiseByoipCidrResult' - parameters: - - name: Cidr - in: query - required: true - description: 'The address range, in CIDR notation. This must be the exact range that you provisioned. You can''t advertise only a portion of the provisioned range.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AdvertiseByoipCidr
- operationId: POST_AdvertiseByoipCidr
- description: 'Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.
It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AdvertiseByoipCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AdvertiseByoipCidrRequest' - parameters: [] - /?Action=AllocateAddress&Version=2016-11-15: - get: - x-aws-operation-name: AllocateAddress - operationId: GET_AllocateAddress - description: 'Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.
You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateAddressResult' - parameters: - - name: Domain - in: query - required: false - description: 'Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.
Address parameter instead.'
- schema:
+ - intel
+ - amd
+ - amazon-web-services
+ MemoryGiBPerVCpu:
+ $ref: '#/components/schemas/MemoryGiBPerVCpuRequest'
+ AllowedInstanceTypes:
+ type: array
+ uniqueItems: false
+ items:
type: string
- - name: NetworkBorderGroup
- in: query
- required: false
- description: 'A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use DescribeAvailabilityZones to view the network border groups.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: TagSpecification
- in: query
- required: false
- description: The tags to assign to the Elastic IP address.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: AllocateAddress
- operationId: POST_AllocateAddress
- description: 'Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.
You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateAddressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateAddressRequest' - parameters: [] - /?Action=AllocateHosts&Version=2016-11-15: - get: - x-aws-operation-name: AllocateHosts - operationId: GET_AllocateHosts - description: 'Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateHostsResult' - parameters: - - name: AutoPlacement - in: query - required: false - description: 'Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.
Default: on
Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
' - schema: - type: string - - name: InstanceFamily - in: query - required: false - description: 'Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
' - schema: - type: string - - name: Quantity - in: query - required: true - description: The number of Dedicated Hosts to allocate to your account with these parameters. - schema: - type: integer - - name: TagSpecification - in: query - required: false - description: The tags to apply to the Dedicated Host during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: HostRecovery - in: query - required: false - description: 'Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.
Default: off
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamPoolId
- in: query
- required: true
- description: The ID of the IPAM pool from which you would like to allocate a CIDR.
- schema:
- type: string
- - name: Cidr
- in: query
- required: false
- description: 'The CIDR you would like to allocate from the IPAM pool. Note the following:
If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible values: Any available IPv4 or IPv6 CIDR.
' - schema: - type: string - - name: NetmaskLength - in: query - required: false - description: 'The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:
If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
' - schema: - type: integer - - name: ClientToken - in: query - required: false - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: Description - in: query - required: false - description: A description for the allocation. - schema: + - hdd + - ssd + TotalLocalStorageGB: + $ref: '#/components/schemas/TotalLocalStorageGBRequest' + BaselineEbsBandwidthMbps: + $ref: '#/components/schemas/BaselineEbsBandwidthMbpsRequest' + AcceleratorTypes: + type: array + uniqueItems: false + items: type: string - - name: PreviewNextCidr - in: query - required: false - description: A preview of the next available CIDR in a pool. - schema: - type: boolean - - name: DisallowedCidr - in: query - required: false - description: Exclude a particular CIDR range from being returned by the pool. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - 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' - post: - x-aws-operation-name: AllocateIpamPoolCidr - operationId: POST_AllocateIpamPoolCidr - description: 'Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateIpamPoolCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateIpamPoolCidrRequest' - parameters: [] - /?Action=ApplySecurityGroupsToClientVpnTargetNetwork&Version=2016-11-15: - get: - x-aws-operation-name: ApplySecurityGroupsToClientVpnTargetNetwork - operationId: GET_ApplySecurityGroupsToClientVpnTargetNetwork - description: Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC in which the associated target network is located. - schema: + enum: + - gpu + - fpga + - inference + AcceleratorCount: + $ref: '#/components/schemas/AcceleratorCountRequest' + AcceleratorManufacturers: + type: array + uniqueItems: false + items: type: string - - name: SecurityGroupId - in: query - required: true - description: The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ApplySecurityGroupsToClientVpnTargetNetwork
- operationId: POST_ApplySecurityGroupsToClientVpnTargetNetwork
- description: Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkRequest'
- parameters: []
- /?Action=AssignIpv6Addresses&Version=2016-11-15:
- get:
- x-aws-operation-name: AssignIpv6Addresses
- operationId: GET_AssignIpv6Addresses
- description: 'Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet''s IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssignIpv6AddressesResult' - parameters: - - name: Ipv6AddressCount - in: query - required: false - description: The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. - schema: - type: integer - - name: Ipv6Addresses - in: query - required: false - description: One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: Ipv6PrefixCount - in: query - required: false - description: The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use theIpv6Prefixes option.
- schema:
- type: integer
- - name: Ipv6Prefix
- in: query
- required: false
- description: One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: NetworkInterfaceId
- in: query
- required: true
- description: The ID of the network interface.
- schema:
+ enum:
+ - amazon-web-services
+ - amd
+ - habana
+ - nvidia
+ - xilinx
+ AcceleratorNames:
+ type: array
+ uniqueItems: false
+ items:
type: string
- 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'
- post:
- x-aws-operation-name: AssignIpv6Addresses
- operationId: POST_AssignIpv6Addresses
- description: 'Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet''s IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssignIpv6AddressesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssignIpv6AddressesRequest' - parameters: [] - /?Action=AssignPrivateIpAddresses&Version=2016-11-15: - get: - x-aws-operation-name: AssignPrivateIpAddresses - operationId: GET_AssignPrivateIpAddresses - description: 'Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet''s CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssignPrivateIpAddressesResult' - parameters: - - name: AllowReassignment - in: query - required: false - description: Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface. - schema: - type: boolean - - name: NetworkInterfaceId - in: query - required: true + enum: + - a10g + - a100 + - h100 + - inferentia + - k520 + - k80 + - m60 + - radeon-pro-v520 + - t4 + - t4g + - vu9p + - v100 + AcceleratorTotalMemoryMiB: + $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest' + VCpuCountRangeRequest: + type: object + additionalProperties: false + properties: + Min: + type: integer + Max: + type: integer + MemoryMiBRequest: + type: object + additionalProperties: false + properties: + Min: + type: integer + Max: + type: integer + MemoryGiBPerVCpuRequest: + type: object + additionalProperties: false + properties: + Min: + type: number + Max: + type: number + NetworkBandwidthGbpsRequest: + type: object + additionalProperties: false + properties: + Min: + type: number + Max: + type: number + NetworkInterfaceCountRequest: + type: object + additionalProperties: false + properties: + Min: + type: integer + Max: + type: integer + TotalLocalStorageGBRequest: + type: object + additionalProperties: false + properties: + Min: + type: number + Max: + type: number + BaselineEbsBandwidthMbpsRequest: + type: object + additionalProperties: false + properties: + Min: + type: integer + Max: + type: integer + AcceleratorCountRequest: + type: object + additionalProperties: false + properties: + Min: + type: integer + Max: + type: integer + AcceleratorTotalMemoryMiBRequest: + type: object + additionalProperties: false + properties: + Min: + type: integer + Max: + type: integer + MaintenanceStrategies: + type: object + additionalProperties: false + properties: + CapacityRebalance: + $ref: '#/components/schemas/CapacityRebalance' + CapacityRebalance: + type: object + additionalProperties: false + properties: + ReplacementStrategy: + type: string + enum: + - launch + - launch-before-terminate + TerminationDelay: + type: integer + EC2Fleet: + type: object + properties: + TargetCapacitySpecification: + $ref: '#/components/schemas/TargetCapacitySpecificationRequest' + OnDemandOptions: + $ref: '#/components/schemas/OnDemandOptionsRequest' + Type: + type: string + enum: + - maintain + - request + - instant + ExcessCapacityTerminationPolicy: + type: string + enum: + - termination + - no-termination + TagSpecifications: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/TagSpecification' + SpotOptions: + $ref: '#/components/schemas/SpotOptionsRequest' + ValidFrom: + type: string + ReplaceUnhealthyInstances: + type: boolean + LaunchTemplateConfigs: + type: array + uniqueItems: false + maxItems: 50 + items: + $ref: '#/components/schemas/FleetLaunchTemplateConfigRequest' + FleetId: + type: string + TerminateInstancesWithExpiration: + type: boolean + ValidUntil: + type: string + Context: + type: string + required: + - TargetCapacitySpecification + - LaunchTemplateConfigs + x-stackql-resource-name: ec2fleet + description: Resource Type definition for AWS::EC2::EC2Fleet + x-type-name: AWS::EC2::EC2Fleet + x-stackql-primary-identifier: + - FleetId + x-create-only-properties: + - LaunchTemplateConfigs + - OnDemandOptions + - ReplaceUnhealthyInstances + - SpotOptions + - TagSpecifications + - TerminateInstancesWithExpiration + - Type + - ValidFrom + - ValidUntil + x-read-only-properties: + - FleetId + x-required-properties: + - TargetCapacitySpecification + - LaunchTemplateConfigs + x-required-permissions: + create: + - ec2:CreateFleet + - ec2:DescribeFleets + delete: + - ec2:DescribeFleets + - ec2:DeleteFleets + list: + - ec2:DescribeFleets + read: + - ec2:DescribeFleets + update: + - ec2:ModifyFleet + - ec2:DescribeFleets + EgressOnlyInternetGateway: + type: object + properties: + Id: + description: Service Generated ID of the EgressOnlyInternetGateway + type: string + VpcId: + description: The ID of the VPC for which to create the egress-only internet gateway. + type: string + required: + - VpcId + x-stackql-resource-name: egress_only_internet_gateway + description: Resource Type definition for AWS::EC2::EgressOnlyInternetGateway + x-type-name: AWS::EC2::EgressOnlyInternetGateway + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - VpcId + x-read-only-properties: + - Id + x-required-properties: + - VpcId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:CreateEgressOnlyInternetGateway + - ec2:DescribeEgressOnlyInternetGateways + read: + - ec2:DescribeEgressOnlyInternetGateways + delete: + - ec2:DeleteEgressOnlyInternetGateway + - ec2:DescribeEgressOnlyInternetGateways + - ec2:DescribeVpcs + list: + - ec2:DescribeEgressOnlyInternetGateways + EIP: + type: object + properties: + PublicIp: + description: '' + type: string + AllocationId: + description: '' + type: string + Domain: + description: |- + The network (``vpc``). + If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource. + type: string + NetworkBorderGroup: + description: |- + A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups. + Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups. + type: string + TransferAddress: + description: The Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*. + type: string + InstanceId: + description: |- + The ID of the instance. + Updates to the ``InstanceId`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. + type: string + PublicIpv4Pool: + description: |- + The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. + Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. + type: string + Tags: + description: |- + Any tags assigned to the Elastic IP address. + Updates to the ``Tags`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackql-resource-name: eip + description: |- + Specifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance. + You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*. + For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*. + x-type-name: AWS::EC2::EIP + x-stackql-primary-identifier: + - PublicIp + - AllocationId + x-create-only-properties: + - Domain + - NetworkBorderGroup + - TransferAddress + x-write-only-properties: + - TransferAddress + x-read-only-properties: + - PublicIp + - AllocationId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + x-required-permissions: + create: + - ec2:AllocateAddress + - ec2:AcceptAddressTransfer + - ec2:DescribeAddresses + - ec2:AssociateAddress + - ec2:CreateTags + read: + - ec2:DescribeAddresses + delete: + - ec2:ReleaseAddress + - ec2:DescribeAddresses + - ec2:DisassociateAddress + update: + - ec2:DescribeAddresses + - ec2:DisassociateAddress + - ec2:DeleteTags + - ec2:CreateTags + - ec2:AssociateAddress + list: + - ec2:DescribeAddresses + EIPAssociation: + type: object + properties: + Id: + description: Composite ID of non-empty properties, to determine the identification. + type: string + AllocationId: + description: The allocation ID. This is required for EC2-VPC. + type: string + NetworkInterfaceId: description: The ID of the network interface. - schema: - type: string - - name: PrivateIpAddress - in: query - required: false - description: 'One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can''t specify this parameter when also specifying a number of secondary IP addresses.
If you don''t specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: PrivateIpAddress - - name: SecondaryPrivateIpAddressCount - in: query - required: false - description: The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. - schema: - type: integer - - name: Ipv4Prefix - in: query - required: false - description: One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use theIpv4PrefixCount option.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: Ipv4PrefixCount
- in: query
- required: false
- description: The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
- schema:
- type: integer
- 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'
- post:
- x-aws-operation-name: AssignPrivateIpAddresses
- operationId: POST_AssignPrivateIpAddresses
- description: 'Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet''s CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssignPrivateIpAddressesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssignPrivateIpAddressesRequest' - parameters: [] - /?Action=AssociateAddress&Version=2016-11-15: - get: - x-aws-operation-name: AssociateAddress - operationId: GET_AssociateAddress - description: 'Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[VPC in an EC2-Classic account] If you don''t specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NetworkInterfaceId
- in: query
- required: false
- description: '[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
' - schema: - type: string - - name: PrivateIpAddress - in: query - required: false - description: '[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.' - schema: - type: string - 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' - post: - x-aws-operation-name: AssociateAddress - operationId: POST_AssociateAddress - description: 'Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[VPC in an EC2-Classic account] If you don''t specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that''s in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that''s associated with it.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateClientVpnTargetNetworkResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: SubnetId - in: query - required: true - description: The ID of the subnet to associate with the Client VPN endpoint. - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AssociateClientVpnTargetNetwork
- operationId: POST_AssociateClientVpnTargetNetwork
- description: 'Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that''s in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that''s associated with it.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateClientVpnTargetNetworkResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateClientVpnTargetNetworkRequest' - parameters: [] - /?Action=AssociateDhcpOptions&Version=2016-11-15: - get: - x-aws-operation-name: AssociateDhcpOptions - operationId: GET_AssociateDhcpOptions - description: 'Associates a set of DHCP options (that you''ve previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don''t need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - parameters: - - name: DhcpOptionsId - in: query - required: true - description: 'The ID of the DHCP options set, ordefault to associate no DHCP options with the VPC.'
- schema:
- type: string
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AssociateDhcpOptions
- operationId: POST_AssociateDhcpOptions
- description: 'Associates a set of DHCP options (that you''ve previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don''t need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateDhcpOptionsRequest' - parameters: [] - /?Action=AssociateEnclaveCertificateIamRole&Version=2016-11-15: - get: - x-aws-operation-name: AssociateEnclaveCertificateIamRole - operationId: GET_AssociateEnclaveCertificateIamRole - description: 'Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.
When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AssociateEnclaveCertificateIamRole
- operationId: POST_AssociateEnclaveCertificateIamRole
- description: 'Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.
When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide.
Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateInstanceEventWindowResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceEventWindowId
- in: query
- required: true
- description: The ID of the event window.
- schema:
- type: string
- - name: AssociationTarget
- in: query
- required: true
- description: One or more targets associated with the specified event window.
- schema:
- type: object
- properties:
- InstanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceIdList'
- - description: 'The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can''t specify the Instance ID parameter; you must use the Dedicated Host ID parameter.'
- InstanceTag:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window.
- DedicatedHostId:
- allOf:
- - $ref: '#/components/schemas/DedicatedHostIdList'
- - description: The IDs of the Dedicated Hosts to associate with the event window.
- description: 'One or more targets associated with the specified event window. Only one type of target (instance ID, instance tag, or Dedicated Host ID) can be associated with an event window.'
- 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'
- post:
- x-aws-operation-name: AssociateInstanceEventWindow
- operationId: POST_AssociateInstanceEventWindow
- description: 'Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateInstanceEventWindowResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateInstanceEventWindowRequest' - parameters: [] - /?Action=AssociateRouteTable&Version=2016-11-15: - get: - x-aws-operation-name: AssociateRouteTable - operationId: GET_AssociateRouteTable - description: 'Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateRouteTableResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: RouteTableId
- in: query
- required: true
- description: The ID of the route table.
- schema:
- type: string
- - name: SubnetId
- in: query
- required: false
- description: The ID of the subnet.
- schema:
- type: string
- - name: GatewayId
- in: query
- required: false
- description: The ID of the internet gateway or virtual private gateway.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: AssociateRouteTable
- operationId: POST_AssociateRouteTable
- description: 'Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateRouteTableResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateRouteTableRequest' - parameters: [] - /?Action=AssociateSubnetCidrBlock&Version=2016-11-15: - get: - x-aws-operation-name: AssociateSubnetCidrBlock - operationId: GET_AssociateSubnetCidrBlock - description: Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateSubnetCidrBlockResult' - parameters: - - name: Ipv6CidrBlock - in: query - required: true - description: The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length. - schema: - type: string - - name: SubnetId - in: query - required: true - description: The ID of your subnet. - schema: - type: string - 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' - post: - x-aws-operation-name: AssociateSubnetCidrBlock - operationId: POST_AssociateSubnetCidrBlock - description: Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateSubnetCidrBlockResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateSubnetCidrBlockRequest' - parameters: [] - /?Action=AssociateTransitGatewayMulticastDomain&Version=2016-11-15: - get: - x-aws-operation-name: AssociateTransitGatewayMulticastDomain - operationId: GET_AssociateTransitGatewayMulticastDomain - description: 'Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the transit gateway attachment to associate with the transit gateway multicast domain. - schema: - type: string - - name: SubnetIds - in: query - required: false - description: The IDs of the subnets to associate with the transit gateway multicast domain. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AssociateTransitGatewayMulticastDomain
- operationId: POST_AssociateTransitGatewayMulticastDomain
- description: 'Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainRequest' - parameters: [] - /?Action=AssociateTransitGatewayRouteTable&Version=2016-11-15: - get: - x-aws-operation-name: AssociateTransitGatewayRouteTable - operationId: GET_AssociateTransitGatewayRouteTable - description: Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTransitGatewayRouteTableResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AssociateTransitGatewayRouteTable
- operationId: POST_AssociateTransitGatewayRouteTable
- description: Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AssociateTransitGatewayRouteTableResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AssociateTransitGatewayRouteTableRequest'
- parameters: []
- /?Action=AssociateTrunkInterface&Version=2016-11-15:
- get:
- x-aws-operation-name: AssociateTrunkInterface
- operationId: GET_AssociateTrunkInterface
- description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Associates a branch network interface with a trunk network interface.
Before you create the association, run the create-network-interface command and set --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AssociateTrunkInterface
- operationId: POST_AssociateTrunkInterface
- description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Associates a branch network interface with a trunk network interface.
Before you create the association, run the create-network-interface command and set --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.
You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and subnet sizing in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateVpcCidrBlockResult' - parameters: - - name: AmazonProvidedIpv6CidrBlock - in: query - required: false - description: 'Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.' - schema: - type: boolean - - name: CidrBlock - in: query - required: false - description: An IPv4 CIDR block to associate with the VPC. - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: Ipv6CidrBlockNetworkBorderGroup - in: query - required: false - description:The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
You can have one IPv6 CIDR block association per network border group.
- schema: - type: string - - name: Ipv6Pool - in: query - required: false - description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. - schema: - type: string - - name: Ipv6CidrBlock - in: query - required: false - description: 'An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
' - schema: - type: string - - name: Ipv4IpamPoolId - in: query - required: false - description: 'Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.' - schema: - type: string - - name: Ipv4NetmaskLength - in: query - required: false - description: 'The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide. ' - schema: - type: integer - - name: Ipv6IpamPoolId - in: query - required: false - description: 'Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.' - schema: - type: string - - name: Ipv6NetmaskLength - in: query - required: false - description: 'The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide. ' - schema: - type: integer - 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' - post: - x-aws-operation-name: AssociateVpcCidrBlock - operationId: POST_AssociateVpcCidrBlock - description: 'Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.
You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and subnet sizing in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateVpcCidrBlockResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateVpcCidrBlockRequest' - parameters: [] - /?Action=AttachClassicLinkVpc&Version=2016-11-15: - get: - x-aws-operation-name: AttachClassicLinkVpc - operationId: GET_AttachClassicLinkVpc - description: 'Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC''s security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that''s in the running state. An instance is automatically unlinked from a VPC when it''s stopped - you can link it to the VPC again when you restart it.
After you''ve linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachClassicLinkVpcResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: SecurityGroupId
- in: query
- required: true
- description: The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: groupId
- - name: InstanceId
- in: query
- required: true
- description: The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
- schema:
- type: string
- - name: VpcId
- in: query
- required: true
- description: The ID of a ClassicLink-enabled VPC.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: AttachClassicLinkVpc
- operationId: POST_AttachClassicLinkVpc
- description: 'Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC''s security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that''s in the running state. An instance is automatically unlinked from a VPC when it''s stopped - you can link it to the VPC again when you restart it.
After you''ve linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachClassicLinkVpcResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachClassicLinkVpcRequest' - parameters: [] - /?Action=AttachInternetGateway&Version=2016-11-15: - get: - x-aws-operation-name: AttachInternetGateway - operationId: GET_AttachInternetGateway - description: 'Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.' - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InternetGatewayId
- in: query
- required: true
- description: The ID of the internet gateway.
- schema:
- type: string
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: AttachInternetGateway
- operationId: POST_AttachInternetGateway
- description: 'Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.'
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AttachInternetGatewayRequest'
- parameters: []
- /?Action=AttachNetworkInterface&Version=2016-11-15:
- get:
- x-aws-operation-name: AttachNetworkInterface
- operationId: GET_AttachNetworkInterface
- description: Attaches a network interface to an instance.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AttachNetworkInterfaceResult'
- parameters:
- - name: DeviceIndex
- in: query
- required: true
- description: The index of the device for the network interface attachment.
- schema:
- type: integer
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance.
- schema:
- type: string
- - name: NetworkInterfaceId
- in: query
- required: true
- description: The ID of the network interface.
- schema:
- type: string
- - name: NetworkCardIndex
- in: query
- required: false
- description: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
- schema:
- type: integer
- 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'
- post:
- x-aws-operation-name: AttachNetworkInterface
- operationId: POST_AttachNetworkInterface
- description: Attaches a network interface to an instance.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AttachNetworkInterfaceResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AttachNetworkInterfaceRequest'
- parameters: []
- /?Action=AttachVolume&Version=2016-11-15:
- get:
- x-aws-operation-name: AttachVolume
- operationId: GET_AttachVolume
- description: 'Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
After you attach an EBS volume, you must make it available. For more information, see Make an EBS volume available for use.
If a volume has an Amazon Web Services Marketplace product code:
The volume can be attached only to a stopped instance.
Amazon Web Services Marketplace product codes are copied from the volume to the instance.
You must be subscribed to the product.
The instance type and operating system of the instance must support the product. For example, you can''t detach a volume from a Windows instance and attach it to a Linux instance.
For more information, see Attach an Amazon EBS volume to an instance in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/VolumeAttachment' - parameters: - - name: Device - in: query - required: true - description: 'The device name (for example,/dev/sdh or xvdh).'
- schema:
- type: string
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance.
- schema:
- type: string
- - name: VolumeId
- in: query
- required: true
- description: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AttachVolume
- operationId: POST_AttachVolume
- description: 'Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
After you attach an EBS volume, you must make it available. For more information, see Make an EBS volume available for use.
If a volume has an Amazon Web Services Marketplace product code:
The volume can be attached only to a stopped instance.
Amazon Web Services Marketplace product codes are copied from the volume to the instance.
You must be subscribed to the product.
The instance type and operating system of the instance must support the product. For example, you can''t detach a volume from a Windows instance and attach it to a Linux instance.
For more information, see Attach an Amazon EBS volume to an instance in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/VolumeAttachment' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachVolumeRequest' - parameters: [] - /?Action=AttachVpnGateway&Version=2016-11-15: - get: - x-aws-operation-name: AttachVpnGateway - operationId: GET_AttachVpnGateway - description: 'Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachVpnGatewayResult' - parameters: - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: VpnGatewayId - in: query - required: true - description: The ID of the virtual private gateway. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AttachVpnGateway
- operationId: POST_AttachVpnGateway
- description: 'Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachVpnGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachVpnGatewayRequest' - parameters: [] - /?Action=AuthorizeClientVpnIngress&Version=2016-11-15: - get: - x-aws-operation-name: AuthorizeClientVpnIngress - operationId: GET_AuthorizeClientVpnIngress - description: Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeClientVpnIngressResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: TargetNetworkCidr - in: query - required: true - description: 'The IPv4 address range, in CIDR notation, of the network for which access is being authorized.' - schema: - type: string - - name: AccessGroupId - in: query - required: false - description: 'The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required ifAuthorizeAllGroups is false or not specified.'
- schema:
- type: string
- - name: AuthorizeAllGroups
- in: query
- required: false
- description: Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.
- schema:
- type: boolean
- - name: Description
- in: query
- required: false
- description: A brief description of the authorization rule.
- schema:
- type: string
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: AuthorizeClientVpnIngress
- operationId: POST_AuthorizeClientVpnIngress
- description: Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AuthorizeClientVpnIngressResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/AuthorizeClientVpnIngressRequest'
- parameters: []
- /?Action=AuthorizeSecurityGroupEgress&Version=2016-11-15:
- get:
- x-aws-operation-name: AuthorizeSecurityGroupEgress
- operationId: GET_AuthorizeSecurityGroupEgress
- description: '[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified source security groups.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For information about VPC security group quotas, see Amazon VPC quotas.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeSecurityGroupEgressResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: GroupId
- in: query
- required: true
- description: The ID of the security group.
- schema:
- type: string
- - name: IpPermissions
- in: query
- required: false
- description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpPermission'
- - xml:
- name: item
- - name: TagSpecification
- in: query
- required: false
- description: The tags applied to the security group rule.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: CidrIp
- in: query
- required: false
- description: Not supported. Use a set of IP permissions to specify the CIDR.
- schema:
- type: string
- - name: FromPort
- in: query
- required: false
- description: Not supported. Use a set of IP permissions to specify the port.
- schema:
- type: integer
- - name: IpProtocol
- in: query
- required: false
- description: Not supported. Use a set of IP permissions to specify the protocol name or number.
- schema:
- type: string
- - name: ToPort
- in: query
- required: false
- description: Not supported. Use a set of IP permissions to specify the port.
- schema:
- type: integer
- - name: SourceSecurityGroupName
- in: query
- required: false
- description: Not supported. Use a set of IP permissions to specify a destination security group.
- schema:
- type: string
- - name: SourceSecurityGroupOwnerId
- in: query
- required: false
- description: Not supported. Use a set of IP permissions to specify a destination security group.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: AuthorizeSecurityGroupEgress
- operationId: POST_AuthorizeSecurityGroupEgress
- description: '[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified source security groups.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For information about VPC security group quotas, see Amazon VPC quotas.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeSecurityGroupEgressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeSecurityGroupEgressRequest' - parameters: [] - /?Action=AuthorizeSecurityGroupIngress&Version=2016-11-15: - get: - x-aws-operation-name: AuthorizeSecurityGroupIngress - operationId: GET_AuthorizeSecurityGroupIngress - description: 'Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
For more information about VPC security group quotas, see Amazon VPC quotas.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeSecurityGroupIngressResult' - parameters: - - name: CidrIp - in: query - required: false - description: 'The IPv4 address range, in CIDR format. You can''t specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' - schema: - type: string - - name: FromPort - in: query - required: false - description: 'The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' - schema: - type: integer - - name: GroupId - in: query - required: false - description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.' - schema: - type: string - - name: GroupName - in: query - required: false - description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.' - schema: - type: string - - name: IpPermissions - in: query - required: false - description: The sets of IP permissions. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpPermission' - - xml: - name: item - - name: IpProtocol - in: query - required: false - description: 'The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.
[VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' - schema: - type: string - - name: SourceSecurityGroupName - in: query - required: false - description: '[EC2-Classic, default VPC] The name of the source security group. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.' - schema: - type: string - - name: SourceSecurityGroupOwnerId - in: query - required: false - description: '[nondefault VPC] The Amazon Web Services account ID for the source security group, if the source security group is in a different account. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.' - schema: - type: string - - name: ToPort - in: query - required: false - description: 'The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' - schema: - type: integer - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: TagSpecification
- in: query
- required: false
- description: '[VPC Only] The tags applied to the security group rule.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: AuthorizeSecurityGroupIngress
- operationId: POST_AuthorizeSecurityGroupIngress
- description: 'Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
For more information about VPC security group quotas, see Amazon VPC quotas.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeSecurityGroupIngressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeSecurityGroupIngressRequest' - parameters: [] - /?Action=BundleInstance&Version=2016-11-15: - get: - x-aws-operation-name: BundleInstance - operationId: GET_BundleInstance - description: 'Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
The ID of the instance to bundle.
Type: String
Default: None
Required: Yes
' - schema: - type: string - - name: Storage - in: query - required: true - description: 'The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/S3Storage' - - description: An Amazon S3 storage location. - description: Describes the storage location for an instance store-backed AMI. - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: BundleInstance
- operationId: POST_BundleInstance
- description: 'Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CancelBundleTask
- operationId: POST_CancelBundleTask
- description: Cancels a bundling operation for an instance store-backed Windows instance.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CancelBundleTaskResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CancelBundleTaskRequest'
- parameters: []
- /?Action=CancelCapacityReservation&Version=2016-11-15:
- get:
- x-aws-operation-name: CancelCapacityReservation
- operationId: GET_CancelCapacityReservation
- description: 'Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation''s state to cancelled.
Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelCapacityReservationResult' - parameters: - - name: CapacityReservationId - in: query - required: true - description: The ID of the Capacity Reservation to be cancelled. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CancelCapacityReservation
- operationId: POST_CancelCapacityReservation
- description: 'Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation''s state to cancelled.
Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelCapacityReservationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelCapacityReservationRequest' - parameters: [] - /?Action=CancelCapacityReservationFleets&Version=2016-11-15: - get: - x-aws-operation-name: CancelCapacityReservationFleets - operationId: GET_CancelCapacityReservationFleets - description: 'Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:
The Capacity Reservation Fleet''s status changes to cancelled.
The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.
The Fleet stops creating new Capacity Reservations.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: CapacityReservationFleetId
- in: query
- required: true
- description: The IDs of the Capacity Reservation Fleets to cancel.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationFleetId'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: CancelCapacityReservationFleets
- operationId: POST_CancelCapacityReservationFleets
- description: 'Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:
The Capacity Reservation Fleet''s status changes to cancelled.
The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.
The Fleet stops creating new Capacity Reservations.
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
' - responses: - '200': - description: Success - parameters: - - name: ConversionTaskId - in: query - required: true - description: The ID of the conversion task. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ReasonMessage
- in: query
- required: false
- description: The reason for canceling the conversion task.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CancelConversionTask
- operationId: POST_CancelConversionTask
- description: 'Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelConversionRequest' - parameters: [] - /?Action=CancelExportTask&Version=2016-11-15: - get: - x-aws-operation-name: CancelExportTask - operationId: GET_CancelExportTask - description: 'Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.' - responses: - '200': - description: Success - parameters: - - name: ExportTaskId - in: query - required: true - description: The ID of the export task. This is the ID returned byCreateInstanceExportTask.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CancelExportTask
- operationId: POST_CancelExportTask
- description: 'Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.'
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CancelExportTaskRequest'
- parameters: []
- /?Action=CancelImportTask&Version=2016-11-15:
- get:
- x-aws-operation-name: CancelImportTask
- operationId: GET_CancelImportTask
- description: Cancels an in-process import virtual machine or import snapshot task.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CancelImportTaskResult'
- parameters:
- - name: CancelReason
- in: query
- required: false
- description: The reason for canceling the task.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ImportTaskId
- in: query
- required: false
- description: The ID of the import image or import snapshot task to be canceled.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CancelImportTask
- operationId: POST_CancelImportTask
- description: Cancels an in-process import virtual machine or import snapshot task.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CancelImportTaskResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CancelImportTaskRequest'
- parameters: []
- /?Action=CancelReservedInstancesListing&Version=2016-11-15:
- get:
- x-aws-operation-name: CancelReservedInstancesListing
- operationId: GET_CancelReservedInstancesListing
- description: 'Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelReservedInstancesListingResult' - parameters: - - name: ReservedInstancesListingId - in: query - required: true - description: The ID of the Reserved Instance listing. - schema: - type: string - 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' - post: - x-aws-operation-name: CancelReservedInstancesListing - operationId: POST_CancelReservedInstancesListing - description: 'Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelReservedInstancesListingResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelReservedInstancesListingRequest' - parameters: [] - /?Action=CancelSpotFleetRequests&Version=2016-11-15: - get: - x-aws-operation-name: CancelSpotFleetRequests - operationId: GET_CancelSpotFleetRequests - description: 'Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: SpotFleetRequestId
- in: query
- required: true
- description: The IDs of the Spot Fleet requests.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SpotFleetRequestId'
- - xml:
- name: item
- - name: TerminateInstances
- in: query
- required: true
- description: Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CancelSpotFleetRequests
- operationId: POST_CancelSpotFleetRequests
- description: 'Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: SpotInstanceRequestId
- in: query
- required: true
- description: One or more Spot Instance request IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SpotInstanceRequestId'
- - xml:
- name: SpotInstanceRequestId
- 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'
- post:
- x-aws-operation-name: CancelSpotInstanceRequests
- operationId: POST_CancelSpotInstanceRequests
- description: Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ConfirmProductInstance
- operationId: POST_ConfirmProductInstance
- description: Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ConfirmProductInstanceResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ConfirmProductInstanceRequest'
- parameters: []
- /?Action=CopyFpgaImage&Version=2016-11-15:
- get:
- x-aws-operation-name: CopyFpgaImage
- operationId: GET_CopyFpgaImage
- description: Copies the specified Amazon FPGA Image (AFI) to the current Region.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CopyFpgaImageResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: SourceFpgaImageId
- in: query
- required: true
- description: The ID of the source AFI.
- schema:
- type: string
- - name: Description
- in: query
- required: false
- description: The description for the new AFI.
- schema:
- type: string
- - name: Name
- in: query
- required: false
- description: The name for the new AFI. The default is the name of the source AFI.
- schema:
- type: string
- - name: SourceRegion
- in: query
- required: true
- description: The Region that contains the source AFI.
- schema:
- type: string
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.'
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CopyFpgaImage
- operationId: POST_CopyFpgaImage
- description: Copies the specified Amazon FPGA Image (AFI) to the current Region.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CopyFpgaImageResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CopyFpgaImageRequest'
- parameters: []
- /?Action=CopyImage&Version=2016-11-15:
- get:
- x-aws-operation-name: CopyImage
- operationId: GET_CopyImage
- description: 'Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can''t copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CopyImageResult' - parameters: - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.' - schema: - type: string - - name: Description - in: query - required: false - description: A description for the new AMI in the destination Region. - schema: - type: string - - name: Encrypted - in: query - required: false - description: 'Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key usingKmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.'
- schema:
- type: boolean
- - name: KmsKeyId
- in: query
- required: false
- description: 'The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to true.
You can specify a KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.
The specified KMS key must exist in the destination Region.
Amazon EBS does not support asymmetric KMS keys.
' - schema: - type: string - - name: Name - in: query - required: true - description: The name of the new AMI in the destination Region. - schema: - type: string - - name: SourceImageId - in: query - required: true - description: The ID of the AMI to copy. - schema: - type: string - - name: SourceRegion - in: query - required: true - description: The name of the Region that contains the AMI to copy. - schema: - type: string - - name: DestinationOutpostArn - in: query - required: false - description: 'The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copying AMIs from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CopyImage
- operationId: POST_CopyImage
- description: 'Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can''t copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CopyImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CopyImageRequest' - parameters: [] - /?Action=CopySnapshot&Version=2016-11-15: - get: - x-aws-operation-name: CopySnapshot - operationId: GET_CopySnapshot - description: 'Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can''t copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copy an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CopySnapshotResult' - parameters: - - name: Description - in: query - required: false - description: A description for the EBS snapshot. - schema: - type: string - - name: DestinationOutpostArn - in: query - required: false - description: 'The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
' - schema: - type: string - - name: DestinationRegion - in: query - required: false - description: 'The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is specified using the --region parameter or the default Region in your Amazon Web Services configuration file.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
' - schema: - type: string - - name: PresignedUrl - in: query - required: false - description: 'When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.
The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using Amazon Web Services Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CopySnapshot
- operationId: POST_CopySnapshot
- description: 'Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can''t copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copy an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CopySnapshotResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CopySnapshotRequest' - parameters: [] - /?Action=CreateCapacityReservation&Version=2016-11-15: - get: - x-aws-operation-name: CreateCapacityReservation - operationId: GET_CreateCapacityReservation - description: 'Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCapacityReservationResult' - parameters: - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.' - schema: - type: string - - name: InstanceType - in: query - required: true - description: 'The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.' - schema: - type: string - - name: InstancePlatform - in: query - required: true - description: The type of operating system for which to reserve capacity. - schema: - type: string - enum: - - Linux/UNIX - - Red Hat Enterprise Linux - - SUSE Linux - - Windows - - Windows with SQL Server - - Windows with SQL Server Enterprise - - Windows with SQL Server Standard - - Windows with SQL Server Web - - Linux with SQL Server Standard - - Linux with SQL Server Web - - Linux with SQL Server Enterprise - - RHEL with SQL Server Standard - - RHEL with SQL Server Enterprise - - RHEL with SQL Server Web - - RHEL with HA - - RHEL with HA and SQL Server Standard - - RHEL with HA and SQL Server Enterprise - - name: AvailabilityZone - in: query - required: false - description: The Availability Zone in which to create the Capacity Reservation. - schema: - type: string - - name: AvailabilityZoneId - in: query - required: false - description: The ID of the Availability Zone in which to create the Capacity Reservation. - schema: - type: string - - name: Tenancy - in: query - required: false - description: 'Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
The number of instances for which to reserve capacity.
Valid range: 1 - 1000
' - schema: - type: integer - - name: EbsOptimized - in: query - required: false - description: Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance. - schema: - type: boolean - - name: EphemeralStorage - in: query - required: false - description: 'Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.' - schema: - type: boolean - - name: EndDate - in: query - required: false - description: 'The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.
You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.
If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default: open
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: OutpostArn
- in: query
- required: false
- description: The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
- schema:
- type: string
- pattern: '^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$'
- - name: PlacementGroupArn
- in: query
- required: false
- description: 'The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.'
- schema:
- type: string
- pattern: '^arn:aws([a-z-]+)?:ec2:[a-z\d-]+:\d{12}:placement-group/([^\s].+[^\s]){1,255}$'
- 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'
- post:
- x-aws-operation-name: CreateCapacityReservation
- operationId: POST_CreateCapacityReservation
- description: 'Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCapacityReservationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCapacityReservationRequest' - parameters: [] - /?Action=CreateCapacityReservationFleet&Version=2016-11-15: - get: - x-aws-operation-name: CreateCapacityReservationFleet - operationId: GET_CreateCapacityReservationFleet - description: 'Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCapacityReservationFleetResult' - parameters: - - name: AllocationStrategy - in: query - required: false - description: 'The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. Currently, only the prioritized allocation strategy is supported. For more information, see Allocation strategy in the Amazon EC2 User Guide.
Valid values: prioritized
Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:
default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateCapacityReservationFleet
- operationId: POST_CreateCapacityReservationFleet
- description: 'Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateCapacityReservationFleetResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateCapacityReservationFleetRequest'
- parameters: []
- /?Action=CreateCarrierGateway&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateCarrierGateway
- operationId: GET_CreateCarrierGateway
- description: 'Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateCarrierGatewayResult'
- parameters:
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC to associate with the carrier gateway.
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to associate with the carrier gateway.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CreateCarrierGateway
- operationId: POST_CreateCarrierGateway
- description: 'Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateCarrierGatewayResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateCarrierGatewayRequest'
- parameters: []
- /?Action=CreateClientVpnEndpoint&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateClientVpnEndpoint
- operationId: GET_CreateClientVpnEndpoint
- description: Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateClientVpnEndpointResult'
- parameters:
- - name: ClientCidrBlock
- in: query
- required: true
- description: 'The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.'
- schema:
- type: string
- - name: ServerCertificateArn
- in: query
- required: true
- description: 'The ARN of the server certificate. For more information, see the Certificate Manager User Guide.'
- schema:
- type: string
- - name: Authentication
- in: query
- required: true
- description: Information about the authentication method to be used to authenticate clients.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/ClientVpnAuthenticationRequest'
- - name: ConnectionLogOptions
- in: query
- required: true
- description: 'Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
The transport protocol to be used by the VPN session.
Default value: udp
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
Indicates whether split-tunnel is enabled on the Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
' - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply to the Client VPN endpoint during creation.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: SecurityGroupId
- in: query
- required: false
- description: The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: item
- - name: VpcId
- in: query
- required: false
- description: 'The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.'
- schema:
- type: string
- - name: SelfServicePortal
- in: query
- required: false
- description: 'Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
The IPv4 address range, in CIDR notation, of the route destination. For example:
To add a route for Internet access, enter 0.0.0.0/0
To add a route for a peered VPC, enter the peered VPC''s IPv4 CIDR range
To add a route for an on-premises network, enter the Amazon Web Services Site-to-Site VPN connection''s IPv4 CIDR range
To add a route for the local network, enter the client CIDR range
The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.
Alternatively, if you''re adding a route for the local network, specify local.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateClientVpnRoute
- operationId: POST_CreateClientVpnRoute
- description: Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateClientVpnRouteResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateClientVpnRouteRequest'
- parameters: []
- /?Action=CreateCustomerGateway&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateCustomerGateway
- operationId: GET_CreateCustomerGateway
- description: 'Provides information to Amazon Web Services about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the Amazon Web Services side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway''s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device''s BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don''t have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn''t create a new customer gateway.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCustomerGatewayResult' - parameters: - - name: BgpAsn - in: query - required: true - description: 'For devices that support BGP, the customer gateway''s BGP ASN.
Default: 65000
' - schema: - type: integer - - name: IpAddress - in: query - required: false - description: The Internet-routable IP address for the customer gateway's outside interface. The address must be static. - schema: - type: string - - name: CertificateArn - in: query - required: false - description: The Amazon Resource Name (ARN) for the customer gateway certificate. - schema: - type: string - - name: Type - in: query - required: true - description: The type of VPN connection that this customer gateway supports (ipsec.1).
- schema:
- type: string
- enum:
- - ipsec.1
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply to the customer gateway.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: DeviceName
- in: query
- required: false
- description: 'A name for the customer gateway device.
Length Constraints: Up to 255 characters.
' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateCustomerGateway
- operationId: POST_CreateCustomerGateway
- description: 'Provides information to Amazon Web Services about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the Amazon Web Services side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway''s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device''s BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don''t have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn''t create a new customer gateway.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCustomerGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCustomerGatewayRequest' - parameters: [] - /?Action=CreateDefaultSubnet&Version=2016-11-15: - get: - x-aws-operation-name: CreateDefaultSubnet - operationId: GET_CreateDefaultSubnet - description: 'Creates a default subnet with a size/20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a default subnet in the Amazon Virtual Private Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateDefaultSubnetResult'
- parameters:
- - name: AvailabilityZone
- in: query
- required: true
- description: The Availability Zone in which to create the default subnet.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Ipv6Native
- in: query
- required: false
- description: 'Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateDefaultSubnet
- operationId: POST_CreateDefaultSubnet
- description: 'Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a default subnet in the Amazon Virtual Private Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateDefaultSubnetResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateDefaultSubnetRequest'
- parameters: []
- /?Action=CreateDefaultVpc&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateDefaultVpc
- operationId: GET_CreateDefaultVpc
- description: 'Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and default subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateDefaultVpcResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateDefaultVpc
- operationId: POST_CreateDefaultVpc
- description: 'Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and default subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateDefaultVpcResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateDefaultVpcRequest' - parameters: [] - /?Action=CreateDhcpOptions&Version=2016-11-15: - get: - x-aws-operation-name: CreateDhcpOptions - operationId: GET_CreateDhcpOptions - description: 'Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.
domain-name - If you''re using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you''re using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateDhcpOptions
- operationId: POST_CreateDhcpOptions
- description: 'Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.
domain-name - If you''re using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you''re using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC for which to create the egress-only internet gateway.
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to assign to the egress-only internet gateway.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: CreateEgressOnlyInternetGateway
- operationId: POST_CreateEgressOnlyInternetGateway
- description: '[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateEgressOnlyInternetGatewayResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateEgressOnlyInternetGatewayRequest'
- parameters: []
- /?Action=CreateFleet&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateFleet
- operationId: GET_CreateFleet
- description: 'Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see EC2 Fleet in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFleetResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.'
- schema:
- type: string
- - name: SpotOptions
- in: query
- required: false
- description: Describes the configuration of Spot Instances in an EC2 Fleet.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The maximum amount per hour for Spot Instances that you're willing to pay.
- description: Describes the configuration of Spot Instances in an EC2 Fleet request.
- - name: OnDemandOptions
- in: query
- required: false
- description: Describes the configuration of On-Demand Instances in an EC2 Fleet.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The maximum amount per hour for On-Demand Instances that you're willing to pay.
- description: Describes the configuration of On-Demand Instances in an EC2 Fleet.
- - name: ExcessCapacityTerminationPolicy
- in: query
- required: false
- description: Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
- schema:
- type: string
- enum:
- - no-termination
- - termination
- - name: LaunchTemplateConfigs
- in: query
- required: true
- description: The configuration for the EC2 Fleet.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/FleetLaunchTemplateConfigRequest'
- - xml:
- name: item
- minItems: 0
- maxItems: 50
- - name: TargetCapacitySpecification
- in: query
- required: true
- description: The number of units to request.
- schema:
- type: object
- required:
- - TotalTargetCapacity
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TargetCapacityUnitType'
- - description: 'The unit for the target capacity.
Default: units (translates to number of instances)
The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.
The fleet type. The default value is maintain.
maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.
request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.
instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.
For more information, see EC2 Fleet request types in the Amazon EC2 User Guide.
' - schema: - type: string - enum: - - request - - maintain - - instant - - name: ValidFrom - in: query - required: false - description: 'The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.' - schema: - type: string - format: date-time - - name: ValidUntil - in: query - required: false - description: 'The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.' - schema: - type: string - format: date-time - - name: ReplaceUnhealthyInstances - in: query - required: false - description: 'Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of typemaintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.'
- schema:
- type: boolean
- - name: TagSpecification
- in: query
- required: false
- description: 'The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tagging your resources.
If the fleet type is instant, specify a resource type of fleet to tag the fleet or instance to tag the instances at launch.
If the fleet type is maintain or request, specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance. To tag instances at launch, specify the tags in a launch template.
Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see EC2 Fleet in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFleetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFleetRequest' - parameters: [] - /?Action=CreateFlowLogs&Version=2016-11-15: - get: - x-aws-operation-name: CreateFlowLogs - operationId: GET_CreateFlowLogs - description: 'Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon Virtual Private Cloud User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFlowLogsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- - name: DeliverLogsPermissionArn
- in: query
- required: false
- description: 'The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
The ID of the subnet, network interface, or VPC for which you want to create a flow log.
Constraints: Maximum of 1000 resources
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/FlowLogResourceId' - - xml: - name: item - - name: ResourceType - in: query - required: true - description: 'The type of resource for which to create the flow log. For example, if you specified a VPC ID for theResourceId property, specify VPC for this property.'
- schema:
- type: string
- enum:
- - VPC
- - Subnet
- - NetworkInterface
- - name: TrafficType
- in: query
- required: true
- description: 'The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.'
- schema:
- type: string
- enum:
- - ACCEPT
- - REJECT
- - ALL
- - name: LogDestinationType
- in: query
- required: false
- description: 'The type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
Default: cloud-watch-logs
The destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.
If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.
If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.
The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow log records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.
Specify the fields using the ${field-id} format, separated by spaces. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.
The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
Default: 600
' - schema: - type: integer - - name: DestinationOptions - in: query - required: false - description: The destination options. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default isfalse.
- description: Describes the destination options for a flow log.
- 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'
- post:
- x-aws-operation-name: CreateFlowLogs
- operationId: POST_CreateFlowLogs
- description: 'Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon Virtual Private Cloud User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFlowLogsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFlowLogsRequest' - parameters: [] - /?Action=CreateFpgaImage&Version=2016-11-15: - get: - x-aws-operation-name: CreateFpgaImage - operationId: GET_CreateFpgaImage - description: 'Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFpgaImageResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InputStorageLocation
- in: query
- required: true
- description: The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The key.
- description: Describes a storage location in Amazon S3.
- - name: LogsStorageLocation
- in: query
- required: false
- description: The location in Amazon S3 for the output logs.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The key.
- description: Describes a storage location in Amazon S3.
- - name: Description
- in: query
- required: false
- description: A description for the AFI.
- schema:
- type: string
- - name: Name
- in: query
- required: false
- description: A name for the AFI.
- schema:
- type: string
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply to the FPGA image during creation.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: CreateFpgaImage
- operationId: POST_CreateFpgaImage
- description: 'Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFpgaImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFpgaImageRequest' - parameters: [] - /?Action=CreateImage&Version=2016-11-15: - get: - x-aws-operation-name: CreateImage - operationId: GET_CreateImage - description: 'Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can''t guarantee the file system integrity of the created image.
If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateImageResult' - parameters: - - name: BlockDeviceMapping - in: query - required: false - description: 'The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/BlockDeviceMapping' - - xml: - name: BlockDeviceMapping - - name: Description - in: query - required: false - description: A description for the new image. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance.
- schema:
- type: string
- - name: Name
- in: query
- required: true
- description: 'A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)
' - schema: - type: string - - name: NoReboot - in: query - required: false - description: 'By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can''t guarantee the file system integrity of the created image.
Default: false (follow standard reboot process)
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
To tag the AMI, the value for ResourceType must be image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - 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' - post: - x-aws-operation-name: CreateImage - operationId: POST_CreateImage - description: 'Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can''t guarantee the file system integrity of the created image.
If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateImageRequest' - parameters: [] - /?Action=CreateInstanceEventWindow&Version=2016-11-15: - get: - x-aws-operation-name: CreateInstanceEventWindow - operationId: GET_CreateInstanceEventWindow - description: 'Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.
You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.
You can create up to 200 event windows per Amazon Web Services Region.
When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.
Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.
Event windows are not applicable for:
Expedited scheduled events and network maintenance events.
Unscheduled maintenance such as AutoRecovery and unplanned reboots.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceEventWindowResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Name
- in: query
- required: false
- description: The name of the event window.
- schema:
- type: string
- - name: TimeRange
- in: query
- required: false
- description: 'The time range for the event window. If you specify a time range, you can''t specify a cron expression.'
- schema:
- type: array
- items:
- $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest'
- - name: CronExpression
- in: query
- required: false
- description: 'The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can''t specify a time range.
Constraints:
Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the event window. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - 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' - post: - x-aws-operation-name: CreateInstanceEventWindow - operationId: POST_CreateInstanceEventWindow - description: 'Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.
You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.
You can create up to 200 event windows per Amazon Web Services Region.
When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.
Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.
Event windows are not applicable for:
Expedited scheduled events and network maintenance events.
Unscheduled maintenance such as AutoRecovery and unplanned reboots.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceEventWindowResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceEventWindowRequest' - parameters: [] - /?Action=CreateInstanceExportTask&Version=2016-11-15: - get: - x-aws-operation-name: CreateInstanceExportTask - operationId: GET_CreateInstanceExportTask - description: 'Exports a running or stopped instance to an Amazon S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceExportTaskResult' - parameters: - - name: Description - in: query - required: false - description: A description for the conversion task or the resource being exported. The maximum length is 255 characters. - schema: - type: string - - name: ExportToS3 - in: query - required: true - description: The format and location for an export instance task. - schema: - type: object - properties: - containerFormat: - allOf: - - $ref: '#/components/schemas/ContainerFormat' - - description: 'The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.' - diskImageFormat: - allOf: - - $ref: '#/components/schemas/DiskImageFormat' - - description: The format for the exported image. - s3Bucket: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services accountvm-import-export@amazon.com.
- s3Prefix:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
- description: Describes an export instance task.
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance.
- schema:
- type: string
- - name: TargetEnvironment
- in: query
- required: true
- description: The target virtualization environment.
- schema:
- type: string
- enum:
- - citrix
- - vmware
- - microsoft
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply to the export instance task during creation.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: CreateInstanceExportTask
- operationId: POST_CreateInstanceExportTask
- description: 'Exports a running or stopped instance to an Amazon S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceExportTaskResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceExportTaskRequest' - parameters: [] - /?Action=CreateInternetGateway&Version=2016-11-15: - get: - x-aws-operation-name: CreateInternetGateway - operationId: GET_CreateInternetGateway - description: 'Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInternetGatewayResult' - parameters: - - name: TagSpecification - in: query - required: false - description: The tags to assign to the internet gateway. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateInternetGateway
- operationId: POST_CreateInternetGateway
- description: 'Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInternetGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInternetGatewayRequest' - parameters: [] - /?Action=CreateIpam&Version=2016-11-15: - get: - x-aws-operation-name: CreateIpam - operationId: GET_CreateIpam - description: 'Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Description
- in: query
- required: false
- description: A description for the IPAM.
- schema:
- type: string
- - name: OperatingRegion
- in: query
- required: false
- description: 'The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' - schema: - type: array - items: - $ref: '#/components/schemas/AddIpamOperatingRegion' - minItems: 0 - maxItems: 50 - - name: TagSpecification - in: query - required: false - description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: ClientToken
- in: query
- required: false
- description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CreateIpam
- operationId: POST_CreateIpam
- description: 'Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamRequest' - parameters: [] - /?Action=CreateIpamPool&Version=2016-11-15: - get: - x-aws-operation-name: CreateIpamPool - operationId: GET_CreateIpamPool - description: 'Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamPoolResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamScopeId
- in: query
- required: true
- description: The ID of the scope in which you would like to create the IPAM pool.
- schema:
- type: string
- - name: Locale
- in: query
- required: false
- description: 'In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM''s home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
' - schema: - type: string - - name: SourceIpamPoolId - in: query - required: false - description: The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range. - schema: - type: string - - name: Description - in: query - required: false - description: A description for the IPAM pool. - schema: - type: string - - name: AddressFamily - in: query - required: true - description: The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool. - schema: - type: string - enum: - - ipv4 - - ipv6 - - name: AutoImport - in: query - required: false - description: 'If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
' - schema: - type: boolean - - name: PubliclyAdvertisable - in: query - required: false - description: Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set toipv4.
- schema:
- type: boolean
- - name: AllocationMinNetmaskLength
- in: query
- required: false
- description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
- schema:
- type: integer
- minimum: 0
- maximum: 128
- - name: AllocationMaxNetmaskLength
- in: query
- required: false
- description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
- schema:
- type: integer
- minimum: 0
- maximum: 128
- - name: AllocationDefaultNetmaskLength
- in: query
- required: false
- description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.'
- schema:
- type: integer
- minimum: 0
- maximum: 128
- - name: AllocationResourceTag
- in: query
- required: false
- description: 'Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/RequestIpamResourceTag'
- - xml:
- name: item
- - name: TagSpecification
- in: query
- required: false
- description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: ClientToken
- in: query
- required: false
- description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
- schema:
- type: string
- - name: AwsService
- in: query
- required: false
- description: 'Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.'
- schema:
- type: string
- enum:
- - ec2
- 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'
- post:
- x-aws-operation-name: CreateIpamPool
- operationId: POST_CreateIpamPool
- description: 'Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamPoolResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamPoolRequest' - parameters: [] - /?Action=CreateIpamScope&Version=2016-11-15: - get: - x-aws-operation-name: CreateIpamScope - operationId: GET_CreateIpamScope - description: 'Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see Add a scope in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamScopeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamId
- in: query
- required: true
- description: The ID of the IPAM for which you're creating this scope.
- schema:
- type: string
- - name: Description
- in: query
- required: false
- description: A description for the scope you're creating.
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: ClientToken
- in: query
- required: false
- description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CreateIpamScope
- operationId: POST_CreateIpamScope
- description: 'Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see Add a scope in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamScopeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamScopeRequest' - parameters: [] - /?Action=CreateKeyPair&Version=2016-11-15: - get: - x-aws-operation-name: CreateKeyPair - operationId: GET_CreateKeyPair - description: 'Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.
The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.
You can have up to 5,000 key pairs per Amazon Web Services Region.
For more information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/KeyPair' - parameters: - - name: KeyName - in: query - required: true - description: 'A unique name for the key pair.
Constraints: Up to 255 ASCII characters
' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: KeyType
- in: query
- required: false
- description: 'The type of key pair. Note that ED25519 keys are not supported for Windows instances.
Default: rsa
The format of the key pair.
Default: pem
Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.
The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.
You can have up to 5,000 key pairs per Amazon Web Services Region.
For more information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/KeyPair' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateKeyPairRequest' - parameters: [] - /?Action=CreateLaunchTemplate&Version=2016-11-15: - get: - x-aws-operation-name: CreateLaunchTemplate - operationId: GET_CreateLaunchTemplate - description: 'Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLaunchTemplateResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraint: Maximum 128 ASCII characters.
' - schema: - type: string - - name: LaunchTemplateName - in: query - required: true - description: A name for the launch template. - schema: - type: string - pattern: '[a-zA-Z0-9\(\)\.\-/_]+' - minLength: 3 - maxLength: 128 - - name: VersionDescription - in: query - required: false - description: A description for the first version of the launch template. - schema: - type: string - minLength: 0 - maxLength: 255 - - name: LaunchTemplateData - in: query - required: true - description: The information for the launch template. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecificationRequest' - - description: The name or Amazon Resource Name (ARN) of an IAM instance profile. - BlockDeviceMapping: - allOf: - - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingRequestList' - - description: The block device mapping. - NetworkInterface: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance at Launch (Linux) or Adding User Data (Windows).
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
' - TagSpecification: - allOf: - - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequestList' - - description: 'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.' - ElasticGpuSpecification: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecificationList' - - description: An elastic GPU to associate with the instance. - ElasticInferenceAccelerator: - allOf: - - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorList' - - description: ' The elastic inference accelerator for the instance. ' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: 'One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.' - SecurityGroup: - allOf: - - $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationRequest' - - description: 'The Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults toopen, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
- LicenseSpecification:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptionsRequest'
- - description: The maintenance options for the instance.
- description: The information to include in the launch template.
You must specify at least one parameter for the launch template data.
Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLaunchTemplateResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLaunchTemplateRequest' - parameters: [] - /?Action=CreateLaunchTemplateVersion&Version=2016-11-15: - get: - x-aws-operation-name: CreateLaunchTemplateVersion - operationId: GET_CreateLaunchTemplateVersion - description: 'Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.
For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLaunchTemplateVersionResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraint: Maximum 128 ASCII characters.
' - schema: - type: string - - name: LaunchTemplateId - in: query - required: false - description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request. - schema: - type: string - - name: LaunchTemplateName - in: query - required: false - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. - schema: - type: string - pattern: '[a-zA-Z0-9\(\)\.\-/_]+' - minLength: 3 - maxLength: 128 - - name: SourceVersion - in: query - required: false - description: 'The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify inLaunchTemplateData. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.'
- schema:
- type: string
- - name: VersionDescription
- in: query
- required: false
- description: A description for the version of the launch template.
- schema:
- type: string
- minLength: 0
- maxLength: 255
- - name: LaunchTemplateData
- in: query
- required: true
- description: The information for the launch template.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecificationRequest'
- - description: The name or Amazon Resource Name (ARN) of an IAM instance profile.
- BlockDeviceMapping:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingRequestList'
- - description: The block device mapping.
- NetworkInterface:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance at Launch (Linux) or Adding User Data (Windows).
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
' - TagSpecification: - allOf: - - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequestList' - - description: 'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.' - ElasticGpuSpecification: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecificationList' - - description: An elastic GPU to associate with the instance. - ElasticInferenceAccelerator: - allOf: - - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorList' - - description: ' The elastic inference accelerator for the instance. ' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: 'One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.' - SecurityGroup: - allOf: - - $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationRequest' - - description: 'The Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults toopen, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
- LicenseSpecification:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptionsRequest'
- - description: The maintenance options for the instance.
- description: The information to include in the launch template.
You must specify at least one parameter for the launch template data.
Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.
For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLaunchTemplateVersionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLaunchTemplateVersionRequest' - parameters: [] - /?Action=CreateLocalGatewayRoute&Version=2016-11-15: - get: - x-aws-operation-name: CreateLocalGatewayRoute - operationId: GET_CreateLocalGatewayRoute - description: Creates a static route for the specified local gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLocalGatewayRouteResult' - parameters: - - name: DestinationCidrBlock - in: query - required: true - description: The CIDR range used for destination matches. Routing decisions are based on the most specific match. - schema: - type: string - - name: LocalGatewayRouteTableId - in: query - required: true - description: The ID of the local gateway route table. - schema: - type: string - - name: LocalGatewayVirtualInterfaceGroupId - in: query - required: true - description: The ID of the virtual interface group. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateLocalGatewayRoute
- operationId: POST_CreateLocalGatewayRoute
- description: Creates a static route for the specified local gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateLocalGatewayRouteResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateLocalGatewayRouteRequest'
- parameters: []
- /?Action=CreateLocalGatewayRouteTableVpcAssociation&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateLocalGatewayRouteTableVpcAssociation
- operationId: GET_CreateLocalGatewayRouteTableVpcAssociation
- description: Associates the specified VPC with the specified local gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateLocalGatewayRouteTableVpcAssociationResult'
- parameters:
- - name: LocalGatewayRouteTableId
- in: query
- required: true
- description: The ID of the local gateway route table.
- schema:
- type: string
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC.
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to assign to the local gateway route table VPC association.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateLocalGatewayRouteTableVpcAssociation
- operationId: POST_CreateLocalGatewayRouteTableVpcAssociation
- description: Associates the specified VPC with the specified local gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateLocalGatewayRouteTableVpcAssociationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateLocalGatewayRouteTableVpcAssociationRequest'
- parameters: []
- /?Action=CreateManagedPrefixList&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateManagedPrefixList
- operationId: GET_CreateManagedPrefixList
- description: Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateManagedPrefixListResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PrefixListName
- in: query
- required: true
- description: 'A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
The IP address type.
Valid Values: IPv4 | IPv6
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Up to 255 UTF-8 characters in length.
' - schema: - type: string - 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' - post: - x-aws-operation-name: CreateManagedPrefixList - operationId: POST_CreateManagedPrefixList - description: Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateManagedPrefixListResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateManagedPrefixListRequest' - parameters: [] - /?Action=CreateNatGateway&Version=2016-11-15: - get: - x-aws-operation-name: CreateNatGateway - operationId: GET_CreateNatGateway - description: 'Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.
With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.
With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.
For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNatGatewayResult' - parameters: - - name: AllocationId - in: query - required: false - description: '[Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.' - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
Constraint: Maximum 64 ASCII characters.
' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: SubnetId
- in: query
- required: true
- description: The subnet in which to create the NAT gateway.
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to assign to the NAT gateway.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: ConnectivityType
- in: query
- required: false
- description: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
- schema:
- type: string
- enum:
- - private
- - public
- 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'
- post:
- x-aws-operation-name: CreateNatGateway
- operationId: POST_CreateNatGateway
- description: 'Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.
With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.
With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.
For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNatGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNatGatewayRequest' - parameters: [] - /?Action=CreateNetworkAcl&Version=2016-11-15: - get: - x-aws-operation-name: CreateNetworkAcl - operationId: GET_CreateNetworkAcl - description: 'Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkAclResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC.
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to assign to the network ACL.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: CreateNetworkAcl
- operationId: POST_CreateNetworkAcl
- description: 'Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkAclResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkAclRequest' - parameters: [] - /?Action=CreateNetworkAclEntry&Version=2016-11-15: - get: - x-aws-operation-name: CreateNetworkAclEntry - operationId: GET_CreateNetworkAclEntry - description: 'Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can''t modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - parameters: - - name: CidrBlock - in: query - required: false - description: 'The IPv4 network range to allow or deny, in CIDR notation (for example172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.'
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Egress
- in: query
- required: true
- description: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
- schema:
- type: boolean
- - name: Icmp
- in: query
- required: false
- description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.'
- schema:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The ICMP code. A value of -1 means all codes for the specified ICMP type.
- type:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The ICMP type. A value of -1 means all types.
- description: Describes the ICMP type and code.
- - name: Ipv6CidrBlock
- in: query
- required: false
- description: 'The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).'
- schema:
- type: string
- - name: NetworkAclId
- in: query
- required: true
- description: The ID of the network ACL.
- schema:
- type: string
- - name: PortRange
- in: query
- required: false
- description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).'
- schema:
- type: object
- properties:
- from:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The first port in the range.
- to:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The last port in the range.
- description: Describes a range of ports.
- - name: Protocol
- in: query
- required: true
- description: 'The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.'
- schema:
- type: string
- - name: RuleAction
- in: query
- required: true
- description: Indicates whether to allow or deny the traffic that matches the rule.
- schema:
- type: string
- enum:
- - allow
- - deny
- - name: RuleNumber
- in: query
- required: true
- description: 'The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
' - schema: - type: integer - 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' - post: - x-aws-operation-name: CreateNetworkAclEntry - operationId: POST_CreateNetworkAclEntry - description: 'Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can''t modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkAclEntryRequest' - parameters: [] - /?Action=CreateNetworkInsightsAccessScope&Version=2016-11-15: - get: - x-aws-operation-name: CreateNetworkInsightsAccessScope - operationId: GET_CreateNetworkInsightsAccessScope - description: 'Creates a Network Access Scope.
Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeResult' - parameters: - - name: MatchPath - in: query - required: false - description: The paths to match. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/AccessScopePathRequest' - - xml: - name: item - - name: ExcludePath - in: query - required: false - description: The paths to exclude. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/AccessScopePathRequest' - - xml: - name: item - - name: ClientToken - in: query - required: true - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateNetworkInsightsAccessScope
- operationId: POST_CreateNetworkInsightsAccessScope
- description: 'Creates a Network Access Scope.
Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeRequest' - parameters: [] - /?Action=CreateNetworkInsightsPath&Version=2016-11-15: - get: - x-aws-operation-name: CreateNetworkInsightsPath - operationId: GET_CreateNetworkInsightsPath - description: 'Creates a path to analyze for reachability.
Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see What is Reachability Analyzer.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInsightsPathResult' - parameters: - - name: SourceIp - in: query - required: false - description: The IP address of the Amazon Web Services resource that is the source of the path. - schema: - type: string - pattern: '^([0-9]{1,3}.){3}[0-9]{1,3}$' - minLength: 0 - maxLength: 15 - - name: DestinationIp - in: query - required: false - description: The IP address of the Amazon Web Services resource that is the destination of the path. - schema: - type: string - pattern: '^([0-9]{1,3}.){3}[0-9]{1,3}$' - minLength: 0 - maxLength: 15 - - name: Source - in: query - required: true - description: The Amazon Web Services resource that is the source of the path. - schema: - type: string - - name: Destination - in: query - required: true - description: The Amazon Web Services resource that is the destination of the path. - schema: - type: string - - name: Protocol - in: query - required: true - description: The protocol. - schema: - type: string - enum: - - tcp - - udp - - name: DestinationPort - in: query - required: false - description: The destination port. - schema: - type: integer - minimum: 1 - maximum: 65535 - - name: TagSpecification - in: query - required: false - description: The tags to add to the path. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: true
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CreateNetworkInsightsPath
- operationId: POST_CreateNetworkInsightsPath
- description: 'Creates a path to analyze for reachability.
Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see What is Reachability Analyzer.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInsightsPathResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInsightsPathRequest' - parameters: [] - /?Action=CreateNetworkInterface&Version=2016-11-15: - get: - x-aws-operation-name: CreateNetworkInterface - operationId: GET_CreateNetworkInterface - description: 'Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInterfaceResult' - parameters: - - name: Description - in: query - required: false - description: A description for the network interface. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: SecurityGroupId
- in: query
- required: false
- description: The IDs of one or more security groups.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: SecurityGroupId
- - name: Ipv6AddressCount
- in: query
- required: false
- description: 'The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can''t use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.'
- schema:
- type: integer
- - name: Ipv6Addresses
- in: query
- required: false
- description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceIpv6Address'
- - xml:
- name: item
- - name: PrivateIpAddress
- in: query
- required: false
- description: 'The primary private IPv4 address of the network interface. If you don''t specify an IPv4 address, Amazon EC2 selects one for you from the subnet''s IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).'
- schema:
- type: string
- - name: PrivateIpAddresses
- in: query
- required: false
- description: One or more private IPv4 addresses.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PrivateIpAddressSpecification'
- - xml:
- name: item
- - name: SecondaryPrivateIpAddressCount
- in: query
- required: false
- description: 'The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet''s IPv4 CIDR range. You can''t specify this option and specify more than one private IP address using privateIpAddresses.
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.
' - schema: - type: integer - - name: Ipv4Prefix - in: query - required: false - description: One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use theIpv4PrefixCount option.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv4PrefixSpecificationRequest'
- - xml:
- name: item
- - name: Ipv4PrefixCount
- in: query
- required: false
- description: The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
- schema:
- type: integer
- - name: Ipv6Prefix
- in: query
- required: false
- description: One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv6PrefixSpecificationRequest'
- - xml:
- name: item
- - name: Ipv6PrefixCount
- in: query
- required: false
- description: The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.
- schema:
- type: integer
- - name: InterfaceType
- in: query
- required: false
- description: The type of network interface. The default is interface.
The only supported values are efa and trunk.
Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInterfaceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInterfaceRequest' - parameters: [] - /?Action=CreateNetworkInterfacePermission&Version=2016-11-15: - get: - x-aws-operation-name: CreateNetworkInterfacePermission - operationId: GET_CreateNetworkInterfacePermission - description: 'Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single Amazon Web Services account only, and only one account at a time.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInterfacePermissionResult' - parameters: - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - - name: AwsAccountId - in: query - required: false - description: The Amazon Web Services account ID. - schema: - type: string - - name: AwsService - in: query - required: false - description: The Amazon Web Service. Currently not supported. - schema: - type: string - - name: Permission - in: query - required: true - description: The type of permission to grant. - schema: - type: string - enum: - - INSTANCE-ATTACH - - EIP-ASSOCIATE - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateNetworkInterfacePermission
- operationId: POST_CreateNetworkInterfacePermission
- description: 'Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single Amazon Web Services account only, and only one account at a time.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInterfacePermissionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInterfacePermissionRequest' - parameters: [] - /?Action=CreatePlacementGroup&Version=2016-11-15: - get: - x-aws-operation-name: CreatePlacementGroup - operationId: GET_CreatePlacementGroup - description: 'Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement groups in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePlacementGroupResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: GroupName
- in: query
- required: false
- description: 'A name for the placement group. Must be unique within the scope of your account for the Region.
Constraints: Up to 255 ASCII characters
' - schema: - type: string - - name: Strategy - in: query - required: false - description: The placement strategy. - schema: - type: string - enum: - - cluster - - spread - - partition - - name: PartitionCount - in: query - required: false - description: The number of partitions. Valid only when Strategy is set topartition.
- schema:
- type: integer
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply to the new placement group.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: CreatePlacementGroup
- operationId: POST_CreatePlacementGroup
- description: 'Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement groups in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePlacementGroupResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePlacementGroupRequest' - parameters: [] - /?Action=CreatePublicIpv4Pool&Version=2016-11-15: - get: - x-aws-operation-name: CreatePublicIpv4Pool - operationId: GET_CreatePublicIpv4Pool - description: 'Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePublicIpv4PoolResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: TagSpecification
- in: query
- required: false
- description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: CreatePublicIpv4Pool
- operationId: POST_CreatePublicIpv4Pool
- description: 'Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreatePublicIpv4PoolResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreatePublicIpv4PoolRequest'
- parameters: []
- /?Action=CreateReplaceRootVolumeTask&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateReplaceRootVolumeTask
- operationId: GET_CreateReplaceRootVolumeTask
- description: 'Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot.
For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateReplaceRootVolumeTaskResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance for which to replace the root volume. - schema: - type: string - - name: SnapshotId - in: query - required: false - description: 'The ID of the snapshot from which to restore the replacement root volume. If you want to restore the volume to the initial launch state, omit this parameter.' - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply to the root volume replacement task.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: CreateReplaceRootVolumeTask
- operationId: POST_CreateReplaceRootVolumeTask
- description: 'Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot.
For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateReplaceRootVolumeTaskResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateReplaceRootVolumeTaskRequest' - parameters: [] - /?Action=CreateReservedInstancesListing&Version=2016-11-15: - get: - x-aws-operation-name: CreateReservedInstancesListing - operationId: GET_CreateReservedInstancesListing - description: 'Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.
The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateReservedInstancesListingResult' - parameters: - - name: ClientToken - in: query - required: true - description: 'Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: InstanceCount - in: query - required: true - description: The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call. - schema: - type: integer - - name: PriceSchedules - in: query - required: true - description: A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/PriceScheduleSpecification' - - xml: - name: item - - name: ReservedInstancesId - in: query - required: true - description: The ID of the active Standard Reserved Instance. - schema: - type: string - 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' - post: - x-aws-operation-name: CreateReservedInstancesListing - operationId: POST_CreateReservedInstancesListing - description: 'Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.
The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateReservedInstancesListingResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateReservedInstancesListingRequest' - parameters: [] - /?Action=CreateRestoreImageTask&Version=2016-11-15: - get: - x-aws-operation-name: CreateRestoreImageTask - operationId: GET_CreateRestoreImageTask - description: 'Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRestoreImageTaskResult' - parameters: - - name: Bucket - in: query - required: true - description: The name of the Amazon S3 bucket that contains the stored AMI object. - schema: - type: string - - name: ObjectKey - in: query - required: true - description: The name of the stored AMI object in the bucket. - schema: - type: string - - name: Name - in: query - required: false - description: 'The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: 'The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.
To tag the AMI, the value for ResourceType must be image.
To tag the snapshots, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateRestoreImageTask
- operationId: POST_CreateRestoreImageTask
- description: 'Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRestoreImageTaskResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRestoreImageTaskRequest' - parameters: [] - /?Action=CreateRoute&Version=2016-11-15: - get: - x-aws-operation-name: CreateRoute - operationId: GET_CreateRoute - description: 'Creates a route in a route table within a VPC.
You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRouteResult' - parameters: - - name: DestinationCidrBlock - in: query - required: false - description: 'The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify100.68.0.18/18, we modify it to 100.68.0.0/18.'
- schema:
- type: string
- - name: DestinationIpv6CidrBlock
- in: query
- required: false
- description: The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
- schema:
- type: string
- - name: DestinationPrefixListId
- in: query
- required: false
- description: The ID of a prefix list used for the destination match.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcEndpointId
- in: query
- required: false
- description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
- schema:
- type: string
- - name: EgressOnlyInternetGatewayId
- in: query
- required: false
- description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
- schema:
- type: string
- - name: GatewayId
- in: query
- required: false
- description: The ID of an internet gateway or virtual private gateway attached to your VPC.
- schema:
- type: string
- - name: InstanceId
- in: query
- required: false
- description: The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
- schema:
- type: string
- - name: NatGatewayId
- in: query
- required: false
- description: '[IPv4 traffic only] The ID of a NAT gateway.'
- schema:
- type: string
- - name: TransitGatewayId
- in: query
- required: false
- description: The ID of a transit gateway.
- schema:
- type: string
- - name: LocalGatewayId
- in: query
- required: false
- description: The ID of the local gateway.
- schema:
- type: string
- - name: CarrierGatewayId
- in: query
- required: false
- description: The ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
- schema: - type: string - - name: NetworkInterfaceId - in: query - required: false - description: The ID of a network interface. - schema: - type: string - - name: RouteTableId - in: query - required: true - description: The ID of the route table for the route. - schema: - type: string - - name: VpcPeeringConnectionId - in: query - required: false - description: The ID of a VPC peering connection. - schema: - type: string - - name: CoreNetworkArn - in: query - required: false - description: The Amazon Resource Name (ARN) of the core network. - schema: - type: string - 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' - post: - x-aws-operation-name: CreateRoute - operationId: POST_CreateRoute - description: 'Creates a route in a route table within a VPC.
You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRouteResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRouteRequest' - parameters: [] - /?Action=CreateRouteTable&Version=2016-11-15: - get: - x-aws-operation-name: CreateRouteTable - operationId: GET_CreateRouteTable - description: 'Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRouteTableResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC.
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to assign to the route table.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: CreateRouteTable
- operationId: POST_CreateRouteTable
- description: 'Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRouteTableResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRouteTableRequest' - parameters: [] - /?Action=CreateSecurityGroup&Version=2016-11-15: - get: - x-aws-operation-name: CreateSecurityGroup - operationId: GET_CreateSecurityGroup - description: 'Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can''t have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don''t specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.
For more information about VPC security group limits, see Amazon VPC Limits.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSecurityGroupResult' - parameters: - - name: GroupDescription - in: query - required: true - description: 'A description for the security group. This is informational only.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' - schema: - type: string - - name: GroupName - in: query - required: true - description: 'The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg-.
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' - schema: - type: string - - name: VpcId - in: query - required: false - description: '[EC2-VPC] The ID of the VPC. Required for EC2-VPC.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to the security group. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateSecurityGroup
- operationId: POST_CreateSecurityGroup
- description: 'Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can''t have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don''t specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.
For more information about VPC security group limits, see Amazon VPC Limits.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSecurityGroupResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSecurityGroupRequest' - parameters: [] - /?Action=CreateSnapshot&Version=2016-11-15: - get: - x-aws-operation-name: CreateSnapshot - operationId: GET_CreateSnapshot - description: 'Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.
To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/Snapshot' - parameters: - - name: Description - in: query - required: false - description: A description for the snapshot. - schema: - type: string - - name: OutpostArn - in: query - required: false - description: 'The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.
To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.
To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.
For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.
' - schema: - type: string - - name: VolumeId - in: query - required: true - description: The ID of the Amazon EBS volume. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the snapshot during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateSnapshot
- operationId: POST_CreateSnapshot
- description: 'Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.
To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/Snapshot' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSnapshotRequest' - parameters: [] - /?Action=CreateSnapshots&Version=2016-11-15: - get: - x-aws-operation-name: CreateSnapshots - operationId: GET_CreateSnapshots - description: 'Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters.
You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSnapshotsResult' - parameters: - - name: Description - in: query - required: false - description: ' A description propagated to every snapshot specified by the instance.' - schema: - type: string - - name: InstanceSpecification - in: query - required: true - description: The instance to specify which volumes should be included in the snapshots. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Excludes the root volume from being snapshotted. - description: The instance details to specify which volumes should be snapshotted. - - name: OutpostArn - in: query - required: false - description: 'The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.
To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.
To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.
To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.
For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.
' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: Tags to apply to every snapshot specified by the instance. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: CopyTagsFromSource
- in: query
- required: false
- description: Copies the tags from the specified volume to corresponding snapshot.
- schema:
- type: string
- enum:
- - volume
- 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'
- post:
- x-aws-operation-name: CreateSnapshots
- operationId: POST_CreateSnapshots
- description: 'Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters.
You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSnapshotsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSnapshotsRequest' - parameters: [] - /?Action=CreateSpotDatafeedSubscription&Version=2016-11-15: - get: - x-aws-operation-name: CreateSpotDatafeedSubscription - operationId: GET_CreateSpotDatafeedSubscription - description: 'Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSpotDatafeedSubscriptionResult' - parameters: - - name: Bucket - in: query - required: true - description: 'The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Prefix
- in: query
- required: false
- description: The prefix for the data feed file names.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CreateSpotDatafeedSubscription
- operationId: POST_CreateSpotDatafeedSubscription
- description: 'Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateSpotDatafeedSubscriptionResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateSpotDatafeedSubscriptionRequest'
- parameters: []
- /?Action=CreateStoreImageTask&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateStoreImageTask
- operationId: GET_CreateStoreImageTask
- description: 'Stores an AMI as a single object in an Amazon S3 bucket.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateStoreImageTaskResult' - parameters: - - name: ImageId - in: query - required: true - description: The ID of the AMI. - schema: - type: string - - name: Bucket - in: query - required: true - description: 'The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed. ' - schema: - type: string - - name: S3ObjectTag - in: query - required: false - description: 'The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. ' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/S3ObjectTag' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateStoreImageTask
- operationId: POST_CreateStoreImageTask
- description: 'Stores an AMI as a single object in an Amazon S3 bucket.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateStoreImageTaskResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateStoreImageTaskRequest' - parameters: [] - /?Action=CreateSubnet&Version=2016-11-15: - get: - x-aws-operation-name: CreateSubnet - operationId: GET_CreateSubnet - description: 'Creates a subnet in a specified VPC.
You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can''t change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.
If you''ve associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.
Amazon Web Services reserves both the first four and the last IPv4 address in each subnet''s CIDR block. They''re not available for use.
If you add more than one subnet to a VPC, they''re set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It''s therefore possible to have a subnet with no running instances (they''re all stopped), but no remaining IP addresses available.
For more information about subnets, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSubnetResult' - parameters: - - name: TagSpecification - in: query - required: false - description: The tags to assign to the subnet. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: AvailabilityZone - in: query - required: false - description: 'The Availability Zone or Local Zone for the subnet.
Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.
To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide.
To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.
' - schema: - type: string - - name: AvailabilityZoneId - in: query - required: false - description: The AZ ID or the Local Zone ID of the subnet. - schema: - type: string - - name: CidrBlock - in: query - required: false - description: 'The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
This parameter is not supported for an IPv6 only subnet.
' - schema: - type: string - - name: Ipv6CidrBlock - in: query - required: false - description: 'The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
This parameter is required for an IPv6 only subnet.
' - schema: - type: string - - name: OutpostArn - in: query - required: false - description: 'The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.' - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Ipv6Native
- in: query
- required: false
- description: Indicates whether to create an IPv6 only subnet.
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateSubnet
- operationId: POST_CreateSubnet
- description: 'Creates a subnet in a specified VPC.
You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can''t change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.
If you''ve associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.
Amazon Web Services reserves both the first four and the last IPv4 address in each subnet''s CIDR block. They''re not available for use.
If you add more than one subnet to a VPC, they''re set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It''s therefore possible to have a subnet with no running instances (they''re all stopped), but no remaining IP addresses available.
For more information about subnets, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSubnetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSubnetRequest' - parameters: [] - /?Action=CreateSubnetCidrReservation&Version=2016-11-15: - get: - x-aws-operation-name: CreateSubnetCidrReservation - operationId: GET_CreateSubnetCidrReservation - description: 'Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSubnetCidrReservationResult' - parameters: - - name: SubnetId - in: query - required: true - description: The ID of the subnet. - schema: - type: string - - name: Cidr - in: query - required: true - description: The IPv4 or IPV6 CIDR range to reserve. - schema: - type: string - - name: ReservationType - in: query - required: true - description: 'The type of reservation.
The following are valid values:
prefix: The Amazon EC2 Prefix Delegation feature assigns the IP addresses to network interfaces that are associated with an instance. For information about Prefix Delegation, see Prefix Delegation for Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
explicit: You manually assign the IP addresses to resources that reside in your subnet.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: TagSpecification
- in: query
- required: false
- description: The tags to assign to the subnet CIDR reservation.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: CreateSubnetCidrReservation
- operationId: POST_CreateSubnetCidrReservation
- description: 'Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateSubnetCidrReservationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateSubnetCidrReservationRequest'
- parameters: []
- /?Action=CreateTags&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateTags
- operationId: GET_CreateTags
- description: 'Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users'' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ResourceId
- in: query
- required: true
- description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' - schema: - type: array - items: - $ref: '#/components/schemas/TaggableResourceId' - - name: Tag - in: query - required: true - description: 'The tags. Thevalue parameter is required, but if you don''t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Tag'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: CreateTags
- operationId: POST_CreateTags
- description: 'Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users'' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTagsRequest' - parameters: [] - /?Action=CreateTrafficMirrorFilter&Version=2016-11-15: - get: - x-aws-operation-name: CreateTrafficMirrorFilter - operationId: GET_CreateTrafficMirrorFilter - description: 'Creates a Traffic Mirror filter.
A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorFilterResult' - parameters: - - name: Description - in: query - required: false - description: The description of the Traffic Mirror filter. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to a Traffic Mirror filter. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CreateTrafficMirrorFilter
- operationId: POST_CreateTrafficMirrorFilter
- description: 'Creates a Traffic Mirror filter.
A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorFilterResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorFilterRequest' - parameters: [] - /?Action=CreateTrafficMirrorFilterRule&Version=2016-11-15: - get: - x-aws-operation-name: CreateTrafficMirrorFilterRule - operationId: GET_CreateTrafficMirrorFilterRule - description:Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleResult' - parameters: - - name: TrafficMirrorFilterId - in: query - required: true - description: The ID of the filter that this rule is associated with. - schema: - type: string - - name: TrafficDirection - in: query - required: true - description: The type of traffic. - schema: - type: string - enum: - - ingress - - egress - - name: RuleNumber - in: query - required: true - description: The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number. - schema: - type: integer - - name: RuleAction - in: query - required: true - description: The action to take on the filtered traffic. - schema: - type: string - enum: - - accept - - reject - - name: DestinationPortRange - in: query - required: false - description: The destination port range. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. - description: Information about the Traffic Mirror filter rule port range. - - name: SourcePortRange - in: query - required: false - description: The source port range. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. - description: Information about the Traffic Mirror filter rule port range. - - name: Protocol - in: query - required: false - description: 'The protocol, for example UDP, to assign to the Traffic Mirror rule.
For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.
' - schema: - type: integer - - name: DestinationCidrBlock - in: query - required: true - description: The destination CIDR block to assign to the Traffic Mirror rule. - schema: - type: string - - name: SourceCidrBlock - in: query - required: true - description: The source CIDR block to assign to the Traffic Mirror rule. - schema: - type: string - - name: Description - in: query - required: false - description: The description of the Traffic Mirror rule. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CreateTrafficMirrorFilterRule
- operationId: POST_CreateTrafficMirrorFilterRule
- description: Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleRequest' - parameters: [] - /?Action=CreateTrafficMirrorSession&Version=2016-11-15: - get: - x-aws-operation-name: CreateTrafficMirrorSession - operationId: GET_CreateTrafficMirrorSession - description: 'Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorSessionResult' - parameters: - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the source network interface. - schema: - type: string - - name: TrafficMirrorTargetId - in: query - required: true - description: The ID of the Traffic Mirror target. - schema: - type: string - - name: TrafficMirrorFilterId - in: query - required: true - description: The ID of the Traffic Mirror filter. - schema: - type: string - - name: PacketLength - in: query - required: false - description: 'The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.
If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
- schema: - type: integer - - name: VirtualNetworkId - in: query - required: false - description: 'The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify aVirtualNetworkId, an account-wide unique id is chosen at random.'
- schema:
- type: integer
- - name: Description
- in: query
- required: false
- description: The description of the Traffic Mirror session.
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to assign to a Traffic Mirror session.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CreateTrafficMirrorSession
- operationId: POST_CreateTrafficMirrorSession
- description: 'Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorSessionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorSessionRequest' - parameters: [] - /?Action=CreateTrafficMirrorTarget&Version=2016-11-15: - get: - x-aws-operation-name: CreateTrafficMirrorTarget - operationId: GET_CreateTrafficMirrorTarget - description: 'Creates a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.
To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorTargetResult' - parameters: - - name: NetworkInterfaceId - in: query - required: false - description: The network interface ID that is associated with the target. - schema: - type: string - - name: NetworkLoadBalancerArn - in: query - required: false - description: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target. - schema: - type: string - - name: Description - in: query - required: false - description: The description of the Traffic Mirror target. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to the Traffic Mirror target. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- - name: GatewayLoadBalancerEndpointId
- in: query
- required: false
- description: The ID of the Gateway Load Balancer endpoint.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CreateTrafficMirrorTarget
- operationId: POST_CreateTrafficMirrorTarget
- description: 'Creates a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.
To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorTargetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorTargetRequest' - parameters: [] - /?Action=CreateTransitGateway&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGateway - operationId: GET_CreateTransitGateway - description: 'Creates a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment.
To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayResult' - parameters: - - name: Description - in: query - required: false - description: A description of the transit gateway. - schema: - type: string - - name: Options - in: query - required: false - description: The transit gateway options. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayCidrBlockStringList' - - description: 'One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.' - description: Describes the options for a transit gateway. - - name: TagSpecification - in: query - required: false - description: The tags to apply to the transit gateway. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateTransitGateway
- operationId: POST_CreateTransitGateway
- description: 'Creates a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment.
To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayRequest' - parameters: [] - /?Action=CreateTransitGatewayConnect&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayConnect - operationId: GET_CreateTransitGatewayConnect - description:Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayConnectResult' - parameters: - - name: TransportTransitGatewayAttachmentId - in: query - required: true - description: The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment. - schema: - type: string - - name: Options - in: query - required: true - description: The Connect attachment options. - schema: - type: object - required: - - Protocol - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ProtocolValue' - - description: The tunnel protocol. - description: The options for a Connect attachment. - - name: TagSpecification - in: query - required: false - description: The tags to apply to the Connect attachment. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateTransitGatewayConnect
- operationId: POST_CreateTransitGatewayConnect
- description: Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayConnectResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayConnectRequest' - parameters: [] - /?Action=CreateTransitGatewayConnectPeer&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayConnectPeer - operationId: GET_CreateTransitGatewayConnectPeer - description: 'Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
For more information, see Connect peers in the Transit Gateways Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayConnectPeerResult' - parameters: - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the Connect attachment. - schema: - type: string - - name: TransitGatewayAddress - in: query - required: false - description: 'The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.' - schema: - type: string - - name: PeerAddress - in: query - required: true - description: The peer IP address (GRE outer IP address) on the appliance side of the Connect peer. - schema: - type: string - - name: BgpOptions - in: query - required: false - description: The BGP options for the Connect peer. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Long' - - description: The peer Autonomous System Number (ASN). - description: The BGP options for the Connect attachment. - - name: InsideCidrBlocks - in: query - required: true - description: 'The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply to the Connect peer.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateTransitGatewayConnectPeer
- operationId: POST_CreateTransitGatewayConnectPeer
- description: 'Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
For more information, see Connect peers in the Transit Gateways Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayConnectPeerResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayConnectPeerRequest' - parameters: [] - /?Action=CreateTransitGatewayMulticastDomain&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayMulticastDomain - operationId: GET_CreateTransitGatewayMulticastDomain - description: 'Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainResult' - parameters: - - name: TransitGatewayId - in: query - required: true - description: The ID of the transit gateway. - schema: - type: string - - name: Options - in: query - required: false - description: The options for the transit gateway multicast domain. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/AutoAcceptSharedAssociationsValue' - - description: Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain. - description: The options for the transit gateway multicast domain. - - name: TagSpecification - in: query - required: false - description: The tags for the transit gateway multicast domain. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateTransitGatewayMulticastDomain
- operationId: POST_CreateTransitGatewayMulticastDomain
- description: 'Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainRequest' - parameters: [] - /?Action=CreateTransitGatewayPeeringAttachment&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayPeeringAttachment - operationId: GET_CreateTransitGatewayPeeringAttachment - description: 'Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different Amazon Web Services account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentResult' - parameters: - - name: TransitGatewayId - in: query - required: true - description: The ID of the transit gateway. - schema: - type: string - - name: PeerTransitGatewayId - in: query - required: true - description: The ID of the peer transit gateway with which to create the peering attachment. - schema: - type: string - - name: PeerAccountId - in: query - required: true - description: The ID of the Amazon Web Services account that owns the peer transit gateway. - schema: - type: string - - name: PeerRegion - in: query - required: true - description: The Region where the peer transit gateway is located. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the transit gateway peering attachment. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateTransitGatewayPeeringAttachment
- operationId: POST_CreateTransitGatewayPeeringAttachment
- description: 'Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different Amazon Web Services account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentRequest' - parameters: [] - /?Action=CreateTransitGatewayPrefixListReference&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayPrefixListReference - operationId: GET_CreateTransitGatewayPrefixListReference - description: Creates a reference (route) to a prefix list in a specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: PrefixListId - in: query - required: true - description: The ID of the prefix list that is used for destination matches. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the attachment to which traffic is routed. - schema: - type: string - - name: Blackhole - in: query - required: false - description: Indicates whether to drop traffic that matches this route. - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateTransitGatewayPrefixListReference
- operationId: POST_CreateTransitGatewayPrefixListReference
- description: Creates a reference (route) to a prefix list in a specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceRequest'
- parameters: []
- /?Action=CreateTransitGatewayRoute&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateTransitGatewayRoute
- operationId: GET_CreateTransitGatewayRoute
- description: Creates a static route for the specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateTransitGatewayRouteResult'
- parameters:
- - name: DestinationCidrBlock
- in: query
- required: true
- description: The CIDR range used for destination matches. Routing decisions are based on the most specific match.
- schema:
- type: string
- - name: TransitGatewayRouteTableId
- in: query
- required: true
- description: The ID of the transit gateway route table.
- schema:
- type: string
- - name: TransitGatewayAttachmentId
- in: query
- required: false
- description: The ID of the attachment.
- schema:
- type: string
- - name: Blackhole
- in: query
- required: false
- description: Indicates whether to drop traffic that matches this route.
- schema:
- type: boolean
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateTransitGatewayRoute
- operationId: POST_CreateTransitGatewayRoute
- description: Creates a static route for the specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateTransitGatewayRouteResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateTransitGatewayRouteRequest'
- parameters: []
- /?Action=CreateTransitGatewayRouteTable&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateTransitGatewayRouteTable
- operationId: GET_CreateTransitGatewayRouteTable
- description: Creates a route table for the specified transit gateway.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateTransitGatewayRouteTableResult'
- parameters:
- - name: TransitGatewayId
- in: query
- required: true
- description: The ID of the transit gateway.
- schema:
- type: string
- - name: TagSpecifications
- in: query
- required: false
- description: The tags to apply to the transit gateway route table.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateTransitGatewayRouteTable
- operationId: POST_CreateTransitGatewayRouteTable
- description: Creates a route table for the specified transit gateway.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateTransitGatewayRouteTableResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/CreateTransitGatewayRouteTableRequest'
- parameters: []
- /?Action=CreateTransitGatewayVpcAttachment&Version=2016-11-15:
- get:
- x-aws-operation-name: CreateTransitGatewayVpcAttachment
- operationId: GET_CreateTransitGatewayVpcAttachment
- description: 'Attaches the specified VPC to the specified transit gateway.
If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.
To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentResult' - parameters: - - name: TransitGatewayId - in: query - required: true - description: The ID of the transit gateway. - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: SubnetIds - in: query - required: true - description: 'The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - - name: Options - in: query - required: false - description: The VPC attachment options. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ApplianceModeSupportValue' - - description: 'Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default isdisable.'
- description: Describes the options for a VPC attachment.
- - name: TagSpecifications
- in: query
- required: false
- description: The tags to apply to the VPC attachment.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateTransitGatewayVpcAttachment
- operationId: POST_CreateTransitGatewayVpcAttachment
- description: 'Attaches the specified VPC to the specified transit gateway.
If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.
To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentRequest' - parameters: [] - /?Action=CreateVolume&Version=2016-11-15: - get: - x-aws-operation-name: CreateVolume - operationId: GET_CreateVolume - description: 'Creates an EBS volume that can be attached to an instance in the same Availability Zone.
You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Create an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/Volume' - parameters: - - name: AvailabilityZone - in: query - required: true - description: The Availability Zone in which to create the volume. - schema: - type: string - - name: Encrypted - in: query - required: false - description: 'Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
' - schema: - type: boolean - - name: Iops - in: query - required: false - description: 'The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System. Other instance families support performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
' - schema: - type: string - - name: OutpostArn - in: query - required: false - description: The Amazon Resource Name (ARN) of the Outpost. - schema: - type: string - - name: Size - in: query - required: false - description: 'The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: gp2
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply to the volume during creation.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: MultiAttachEnabled
- in: query
- required: false
- description: 'Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.'
- schema:
- type: boolean
- - name: Throughput
- in: query
- required: false
- description: 'The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
' - schema: - type: integer - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.' - schema: - type: string - 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' - post: - x-aws-operation-name: CreateVolume - operationId: POST_CreateVolume - description: 'Creates an EBS volume that can be attached to an instance in the same Availability Zone.
You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Create an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/Volume' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVolumeRequest' - parameters: [] - /?Action=CreateVpc&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpc - operationId: GET_CreateVpc - description: 'Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon''s pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
You can specify the instance tenancy value for the VPC when you create it. You can''t change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcResult' - parameters: - - name: CidrBlock - in: query - required: false - description: 'The IPv4 network range for the VPC, in CIDR notation. For example,10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.'
- schema:
- type: string
- - name: AmazonProvidedIpv6CidrBlock
- in: query
- required: false
- description: 'Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.'
- schema:
- type: boolean
- - name: Ipv6Pool
- in: query
- required: false
- description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
- schema:
- type: string
- - name: Ipv6CidrBlock
- in: query
- required: false
- description: 'The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
' - schema: - type: string - - name: Ipv4IpamPoolId - in: query - required: false - description: 'The ID of an IPv4 IPAM pool you want to use for allocating this VPC''s CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide. ' - schema: - type: string - - name: Ipv4NetmaskLength - in: query - required: false - description: 'The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.' - schema: - type: integer - - name: Ipv6IpamPoolId - in: query - required: false - description: 'The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.' - schema: - type: string - - name: Ipv6NetmaskLength - in: query - required: false - description: 'The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.' - schema: - type: integer - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceTenancy
- in: query
- required: false
- description: 'The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon''s pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
You can specify the instance tenancy value for the VPC when you create it. You can''t change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcRequest' - parameters: [] - /?Action=CreateVpcEndpoint&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpcEndpoint - operationId: GET_CreateVpcEndpoint - description: 'Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the Amazon Web Services PrivateLink Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcEndpointType
- in: query
- required: false
- description: 'The type of endpoint.
Default: Gateway
' - schema: - type: string - enum: - - Interface - - Gateway - - GatewayLoadBalancer - - name: VpcId - in: query - required: true - description: The ID of the VPC in which the endpoint will be used. - schema: - type: string - - name: ServiceName - in: query - required: true - description: 'The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.' - schema: - type: string - - name: PolicyDocument - in: query - required: false - description: '(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.' - schema: - type: string - - name: RouteTableId - in: query - required: false - description: (Gateway endpoint) One or more route table IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - xml: - name: item - - name: SubnetId - in: query - required: false - description: '(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - - name: SecurityGroupId - in: query - required: false - description: (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - - name: IpAddressType - in: query - required: false - description: The IP address type for the endpoint. - schema: - type: string - enum: - - ipv4 - - dualstack - - ipv6 - - name: DnsOptions - in: query - required: false - description: The DNS options for the endpoint. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DnsRecordIpType' - - description: The DNS records created for the endpoint. - description: Describes the DNS options for an endpoint. - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: PrivateDnsEnabled - in: query - required: false - description: '(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
Default: true
Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
You can create a connection notification for interface endpoints only.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ServiceId
- in: query
- required: false
- description: The ID of the endpoint service.
- schema:
- type: string
- - name: VpcEndpointId
- in: query
- required: false
- description: The ID of the endpoint.
- schema:
- type: string
- - name: ConnectionNotificationArn
- in: query
- required: true
- description: The ARN of the SNS topic for the notifications.
- schema:
- type: string
- - name: ConnectionEvents
- in: query
- required: true
- description: 'One or more endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: CreateVpcEndpointConnectionNotification
- operationId: POST_CreateVpcEndpointConnectionNotification
- description: 'Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
You can create a connection notification for interface endpoints only.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationRequest' - parameters: [] - /?Action=CreateVpcEndpointServiceConfiguration&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpcEndpointServiceConfiguration - operationId: GET_CreateVpcEndpointServiceConfiguration - description: 'Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, IAM users, and IAM roles) can connect.
Before you create an endpoint service, you must create one of the following for your service:
A Network Load Balancer. Service consumers connect to your service using an interface endpoint.
A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint.
If you set the private DNS name, you must prove that you own the private DNS domain name.
For more information, see the Amazon Web Services PrivateLink Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: AcceptanceRequired
- in: query
- required: false
- description: Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.
- schema:
- type: boolean
- - name: PrivateDnsName
- in: query
- required: false
- description: (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
- schema:
- type: string
- - name: NetworkLoadBalancerArn
- in: query
- required: false
- description: The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: GatewayLoadBalancerArn
- in: query
- required: false
- description: The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: SupportedIpAddressType
- in: query
- required: false
- description: The supported IP address types. The possible values are ipv4 and ipv6.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to associate with the service.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: CreateVpcEndpointServiceConfiguration
- operationId: POST_CreateVpcEndpointServiceConfiguration
- description: 'Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, IAM users, and IAM roles) can connect.
Before you create an endpoint service, you must create one of the following for your service:
A Network Load Balancer. Service consumers connect to your service using an interface endpoint.
A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint.
If you set the private DNS name, you must prove that you own the private DNS domain name.
For more information, see the Amazon Web Services PrivateLink Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationRequest' - parameters: [] - /?Action=CreateVpcPeeringConnection&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpcPeeringConnection - operationId: GET_CreateVpcPeeringConnection - description: 'Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide.
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PeerOwnerId
- in: query
- required: false
- description: 'The Amazon Web Services account ID of the owner of the accepter VPC.
Default: Your Amazon Web Services account ID
' - schema: - type: string - - name: PeerVpcId - in: query - required: false - description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. - schema: - type: string - - name: VpcId - in: query - required: false - description: The ID of the requester VPC. You must specify this parameter in the request. - schema: - type: string - - name: PeerRegion - in: query - required: false - description: 'The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to the peering connection. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - 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' - post: - x-aws-operation-name: CreateVpcPeeringConnection - operationId: POST_CreateVpcPeeringConnection - description: 'Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide.
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1.
The response includes information that you need to give to your network administrator to configure your customer gateway.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnConnectionResult' - parameters: - - name: CustomerGatewayId - in: query - required: true - description: The ID of the customer gateway. - schema: - type: string - - name: Type - in: query - required: true - description: The type of VPN connection (ipsec.1).
- schema:
- type: string
- - name: VpnGatewayId
- in: query
- required: false
- description: 'The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.'
- schema:
- type: string
- - name: TransitGatewayId
- in: query
- required: false
- description: 'The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.'
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Options
- in: query
- required: false
- description: The options for the VPN connection.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicate whether to enable acceleration for the VPN connection.
Default: false
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1.
The response includes information that you need to give to your network administrator to configure your customer gateway.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnConnectionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnConnectionRequest' - parameters: [] - /?Action=CreateVpnConnectionRoute&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpnConnectionRoute - operationId: GET_CreateVpnConnectionRoute - description: 'Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - parameters: - - name: DestinationCidrBlock - in: query - required: true - description: The CIDR block associated with the local subnet of the customer network. - schema: - type: string - - name: VpnConnectionId - in: query - required: true - description: The ID of the VPN connection. - schema: - type: string - 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' - post: - x-aws-operation-name: CreateVpnConnectionRoute - operationId: POST_CreateVpnConnectionRoute - description: 'Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnConnectionRouteRequest' - parameters: [] - /?Action=CreateVpnGateway&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpnGateway - operationId: GET_CreateVpnGateway - description: 'Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnGatewayResult' - parameters: - - name: AvailabilityZone - in: query - required: false - description: The Availability Zone for the virtual private gateway. - schema: - type: string - - name: Type - in: query - required: true - description: The type of VPN connection this virtual private gateway supports. - schema: - type: string - enum: - - ipsec.1 - - name: TagSpecification - in: query - required: false - description: The tags to apply to the virtual private gateway. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: AmazonSideAsn - in: query - required: false - description: 'A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you''re using a 16-bit ASN, it must be in the 64512 to 65534 range. If you''re using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
Default: 64512
' - schema: - type: integer - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: CreateVpnGateway
- operationId: POST_CreateVpnGateway
- description: 'Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnGatewayRequest' - parameters: [] - /?Action=DeleteCarrierGateway&Version=2016-11-15: - get: - x-aws-operation-name: DeleteCarrierGateway - operationId: GET_DeleteCarrierGateway - description: 'Deletes a carrier gateway.
If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteCarrierGateway
- operationId: POST_DeleteCarrierGateway
- description: 'Deletes a carrier gateway.
If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteClientVpnEndpoint
- operationId: POST_DeleteClientVpnEndpoint
- description: Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteClientVpnEndpointResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteClientVpnEndpointRequest'
- parameters: []
- /?Action=DeleteClientVpnRoute&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteClientVpnRoute
- operationId: GET_DeleteClientVpnRoute
- description: 'Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteClientVpnRouteResult'
- parameters:
- - name: ClientVpnEndpointId
- in: query
- required: true
- description: The ID of the Client VPN endpoint from which the route is to be deleted.
- schema:
- type: string
- - name: TargetVpcSubnetId
- in: query
- required: false
- description: The ID of the target subnet used by the route.
- schema:
- type: string
- - name: DestinationCidrBlock
- in: query
- required: true
- description: 'The IPv4 address range, in CIDR notation, of the route to be deleted.'
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteClientVpnRoute
- operationId: POST_DeleteClientVpnRoute
- description: 'Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteClientVpnRouteResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteClientVpnRouteRequest'
- parameters: []
- /?Action=DeleteCustomerGateway&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteCustomerGateway
- operationId: GET_DeleteCustomerGateway
- description: Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
- responses:
- '200':
- description: Success
- parameters:
- - name: CustomerGatewayId
- in: query
- required: true
- description: The ID of the customer gateway.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteCustomerGateway
- operationId: POST_DeleteCustomerGateway
- description: Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteCustomerGatewayRequest'
- parameters: []
- /?Action=DeleteDhcpOptions&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteDhcpOptions
- operationId: GET_DeleteDhcpOptions
- description: Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
- responses:
- '200':
- description: Success
- parameters:
- - name: DhcpOptionsId
- in: query
- required: true
- description: The ID of the DHCP options set.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteDhcpOptions
- operationId: POST_DeleteDhcpOptions
- description: Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteDhcpOptionsRequest'
- parameters: []
- /?Action=DeleteEgressOnlyInternetGateway&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteEgressOnlyInternetGateway
- operationId: GET_DeleteEgressOnlyInternetGateway
- description: Deletes an egress-only internet gateway.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: EgressOnlyInternetGatewayId
- in: query
- required: true
- description: The ID of the egress-only internet gateway.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteEgressOnlyInternetGateway
- operationId: POST_DeleteEgressOnlyInternetGateway
- description: Deletes an egress-only internet gateway.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayRequest'
- parameters: []
- /?Action=DeleteFleets&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteFleets
- operationId: GET_DeleteFleets
- description: 'Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFleetsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: FleetId
- in: query
- required: true
- description: The IDs of the EC2 Fleets.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/FleetId'
- - name: TerminateInstances
- in: query
- required: true
- description: 'Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to terminate the instances.
To let the instances continue to run after the EC2 Fleet is deleted, specify NoTerminateInstances. Supported only for fleets of type maintain and request.
For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.
Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFleetsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFleetsRequest' - parameters: [] - /?Action=DeleteFlowLogs&Version=2016-11-15: - get: - x-aws-operation-name: DeleteFlowLogs - operationId: GET_DeleteFlowLogs - description: Deletes one or more flow logs. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFlowLogsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: FlowLogId
- in: query
- required: true
- description: 'One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcFlowLogId' - - xml: - name: item - 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' - post: - x-aws-operation-name: DeleteFlowLogs - operationId: POST_DeleteFlowLogs - description: Deletes one or more flow logs. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFlowLogsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFlowLogsRequest' - parameters: [] - /?Action=DeleteFpgaImage&Version=2016-11-15: - get: - x-aws-operation-name: DeleteFpgaImage - operationId: GET_DeleteFpgaImage - description: Deletes the specified Amazon FPGA Image (AFI). - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFpgaImageResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: FpgaImageId
- in: query
- required: true
- description: The ID of the AFI.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteFpgaImage
- operationId: POST_DeleteFpgaImage
- description: Deletes the specified Amazon FPGA Image (AFI).
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteFpgaImageResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteFpgaImageRequest'
- parameters: []
- /?Action=DeleteInstanceEventWindow&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteInstanceEventWindow
- operationId: GET_DeleteInstanceEventWindow
- description: 'Deletes the specified event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteInstanceEventWindowResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ForceDelete
- in: query
- required: false
- description: Specify true to force delete the event window. Use the force delete parameter if the event window is currently associated with targets.
- schema:
- type: boolean
- - name: InstanceEventWindowId
- in: query
- required: true
- description: The ID of the event window.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteInstanceEventWindow
- operationId: POST_DeleteInstanceEventWindow
- description: 'Deletes the specified event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteInstanceEventWindowResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteInstanceEventWindowRequest' - parameters: [] - /?Action=DeleteInternetGateway&Version=2016-11-15: - get: - x-aws-operation-name: DeleteInternetGateway - operationId: GET_DeleteInternetGateway - description: Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it. - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InternetGatewayId
- in: query
- required: true
- description: The ID of the internet gateway.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteInternetGateway
- operationId: POST_DeleteInternetGateway
- description: Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteInternetGatewayRequest'
- parameters: []
- /?Action=DeleteIpam&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteIpam
- operationId: GET_DeleteIpam
- description: 'Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.
For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamId
- in: query
- required: true
- description: The ID of the IPAM to delete.
- schema:
- type: string
- - name: Cascade
- in: query
- required: false
- description: 'Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:
Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.
No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.
Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.
Deletes all IPAM pools in private scopes.
Deletes all non-default private scopes in the IPAM.
Deletes the default public and private scopes and the IPAM.
Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.
For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamRequest' - parameters: [] - /?Action=DeleteIpamPool&Version=2016-11-15: - get: - x-aws-operation-name: DeleteIpamPool - operationId: GET_DeleteIpamPool - description: 'Delete an IPAM pool.
You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr.
For more information, see Delete a pool in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamPoolResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamPoolId
- in: query
- required: true
- description: The ID of the pool to delete.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteIpamPool
- operationId: POST_DeleteIpamPool
- description: 'Delete an IPAM pool.
You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr.
For more information, see Delete a pool in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamPoolResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamPoolRequest' - parameters: [] - /?Action=DeleteIpamScope&Version=2016-11-15: - get: - x-aws-operation-name: DeleteIpamScope - operationId: GET_DeleteIpamScope - description: 'Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamScopeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamScopeId
- in: query
- required: true
- description: The ID of the scope to delete.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteIpamScope
- operationId: POST_DeleteIpamScope
- description: 'Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamScopeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamScopeRequest' - parameters: [] - /?Action=DeleteKeyPair&Version=2016-11-15: - get: - x-aws-operation-name: DeleteKeyPair - operationId: GET_DeleteKeyPair - description: 'Deletes the specified key pair, by removing the public key from Amazon EC2.' - responses: - '200': - description: Success - parameters: - - name: KeyName - in: query - required: false - description: The name of the key pair. - schema: - type: string - - name: KeyPairId - in: query - required: false - description: The ID of the key pair. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteKeyPair
- operationId: POST_DeleteKeyPair
- description: 'Deletes the specified key pair, by removing the public key from Amazon EC2.'
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteKeyPairRequest'
- parameters: []
- /?Action=DeleteLaunchTemplate&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteLaunchTemplate
- operationId: GET_DeleteLaunchTemplate
- description: Deletes a launch template. Deleting a launch template deletes all of its versions.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteLaunchTemplateResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: LaunchTemplateId
- in: query
- required: false
- description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
- schema:
- type: string
- - name: LaunchTemplateName
- in: query
- required: false
- description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
- schema:
- type: string
- pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
- minLength: 3
- maxLength: 128
- 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'
- post:
- x-aws-operation-name: DeleteLaunchTemplate
- operationId: POST_DeleteLaunchTemplate
- description: Deletes a launch template. Deleting a launch template deletes all of its versions.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteLaunchTemplateResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteLaunchTemplateRequest'
- parameters: []
- /?Action=DeleteLaunchTemplateVersions&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteLaunchTemplateVersions
- operationId: GET_DeleteLaunchTemplateVersions
- description: 'Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: LaunchTemplateId
- in: query
- required: false
- description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
- schema:
- type: string
- - name: LaunchTemplateName
- in: query
- required: false
- description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
- schema:
- type: string
- pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
- minLength: 3
- maxLength: 128
- - name: LaunchTemplateVersion
- in: query
- required: true
- description: The version numbers of one or more launch template versions to delete.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: DeleteLaunchTemplateVersions
- operationId: POST_DeleteLaunchTemplateVersions
- description: 'Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteLaunchTemplateVersionsRequest'
- parameters: []
- /?Action=DeleteLocalGatewayRoute&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteLocalGatewayRoute
- operationId: GET_DeleteLocalGatewayRoute
- description: Deletes the specified route from the specified local gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteLocalGatewayRouteResult'
- parameters:
- - name: DestinationCidrBlock
- in: query
- required: true
- description: The CIDR range for the route. This must match the CIDR for the route exactly.
- schema:
- type: string
- - name: LocalGatewayRouteTableId
- in: query
- required: true
- description: The ID of the local gateway route table.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteLocalGatewayRoute
- operationId: POST_DeleteLocalGatewayRoute
- description: Deletes the specified route from the specified local gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteLocalGatewayRouteResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteLocalGatewayRouteRequest'
- parameters: []
- /?Action=DeleteLocalGatewayRouteTableVpcAssociation&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteLocalGatewayRouteTableVpcAssociation
- operationId: GET_DeleteLocalGatewayRouteTableVpcAssociation
- description: Deletes the specified association between a VPC and local gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteLocalGatewayRouteTableVpcAssociationResult'
- parameters:
- - name: LocalGatewayRouteTableVpcAssociationId
- in: query
- required: true
- description: The ID of the association.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteLocalGatewayRouteTableVpcAssociation
- operationId: POST_DeleteLocalGatewayRouteTableVpcAssociation
- description: Deletes the specified association between a VPC and local gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteLocalGatewayRouteTableVpcAssociationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteLocalGatewayRouteTableVpcAssociationRequest'
- parameters: []
- /?Action=DeleteManagedPrefixList&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteManagedPrefixList
- operationId: GET_DeleteManagedPrefixList
- description: Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteManagedPrefixListResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PrefixListId
- in: query
- required: true
- description: The ID of the prefix list.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteManagedPrefixList
- operationId: POST_DeleteManagedPrefixList
- description: Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteManagedPrefixListResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteManagedPrefixListRequest'
- parameters: []
- /?Action=DeleteNatGateway&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteNatGateway
- operationId: GET_DeleteNatGateway
- description: 'Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNatGatewayResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NatGatewayId
- in: query
- required: true
- description: The ID of the NAT gateway.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteNatGateway
- operationId: POST_DeleteNatGateway
- description: 'Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNatGatewayResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNatGatewayRequest'
- parameters: []
- /?Action=DeleteNetworkAcl&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteNetworkAcl
- operationId: GET_DeleteNetworkAcl
- description: Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
- responses:
- '200':
- description: Success
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NetworkAclId
- in: query
- required: true
- description: The ID of the network ACL.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteNetworkAcl
- operationId: POST_DeleteNetworkAcl
- description: Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkAclRequest'
- parameters: []
- /?Action=DeleteNetworkAclEntry&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteNetworkAclEntry
- operationId: GET_DeleteNetworkAclEntry
- description: Deletes the specified ingress or egress entry (rule) from the specified network ACL.
- responses:
- '200':
- description: Success
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Egress
- in: query
- required: true
- description: Indicates whether the rule is an egress rule.
- schema:
- type: boolean
- - name: NetworkAclId
- in: query
- required: true
- description: The ID of the network ACL.
- schema:
- type: string
- - name: RuleNumber
- in: query
- required: true
- description: The rule number of the entry to delete.
- schema:
- type: integer
- 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'
- post:
- x-aws-operation-name: DeleteNetworkAclEntry
- operationId: POST_DeleteNetworkAclEntry
- description: Deletes the specified ingress or egress entry (rule) from the specified network ACL.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkAclEntryRequest'
- parameters: []
- /?Action=DeleteNetworkInsightsAccessScope&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteNetworkInsightsAccessScope
- operationId: GET_DeleteNetworkInsightsAccessScope
- description: Deletes the specified Network Access Scope.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NetworkInsightsAccessScopeId
- in: query
- required: true
- description: The ID of the Network Access Scope.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteNetworkInsightsAccessScope
- operationId: POST_DeleteNetworkInsightsAccessScope
- description: Deletes the specified Network Access Scope.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeRequest'
- parameters: []
- /?Action=DeleteNetworkInsightsAccessScopeAnalysis&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteNetworkInsightsAccessScopeAnalysis
- operationId: GET_DeleteNetworkInsightsAccessScopeAnalysis
- description: Deletes the specified Network Access Scope analysis.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeAnalysisResult'
- parameters:
- - name: NetworkInsightsAccessScopeAnalysisId
- in: query
- required: true
- description: The ID of the Network Access Scope analysis.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteNetworkInsightsAccessScopeAnalysis
- operationId: POST_DeleteNetworkInsightsAccessScopeAnalysis
- description: Deletes the specified Network Access Scope analysis.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeAnalysisResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeAnalysisRequest'
- parameters: []
- /?Action=DeleteNetworkInsightsAnalysis&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteNetworkInsightsAnalysis
- operationId: GET_DeleteNetworkInsightsAnalysis
- description: Deletes the specified network insights analysis.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInsightsAnalysisResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NetworkInsightsAnalysisId
- in: query
- required: true
- description: The ID of the network insights analysis.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteNetworkInsightsAnalysis
- operationId: POST_DeleteNetworkInsightsAnalysis
- description: Deletes the specified network insights analysis.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInsightsAnalysisResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInsightsAnalysisRequest'
- parameters: []
- /?Action=DeleteNetworkInsightsPath&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteNetworkInsightsPath
- operationId: GET_DeleteNetworkInsightsPath
- description: Deletes the specified path.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInsightsPathResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NetworkInsightsPathId
- in: query
- required: true
- description: The ID of the path.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteNetworkInsightsPath
- operationId: POST_DeleteNetworkInsightsPath
- description: Deletes the specified path.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInsightsPathResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInsightsPathRequest'
- parameters: []
- /?Action=DeleteNetworkInterface&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteNetworkInterface
- operationId: GET_DeleteNetworkInterface
- description: Deletes the specified network interface. You must detach the network interface before you can delete it.
- responses:
- '200':
- description: Success
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NetworkInterfaceId
- in: query
- required: true
- description: The ID of the network interface.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteNetworkInterface
- operationId: POST_DeleteNetworkInterface
- description: Deletes the specified network interface. You must detach the network interface before you can delete it.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInterfaceRequest'
- parameters: []
- /?Action=DeleteNetworkInterfacePermission&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteNetworkInterfacePermission
- operationId: GET_DeleteNetworkInterfacePermission
- description: 'Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you''re removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInterfacePermissionResult'
- parameters:
- - name: NetworkInterfacePermissionId
- in: query
- required: true
- description: The ID of the network interface permission.
- schema:
- type: string
- - name: Force
- in: query
- required: false
- description: Specify true to remove the permission even if the network interface is attached to an instance.
- schema:
- type: boolean
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteNetworkInterfacePermission
- operationId: POST_DeleteNetworkInterfacePermission
- description: 'Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you''re removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInterfacePermissionResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteNetworkInterfacePermissionRequest'
- parameters: []
- /?Action=DeletePlacementGroup&Version=2016-11-15:
- get:
- x-aws-operation-name: DeletePlacementGroup
- operationId: GET_DeletePlacementGroup
- description: 'Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide.'
- responses:
- '200':
- description: Success
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: GroupName
- in: query
- required: true
- description: The name of the placement group.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeletePlacementGroup
- operationId: POST_DeletePlacementGroup
- description: 'Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide.'
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeletePlacementGroupRequest'
- parameters: []
- /?Action=DeletePublicIpv4Pool&Version=2016-11-15:
- get:
- x-aws-operation-name: DeletePublicIpv4Pool
- operationId: GET_DeletePublicIpv4Pool
- description: 'Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeletePublicIpv4PoolResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PoolId
- in: query
- required: true
- description: The ID of the public IPv4 pool you want to delete.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeletePublicIpv4Pool
- operationId: POST_DeletePublicIpv4Pool
- description: 'Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeletePublicIpv4PoolResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeletePublicIpv4PoolRequest'
- parameters: []
- /?Action=DeleteQueuedReservedInstances&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteQueuedReservedInstances
- operationId: GET_DeleteQueuedReservedInstances
- description: Deletes the queued purchases for the specified Reserved Instances.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteQueuedReservedInstancesResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ReservedInstancesId
- in: query
- required: true
- description: The IDs of the Reserved Instances.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservationId'
- - xml:
- name: item
- minItems: 1
- maxItems: 100
- 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'
- post:
- x-aws-operation-name: DeleteQueuedReservedInstances
- operationId: POST_DeleteQueuedReservedInstances
- description: Deletes the queued purchases for the specified Reserved Instances.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteQueuedReservedInstancesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteQueuedReservedInstancesRequest'
- parameters: []
- /?Action=DeleteRoute&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteRoute
- operationId: GET_DeleteRoute
- description: Deletes the specified route from the specified route table.
- responses:
- '200':
- description: Success
- parameters:
- - name: DestinationCidrBlock
- in: query
- required: false
- description: The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
- schema:
- type: string
- - name: DestinationIpv6CidrBlock
- in: query
- required: false
- description: The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
- schema:
- type: string
- - name: DestinationPrefixListId
- in: query
- required: false
- description: The ID of the prefix list for the route.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: RouteTableId
- in: query
- required: true
- description: The ID of the route table.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteRoute
- operationId: POST_DeleteRoute
- description: Deletes the specified route from the specified route table.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteRouteRequest'
- parameters: []
- /?Action=DeleteRouteTable&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteRouteTable
- operationId: GET_DeleteRouteTable
- description: Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
- responses:
- '200':
- description: Success
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: RouteTableId
- in: query
- required: true
- description: The ID of the route table.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteRouteTable
- operationId: POST_DeleteRouteTable
- description: Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteRouteTableRequest'
- parameters: []
- /?Action=DeleteSecurityGroup&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteSecurityGroup
- operationId: GET_DeleteSecurityGroup
- description: 'Deletes a security group.
If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteSecurityGroup
- operationId: POST_DeleteSecurityGroup
- description: 'Deletes a security group.
If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.
Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Delete an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - parameters: - - name: SnapshotId - in: query - required: true - description: The ID of the EBS snapshot. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteSnapshot
- operationId: POST_DeleteSnapshot
- description: 'Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Delete an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSnapshotRequest' - parameters: [] - /?Action=DeleteSpotDatafeedSubscription&Version=2016-11-15: - get: - x-aws-operation-name: DeleteSpotDatafeedSubscription - operationId: GET_DeleteSpotDatafeedSubscription - description: Deletes the data feed for Spot Instances. - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteSpotDatafeedSubscription
- operationId: POST_DeleteSpotDatafeedSubscription
- description: Deletes the data feed for Spot Instances.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteSpotDatafeedSubscriptionRequest'
- parameters: []
- /?Action=DeleteSubnet&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteSubnet
- operationId: GET_DeleteSubnet
- description: Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
- responses:
- '200':
- description: Success
- parameters:
- - name: SubnetId
- in: query
- required: true
- description: The ID of the subnet.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteSubnet
- operationId: POST_DeleteSubnet
- description: Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteSubnetRequest'
- parameters: []
- /?Action=DeleteSubnetCidrReservation&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteSubnetCidrReservation
- operationId: GET_DeleteSubnetCidrReservation
- description: Deletes a subnet CIDR reservation.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteSubnetCidrReservationResult'
- parameters:
- - name: SubnetCidrReservationId
- in: query
- required: true
- description: The ID of the subnet CIDR reservation.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteSubnetCidrReservation
- operationId: POST_DeleteSubnetCidrReservation
- description: Deletes a subnet CIDR reservation.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteSubnetCidrReservationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteSubnetCidrReservationRequest'
- parameters: []
- /?Action=DeleteTags&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteTags
- operationId: GET_DeleteTags
- description: 'Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ResourceId
- in: query
- required: true
- description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' - schema: - type: array - items: - $ref: '#/components/schemas/TaggableResourceId' - - name: Tag - in: query - required: false - description: 'The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.
If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).
Constraints: Up to 1000 tags.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: item - 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' - post: - x-aws-operation-name: DeleteTags - operationId: POST_DeleteTags - description: 'Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTagsRequest' - parameters: [] - /?Action=DeleteTrafficMirrorFilter&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTrafficMirrorFilter - operationId: GET_DeleteTrafficMirrorFilter - description:Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorFilterResult' - parameters: - - name: TrafficMirrorFilterId - in: query - required: true - description: The ID of the Traffic Mirror filter. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTrafficMirrorFilter
- operationId: POST_DeleteTrafficMirrorFilter
- description: Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorFilterResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorFilterRequest' - parameters: [] - /?Action=DeleteTrafficMirrorFilterRule&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTrafficMirrorFilterRule - operationId: GET_DeleteTrafficMirrorFilterRule - description: Deletes the specified Traffic Mirror rule. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleResult' - parameters: - - name: TrafficMirrorFilterRuleId - in: query - required: true - description: The ID of the Traffic Mirror rule. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTrafficMirrorFilterRule
- operationId: POST_DeleteTrafficMirrorFilterRule
- description: Deletes the specified Traffic Mirror rule.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleRequest'
- parameters: []
- /?Action=DeleteTrafficMirrorSession&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteTrafficMirrorSession
- operationId: GET_DeleteTrafficMirrorSession
- description: Deletes the specified Traffic Mirror session.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTrafficMirrorSessionResult'
- parameters:
- - name: TrafficMirrorSessionId
- in: query
- required: true
- description: The ID of the Traffic Mirror session.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTrafficMirrorSession
- operationId: POST_DeleteTrafficMirrorSession
- description: Deletes the specified Traffic Mirror session.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTrafficMirrorSessionResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTrafficMirrorSessionRequest'
- parameters: []
- /?Action=DeleteTrafficMirrorTarget&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteTrafficMirrorTarget
- operationId: GET_DeleteTrafficMirrorTarget
- description: Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorTargetResult' - parameters: - - name: TrafficMirrorTargetId - in: query - required: true - description: The ID of the Traffic Mirror target. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTrafficMirrorTarget
- operationId: POST_DeleteTrafficMirrorTarget
- description: Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorTargetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorTargetRequest' - parameters: [] - /?Action=DeleteTransitGateway&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTransitGateway - operationId: GET_DeleteTransitGateway - description: Deletes the specified transit gateway. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayResult' - parameters: - - name: TransitGatewayId - in: query - required: true - description: The ID of the transit gateway. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTransitGateway
- operationId: POST_DeleteTransitGateway
- description: Deletes the specified transit gateway.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayRequest'
- parameters: []
- /?Action=DeleteTransitGatewayConnect&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteTransitGatewayConnect
- operationId: GET_DeleteTransitGatewayConnect
- description: Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayConnectResult'
- parameters:
- - name: TransitGatewayAttachmentId
- in: query
- required: true
- description: The ID of the Connect attachment.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTransitGatewayConnect
- operationId: POST_DeleteTransitGatewayConnect
- description: Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayConnectResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayConnectRequest'
- parameters: []
- /?Action=DeleteTransitGatewayConnectPeer&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteTransitGatewayConnectPeer
- operationId: GET_DeleteTransitGatewayConnectPeer
- description: Deletes the specified Connect peer.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayConnectPeerResult'
- parameters:
- - name: TransitGatewayConnectPeerId
- in: query
- required: true
- description: The ID of the Connect peer.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTransitGatewayConnectPeer
- operationId: POST_DeleteTransitGatewayConnectPeer
- description: Deletes the specified Connect peer.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayConnectPeerResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayConnectPeerRequest'
- parameters: []
- /?Action=DeleteTransitGatewayMulticastDomain&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteTransitGatewayMulticastDomain
- operationId: GET_DeleteTransitGatewayMulticastDomain
- description: Deletes the specified transit gateway multicast domain.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainResult'
- parameters:
- - name: TransitGatewayMulticastDomainId
- in: query
- required: true
- description: The ID of the transit gateway multicast domain.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTransitGatewayMulticastDomain
- operationId: POST_DeleteTransitGatewayMulticastDomain
- description: Deletes the specified transit gateway multicast domain.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainRequest'
- parameters: []
- /?Action=DeleteTransitGatewayPeeringAttachment&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteTransitGatewayPeeringAttachment
- operationId: GET_DeleteTransitGatewayPeeringAttachment
- description: Deletes a transit gateway peering attachment.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentResult'
- parameters:
- - name: TransitGatewayAttachmentId
- in: query
- required: true
- description: The ID of the transit gateway peering attachment.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTransitGatewayPeeringAttachment
- operationId: POST_DeleteTransitGatewayPeeringAttachment
- description: Deletes a transit gateway peering attachment.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentRequest'
- parameters: []
- /?Action=DeleteTransitGatewayPrefixListReference&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteTransitGatewayPrefixListReference
- operationId: GET_DeleteTransitGatewayPrefixListReference
- description: Deletes a reference (route) to a prefix list in a specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceResult'
- parameters:
- - name: TransitGatewayRouteTableId
- in: query
- required: true
- description: The ID of the route table.
- schema:
- type: string
- - name: PrefixListId
- in: query
- required: true
- description: The ID of the prefix list.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTransitGatewayPrefixListReference
- operationId: POST_DeleteTransitGatewayPrefixListReference
- description: Deletes a reference (route) to a prefix list in a specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceRequest'
- parameters: []
- /?Action=DeleteTransitGatewayRoute&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteTransitGatewayRoute
- operationId: GET_DeleteTransitGatewayRoute
- description: Deletes the specified route from the specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayRouteResult'
- parameters:
- - name: TransitGatewayRouteTableId
- in: query
- required: true
- description: The ID of the transit gateway route table.
- schema:
- type: string
- - name: DestinationCidrBlock
- in: query
- required: true
- description: The CIDR range for the route. This must match the CIDR for the route exactly.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTransitGatewayRoute
- operationId: POST_DeleteTransitGatewayRoute
- description: Deletes the specified route from the specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayRouteResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayRouteRequest'
- parameters: []
- /?Action=DeleteTransitGatewayRouteTable&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteTransitGatewayRouteTable
- operationId: GET_DeleteTransitGatewayRouteTable
- description: Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayRouteTableResult'
- parameters:
- - name: TransitGatewayRouteTableId
- in: query
- required: true
- description: The ID of the transit gateway route table.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTransitGatewayRouteTable
- operationId: POST_DeleteTransitGatewayRouteTable
- description: Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayRouteTableResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayRouteTableRequest'
- parameters: []
- /?Action=DeleteTransitGatewayVpcAttachment&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteTransitGatewayVpcAttachment
- operationId: GET_DeleteTransitGatewayVpcAttachment
- description: Deletes the specified VPC attachment.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentResult'
- parameters:
- - name: TransitGatewayAttachmentId
- in: query
- required: true
- description: The ID of the attachment.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteTransitGatewayVpcAttachment
- operationId: POST_DeleteTransitGatewayVpcAttachment
- description: Deletes the specified VPC attachment.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentRequest'
- parameters: []
- /?Action=DeleteVolume&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteVolume
- operationId: GET_DeleteVolume
- description: 'Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).
The volume can remain in the deleting state for several minutes.
For more information, see Delete an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - parameters: - - name: VolumeId - in: query - required: true - description: The ID of the volume. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteVolume
- operationId: POST_DeleteVolume
- description: 'Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).
The volume can remain in the deleting state for several minutes.
For more information, see Delete an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVolumeRequest' - parameters: [] - /?Action=DeleteVpc&Version=2016-11-15: - get: - x-aws-operation-name: DeleteVpc - operationId: GET_DeleteVpc - description: 'Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.' - responses: - '200': - description: Success - parameters: - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteVpc
- operationId: POST_DeleteVpc
- description: 'Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.'
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteVpcRequest'
- parameters: []
- /?Action=DeleteVpcEndpointConnectionNotifications&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteVpcEndpointConnectionNotifications
- operationId: GET_DeleteVpcEndpointConnectionNotifications
- description: Deletes one or more VPC endpoint connection notifications.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ConnectionNotificationId
- in: query
- required: true
- description: One or more notification IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ConnectionNotificationId'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: DeleteVpcEndpointConnectionNotifications
- operationId: POST_DeleteVpcEndpointConnectionNotifications
- description: Deletes one or more VPC endpoint connection notifications.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsRequest'
- parameters: []
- /?Action=DeleteVpcEndpointServiceConfigurations&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteVpcEndpointServiceConfigurations
- operationId: GET_DeleteVpcEndpointServiceConfigurations
- description: 'Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ServiceId
- in: query
- required: true
- description: The IDs of one or more services.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointServiceId'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: DeleteVpcEndpointServiceConfigurations
- operationId: POST_DeleteVpcEndpointServiceConfigurations
- description: 'Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsRequest'
- parameters: []
- /?Action=DeleteVpcEndpoints&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteVpcEndpoints
- operationId: GET_DeleteVpcEndpoints
- description: 'Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.
Gateway endpoint,
Gateway Load Balancer endpoint,
Interface endpoint
The following rules apply when you delete a VPC endpoint:
When you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint.
When you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces.
You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.
When you delete an interface endpoint, we delete the endpoint network interfaces.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcEndpointId
- in: query
- required: true
- description: One or more VPC endpoint IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointId'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: DeleteVpcEndpoints
- operationId: POST_DeleteVpcEndpoints
- description: 'Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.
Gateway endpoint,
Gateway Load Balancer endpoint,
Interface endpoint
The following rules apply when you delete a VPC endpoint:
When you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint.
When you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces.
You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.
When you delete an interface endpoint, we delete the endpoint network interfaces.
active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteVpcPeeringConnectionResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcPeeringConnectionId
- in: query
- required: true
- description: The ID of the VPC peering connection.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeleteVpcPeeringConnection
- operationId: POST_DeleteVpcPeeringConnection
- description: Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteVpcPeeringConnectionResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteVpcPeeringConnectionRequest'
- parameters: []
- /?Action=DeleteVpnConnection&Version=2016-11-15:
- get:
- x-aws-operation-name: DeleteVpnConnection
- operationId: GET_DeleteVpnConnection
- description: 'Deletes the specified VPN connection.
If you''re deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.
For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection.
' - responses: - '200': - description: Success - parameters: - - name: VpnConnectionId - in: query - required: true - description: The ID of the VPN connection. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteVpnConnection
- operationId: POST_DeleteVpnConnection
- description: 'Deletes the specified VPN connection.
If you''re deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.
For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpnConnectionRequest' - parameters: [] - /?Action=DeleteVpnConnectionRoute&Version=2016-11-15: - get: - x-aws-operation-name: DeleteVpnConnectionRoute - operationId: GET_DeleteVpnConnectionRoute - description: Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. - responses: - '200': - description: Success - parameters: - - name: DestinationCidrBlock - in: query - required: true - description: The CIDR block associated with the local subnet of the customer network. - schema: - type: string - - name: VpnConnectionId - in: query - required: true - description: The ID of the VPN connection. - schema: - type: string - 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' - post: - x-aws-operation-name: DeleteVpnConnectionRoute - operationId: POST_DeleteVpnConnectionRoute - description: Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpnConnectionRouteRequest' - parameters: [] - /?Action=DeleteVpnGateway&Version=2016-11-15: - get: - x-aws-operation-name: DeleteVpnGateway - operationId: GET_DeleteVpnGateway - description: Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. - responses: - '200': - description: Success - parameters: - - name: VpnGatewayId - in: query - required: true - description: The ID of the virtual private gateway. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeleteVpnGateway
- operationId: POST_DeleteVpnGateway
- description: Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeleteVpnGatewayRequest'
- parameters: []
- /?Action=DeprovisionByoipCidr&Version=2016-11-15:
- get:
- x-aws-operation-name: DeprovisionByoipCidr
- operationId: GET_DeprovisionByoipCidr
- description: 'Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionByoipCidrResult' - parameters: - - name: Cidr - in: query - required: true - description: 'The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeprovisionByoipCidr
- operationId: POST_DeprovisionByoipCidr
- description: 'Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionByoipCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionByoipCidrRequest' - parameters: [] - /?Action=DeprovisionIpamPoolCidr&Version=2016-11-15: - get: - x-aws-operation-name: DeprovisionIpamPoolCidr - operationId: GET_DeprovisionIpamPoolCidr - description: 'Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionIpamPoolCidrResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamPoolId
- in: query
- required: true
- description: The ID of the pool that has the CIDR you want to deprovision.
- schema:
- type: string
- - name: Cidr
- in: query
- required: false
- description: The CIDR which you want to deprovision from the pool.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeprovisionIpamPoolCidr
- operationId: POST_DeprovisionIpamPoolCidr
- description: 'Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeprovisionIpamPoolCidrResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeprovisionIpamPoolCidrRequest'
- parameters: []
- /?Action=DeprovisionPublicIpv4PoolCidr&Version=2016-11-15:
- get:
- x-aws-operation-name: DeprovisionPublicIpv4PoolCidr
- operationId: GET_DeprovisionPublicIpv4PoolCidr
- description: Deprovision a CIDR from a public IPv4 pool.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeprovisionPublicIpv4PoolCidrResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PoolId
- in: query
- required: true
- description: The ID of the pool that you want to deprovision the CIDR from.
- schema:
- type: string
- - name: Cidr
- in: query
- required: true
- description: The CIDR you want to deprovision from the pool.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DeprovisionPublicIpv4PoolCidr
- operationId: POST_DeprovisionPublicIpv4PoolCidr
- description: Deprovision a CIDR from a public IPv4 pool.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeprovisionPublicIpv4PoolCidrResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeprovisionPublicIpv4PoolCidrRequest'
- parameters: []
- /?Action=DeregisterImage&Version=2016-11-15:
- get:
- x-aws-operation-name: DeregisterImage
- operationId: GET_DeregisterImage
- description: 'Deregisters the specified AMI. After you deregister an AMI, it can''t be used to launch new instances.
If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
When you deregister an AMI, it doesn''t affect any instances that you''ve already launched from the AMI. You''ll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn''t affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn''t affect the files that you uploaded to Amazon S3 when you created the AMI.
' - responses: - '200': - description: Success - parameters: - - name: ImageId - in: query - required: true - description: The ID of the AMI. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeregisterImage
- operationId: POST_DeregisterImage
- description: 'Deregisters the specified AMI. After you deregister an AMI, it can''t be used to launch new instances.
If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
When you deregister an AMI, it doesn''t affect any instances that you''ve already launched from the AMI. You''ll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn''t affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn''t affect the files that you uploaded to Amazon S3 when you created the AMI.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeregisterImageRequest' - parameters: [] - /?Action=DeregisterInstanceEventNotificationAttributes&Version=2016-11-15: - get: - x-aws-operation-name: DeregisterInstanceEventNotificationAttributes - operationId: GET_DeregisterInstanceEventNotificationAttributes - description: Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeregisterInstanceEventNotificationAttributesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceTagAttribute
- in: query
- required: false
- description: Information about the tag keys to deregister.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to deregister all tag keys in the current Region. Specify false to deregister all tag keys.
- InstanceTagKey:
- allOf:
- - $ref: '#/components/schemas/InstanceTagKeySet'
- - description: Information about the tag keys to deregister.
- description: Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
- 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'
- post:
- x-aws-operation-name: DeregisterInstanceEventNotificationAttributes
- operationId: POST_DeregisterInstanceEventNotificationAttributes
- description: Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeregisterInstanceEventNotificationAttributesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeregisterInstanceEventNotificationAttributesRequest'
- parameters: []
- /?Action=DeregisterTransitGatewayMulticastGroupMembers&Version=2016-11-15:
- get:
- x-aws-operation-name: DeregisterTransitGatewayMulticastGroupMembers
- operationId: GET_DeregisterTransitGatewayMulticastGroupMembers
- description: Deregisters the specified members (network interfaces) from the transit gateway multicast group.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupMembersResult'
- parameters:
- - name: TransitGatewayMulticastDomainId
- in: query
- required: false
- description: The ID of the transit gateway multicast domain.
- schema:
- type: string
- - name: GroupIpAddress
- in: query
- required: false
- description: The IP address assigned to the transit gateway multicast group.
- schema:
- type: string
- - name: NetworkInterfaceIds
- in: query
- required: false
- description: The IDs of the group members' network interfaces.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceId'
- - xml:
- name: item
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeregisterTransitGatewayMulticastGroupMembers
- operationId: POST_DeregisterTransitGatewayMulticastGroupMembers
- description: Deregisters the specified members (network interfaces) from the transit gateway multicast group.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupMembersResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupMembersRequest'
- parameters: []
- /?Action=DeregisterTransitGatewayMulticastGroupSources&Version=2016-11-15:
- get:
- x-aws-operation-name: DeregisterTransitGatewayMulticastGroupSources
- operationId: GET_DeregisterTransitGatewayMulticastGroupSources
- description: Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupSourcesResult'
- parameters:
- - name: TransitGatewayMulticastDomainId
- in: query
- required: false
- description: The ID of the transit gateway multicast domain.
- schema:
- type: string
- - name: GroupIpAddress
- in: query
- required: false
- description: The IP address assigned to the transit gateway multicast group.
- schema:
- type: string
- - name: NetworkInterfaceIds
- in: query
- required: false
- description: The IDs of the group sources' network interfaces.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceId'
- - xml:
- name: item
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DeregisterTransitGatewayMulticastGroupSources
- operationId: POST_DeregisterTransitGatewayMulticastGroupSources
- description: Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupSourcesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupSourcesRequest'
- parameters: []
- /?Action=DescribeAccountAttributes&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeAccountAttributes
- operationId: GET_DescribeAccountAttributes
- description: 'Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.
default-vpc: The ID of the default VPC for your account, or none.
max-instances: This attribute is no longer supported. The returned value does not reflect your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide.
vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.
max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.
vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeAccountAttributes
- operationId: POST_DescribeAccountAttributes
- description: 'Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.
default-vpc: The ID of the default VPC for your account, or none.
max-instances: This attribute is no longer supported. The returned value does not reflect your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide.
vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.
max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.
vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.
Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAddressesResult' - parameters: - - name: Filter - in: query - required: false - description: 'One or more filters. Filter names and values are case-sensitive.
allocation-id - [EC2-VPC] The allocation ID for the address.
association-id - [EC2-VPC] The association ID for the address.
domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).
instance-id - The ID of the instance the address is associated with, if any.
network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The Amazon Web Services account ID of the owner.
private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: PublicIp - - name: AllocationId - in: query - required: false - description: '[EC2-VPC] Information about the allocation IDs.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/AllocationId' - - xml: - name: AllocationId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeAddresses
- operationId: POST_DescribeAddresses
- description: 'Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAddressesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAddressesRequest' - parameters: [] - /?Action=DescribeAddressesAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeAddressesAttribute - operationId: GET_DescribeAddressesAttribute - description: 'Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAddressesAttributeResult' - parameters: - - name: AllocationId - in: query - required: false - description: '[EC2-VPC] The allocation IDs.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/AllocationId' - - xml: - name: item - - name: Attribute - in: query - required: false - description: The attribute of the IP address. - schema: - type: string - enum: - - domain-name - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 1000
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeAddressesAttribute
- operationId: POST_DescribeAddressesAttribute
- description: 'Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeAddressesAttributeResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeAddressesAttributeRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeAggregateIdFormat&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeAggregateIdFormat
- operationId: GET_DescribeAggregateIdFormat
- description: 'Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeAggregateIdFormat
- operationId: POST_DescribeAggregateIdFormat
- description: 'Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.
For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAvailabilityZonesResult' - parameters: - - name: Filter - in: query - required: false - description: 'The filters.
group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
message - The Zone message.
opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required).
parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name - The name of the Region for the Zone (for example, us-east-1).
state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available).
zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
' - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeAvailabilityZones
- operationId: POST_DescribeAvailabilityZones
- description: 'Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.
For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAvailabilityZonesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAvailabilityZonesRequest' - parameters: [] - /?Action=DescribeBundleTasks&Version=2016-11-15: - get: - x-aws-operation-name: DescribeBundleTasks - operationId: GET_DescribeBundleTasks - description: 'Describes the specified bundle tasks or all of your bundle tasks.
Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.
The bundle task IDs.
Default: Describes all your bundle tasks.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/BundleId' - - xml: - name: BundleId - - name: Filter - in: query - required: false - description: 'The filters.
bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeBundleTasks
- operationId: POST_DescribeBundleTasks
- description: 'Describes the specified bundle tasks or all of your bundle tasks.
Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.
Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.
To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeByoipCidrsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: MaxResults
- in: query
- required: true
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 100
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeByoipCidrs
- operationId: POST_DescribeByoipCidrs
- description: 'Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.
To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeByoipCidrsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeByoipCidrsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeCapacityReservationFleets&Version=2016-11-15: - get: - x-aws-operation-name: DescribeCapacityReservationFleets - operationId: GET_DescribeCapacityReservationFleets - description: Describes one or more Capacity Reservation Fleets. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCapacityReservationFleetsResult' - parameters: - - name: CapacityReservationFleetId - in: query - required: false - description: The IDs of the Capacity Reservation Fleets to describe. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token to use to retrieve the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returnednextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
- schema:
- type: integer
- minimum: 1
- maximum: 100
- - name: Filter
- in: query
- required: false
- description: One or more filters.
state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).
instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
tenancy - The tenancy of the Fleet (default | dedicated).
allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeCapacityReservationFleets
- operationId: POST_DescribeCapacityReservationFleets
- description: Describes one or more Capacity Reservation Fleets.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeCapacityReservationFleetsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeCapacityReservationFleetsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeCapacityReservations&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeCapacityReservations
- operationId: GET_DescribeCapacityReservations
- description: Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeCapacityReservationsResult'
- parameters:
- - name: CapacityReservationId
- in: query
- required: false
- description: The ID of the Capacity Reservation.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationId'
- - xml:
- name: item
- - name: NextToken
- in: query
- required: false
- description: The token to use to retrieve the next page of results.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
- schema:
- type: integer
- minimum: 1
- maximum: 1000
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
instance-type - The type of instance for which the Capacity Reservation reserves capacity.
owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
availability-zone - The Availability Zone of the Capacity Reservation.
tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active- The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
start-date - The date and time at which the Capacity Reservation was started.
end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.
end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeCapacityReservations
- operationId: POST_DescribeCapacityReservations
- description: Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeCapacityReservationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeCapacityReservationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeCarrierGateways&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeCarrierGateways
- operationId: GET_DescribeCarrierGateways
- description: Describes one or more of your carrier gateways.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeCarrierGatewaysResult'
- parameters:
- - name: CarrierGatewayId
- in: query
- required: false
- description: One or more carrier gateway IDs.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/CarrierGatewayId'
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
carrier-gateway-id - The ID of the carrier gateway.
state - The state of the carrier gateway (pending | failed | available | deleting | deleted).
owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC associated with the carrier gateway.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeCarrierGateways
- operationId: POST_DescribeCarrierGateways
- description: Describes one or more of your carrier gateways.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeCarrierGatewaysResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeCarrierGatewaysRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeClassicLinkInstances&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeClassicLinkInstances
- operationId: GET_DescribeClassicLinkInstances
- description: Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeClassicLinkInstancesResult'
- parameters:
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
group-id - The ID of a VPC security group that''s associated with the instance.
instance-id - The ID of the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
vpc-id - The ID of the VPC that the instance is linked to.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceId
- in: query
- required: false
- description: One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - xml:
- name: InstanceId
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Constraint: If the value is greater than 1000, we return only 1000 items.
' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - 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' - post: - x-aws-operation-name: DescribeClassicLinkInstances - operationId: POST_DescribeClassicLinkInstances - description: Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClassicLinkInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClassicLinkInstancesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeClientVpnAuthorizationRules&Version=2016-11-15: - get: - x-aws-operation-name: DescribeClientVpnAuthorizationRules - operationId: GET_DescribeClientVpnAuthorizationRules - description: Describes the authorization rules for a specified Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnAuthorizationRulesResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NextToken
- in: query
- required: false
- description: The token to retrieve the next page of results.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: One or more filters. Filter names and values are case-sensitive.
description - The description of the authorization rule.
destination-cidr - The CIDR of the network to which the authorization rule applies.
group-id - The ID of the Active Directory group to which the authorization rule grants access.
One or more filters. Filter names and values are case-sensitive.
connection-id - The ID of the connection.
username - For Active Directory client authentication, the user name of the client who established the client connection.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeClientVpnConnections
- operationId: POST_DescribeClientVpnConnections
- description: Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeClientVpnConnectionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeClientVpnConnectionsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeClientVpnEndpoints&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeClientVpnEndpoints
- operationId: GET_DescribeClientVpnEndpoints
- description: Describes one or more Client VPN endpoints in the account.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeClientVpnEndpointsResult'
- parameters:
- - name: ClientVpnEndpointId
- in: query
- required: false
- description: The ID of the Client VPN endpoint.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ClientVpnEndpointId'
- - xml:
- name: item
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token to retrieve the next page of results.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: One or more filters. Filter names and values are case-sensitive.
endpoint-id - The ID of the Client VPN endpoint.
transport-protocol - The transport protocol (tcp | udp).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeClientVpnEndpoints
- operationId: POST_DescribeClientVpnEndpoints
- description: Describes one or more Client VPN endpoints in the account.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeClientVpnEndpointsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeClientVpnEndpointsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeClientVpnRoutes&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeClientVpnRoutes
- operationId: GET_DescribeClientVpnRoutes
- description: Describes the routes for the specified Client VPN endpoint.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeClientVpnRoutesResult'
- parameters:
- - name: ClientVpnEndpointId
- in: query
- required: true
- description: The ID of the Client VPN endpoint.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: One or more filters. Filter names and values are case-sensitive.
destination-cidr - The CIDR of the route destination.
origin - How the route was associated with the Client VPN endpoint (associate | add-route).
target-subnet - The ID of the subnet through which traffic is routed.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeClientVpnRoutes
- operationId: POST_DescribeClientVpnRoutes
- description: Describes the routes for the specified Client VPN endpoint.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeClientVpnRoutesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeClientVpnRoutesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeClientVpnTargetNetworks&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeClientVpnTargetNetworks
- operationId: GET_DescribeClientVpnTargetNetworks
- description: Describes the target networks associated with the specified Client VPN endpoint.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeClientVpnTargetNetworksResult'
- parameters:
- - name: ClientVpnEndpointId
- in: query
- required: true
- description: The ID of the Client VPN endpoint.
- schema:
- type: string
- - name: AssociationIds
- in: query
- required: false
- description: The IDs of the target network associations.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token to retrieve the next page of results.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: One or more filters. Filter names and values are case-sensitive.
association-id - The ID of the association.
target-network-id - The ID of the subnet specified as the target network.
vpc-id - The ID of the VPC in which the target network is located.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeClientVpnTargetNetworks
- operationId: POST_DescribeClientVpnTargetNetworks
- description: Describes the target networks associated with the specified Client VPN endpoint.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeClientVpnTargetNetworksResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeClientVpnTargetNetworksRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeCoipPools&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeCoipPools
- operationId: GET_DescribeCoipPools
- description: Describes the specified customer-owned address pools or all of your customer-owned address pools.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeCoipPoolsResult'
- parameters:
- - name: PoolId
- in: query
- required: false
- description: The IDs of the address pools.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv4PoolCoipId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: One or more filters.
coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.
coip-pool.pool-id - The ID of the address pool.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeCoipPools
- operationId: POST_DescribeCoipPools
- description: Describes the specified customer-owned address pools or all of your customer-owned address pools.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeCoipPoolsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeCoipPoolsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeConversionTasks&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeConversionTasks
- operationId: GET_DescribeConversionTasks
- description: 'Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeConversionTasksResult' - parameters: - - name: ConversionTaskId - in: query - required: false - description: The conversion task IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ConversionTaskId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeConversionTasks
- operationId: POST_DescribeConversionTasks
- description: 'Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeConversionTasksResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeConversionTasksRequest' - parameters: [] - /?Action=DescribeCustomerGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeCustomerGateways - operationId: GET_DescribeCustomerGateways - description: 'Describes one or more of your VPN customer gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCustomerGatewaysResult' - parameters: - - name: CustomerGatewayId - in: query - required: false - description: 'One or more customer gateway IDs.
Default: Describes all your customer gateways.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/CustomerGatewayId' - - xml: - name: CustomerGatewayId - - name: Filter - in: query - required: false - description: 'One or more filters.
bgp-asn - The customer gateway''s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway''s Internet-routable external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeCustomerGateways
- operationId: POST_DescribeCustomerGateways
- description: 'Describes one or more of your VPN customer gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCustomerGatewaysResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCustomerGatewaysRequest' - parameters: [] - /?Action=DescribeDhcpOptions&Version=2016-11-15: - get: - x-aws-operation-name: DescribeDhcpOptions - operationId: GET_DescribeDhcpOptions - description: 'Describes one or more of your DHCP options sets.
For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeDhcpOptionsResult' - parameters: - - name: DhcpOptionsId - in: query - required: false - description: 'The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/DhcpOptionsId' - - xml: - name: DhcpOptionsId - - name: Filter - in: query - required: false - description: 'One or more filters.
dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- 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'
- post:
- x-aws-operation-name: DescribeDhcpOptions
- operationId: POST_DescribeDhcpOptions
- description: 'Describes one or more of your DHCP options sets.
For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeDhcpOptionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeDhcpOptionsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeEgressOnlyInternetGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeEgressOnlyInternetGateways - operationId: GET_DescribeEgressOnlyInternetGateways - description: Describes one or more of your egress-only internet gateways. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeEgressOnlyInternetGatewaysResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: EgressOnlyInternetGatewayId
- in: query
- required: false
- description: One or more egress-only internet gateway IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
- - xml:
- name: item
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 255
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'The filters.
availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides.
elastic-gpu-health - The status of the Elastic Graphics accelerator (OK | IMPAIRED).
elastic-gpu-state - The state of the Elastic Graphics accelerator (ATTACHED).
elastic-gpu-type - The type of Elastic Graphics accelerator; for example, eg1.medium.
instance-id - The ID of the instance to which the Elastic Graphics accelerator is associated.
NextToken value. This value can be between 5 and 1000.'
- schema:
- type: integer
- minimum: 10
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token to request the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeElasticGpus
- operationId: POST_DescribeElasticGpus
- description: 'Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeElasticGpusResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeElasticGpusRequest'
- parameters: []
- /?Action=DescribeExportImageTasks&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeExportImageTasks
- operationId: GET_DescribeExportImageTasks
- description: Describes the specified export image tasks or all of your export image tasks.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeExportImageTasksResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Filter'
- - xml:
- name: Filter
- - name: ExportImageTaskId
- in: query
- required: false
- description: The IDs of the export image tasks.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ExportImageTaskId'
- - xml:
- name: ExportImageTaskId
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of results to return in a single call.
- schema:
- type: integer
- minimum: 1
- maximum: 500
- - name: NextToken
- in: query
- required: false
- description: A token that indicates the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeExportImageTasks
- operationId: POST_DescribeExportImageTasks
- description: Describes the specified export image tasks or all of your export image tasks.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeExportImageTasksResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeExportImageTasksRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeExportTasks&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeExportTasks
- operationId: GET_DescribeExportTasks
- description: Describes the specified export instance tasks or all of your export instance tasks.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeExportTasksResult'
- parameters:
- - name: ExportTaskId
- in: query
- required: false
- description: The export task IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ExportTaskId'
- - xml:
- name: ExportTaskId
- - name: Filter
- in: query
- required: false
- description: the filters for the export tasks.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Filter'
- - xml:
- name: Filter
- 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'
- post:
- x-aws-operation-name: DescribeExportTasks
- operationId: POST_DescribeExportTasks
- description: Describes the specified export instance tasks or all of your export instance tasks.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeExportTasksResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeExportTasksRequest'
- parameters: []
- /?Action=DescribeFastLaunchImages&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeFastLaunchImages
- operationId: GET_DescribeFastLaunchImages
- description: Describe details for Windows AMIs that are configured for faster launching.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeFastLaunchImagesResult'
- parameters:
- - name: ImageId
- in: query
- required: false
- description: Details for one or more Windows AMI image IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImageId'
- - xml:
- name: ImageId
- - name: Filter
- in: query
- required: false
- description: Use the following filters to streamline results.
resource-type - The resource type for pre-provisioning.
launch-template - The launch template that is associated with the pre-provisioned Windows AMI.
owner-id - The owner ID for the pre-provisioning resource.
state - The current state of fast launching for the Windows AMI.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeFastLaunchImages
- operationId: POST_DescribeFastLaunchImages
- description: Describe details for Windows AMIs that are configured for faster launching.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeFastLaunchImagesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeFastLaunchImagesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeFastSnapshotRestores&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeFastSnapshotRestores
- operationId: GET_DescribeFastSnapshotRestores
- description: Describes the state of fast snapshot restores for your snapshots.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeFastSnapshotRestoresResult'
- parameters:
- - name: Filter
- in: query
- required: false
- description: 'The filters. The possible values are:
availability-zone: The Availability Zone of the snapshot.
owner-id: The ID of the Amazon Web Services account that enabled fast snapshot restore on the snapshot.
snapshot-id: The ID of the snapshot.
state: The state of fast snapshot restores for the snapshot (enabling | optimizing | enabled | disabling | disabled).
nextToken value.'
- schema:
- type: integer
- minimum: 0
- maximum: 200
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeFastSnapshotRestores
- operationId: POST_DescribeFastSnapshotRestores
- description: Describes the state of fast snapshot restores for your snapshots.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeFastSnapshotRestoresResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeFastSnapshotRestoresRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeFleetHistory&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeFleetHistory
- operationId: GET_DescribeFleetHistory
- description: 'Describes the events for the specified EC2 Fleet during the specified time.
EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetHistoryResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: EventType
- in: query
- required: false
- description: 'The type of events to describe. By default, all events are described.'
- schema:
- type: string
- enum:
- - instance-change
- - fleet-change
- - service-error
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token for the next set of results.
- schema:
- type: string
- - name: FleetId
- in: query
- required: true
- description: The ID of the EC2 Fleet.
- schema:
- type: string
- - name: StartTime
- in: query
- required: true
- description: 'The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- schema:
- type: string
- format: date-time
- 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'
- post:
- x-aws-operation-name: DescribeFleetHistory
- operationId: POST_DescribeFleetHistory
- description: 'Describes the events for the specified EC2 Fleet during the specified time.
EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetHistoryResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetHistoryRequest' - parameters: [] - /?Action=DescribeFleetInstances&Version=2016-11-15: - get: - x-aws-operation-name: DescribeFleetInstances - operationId: GET_DescribeFleetInstances - description: 'Describes the running instances for the specified EC2 Fleet.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetInstancesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token for the next set of results.
- schema:
- type: string
- - name: FleetId
- in: query
- required: true
- description: The ID of the EC2 Fleet.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: The filters.
instance-type - The instance type.
Describes the running instances for the specified EC2 Fleet.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetInstancesRequest' - parameters: [] - /?Action=DescribeFleets&Version=2016-11-15: - get: - x-aws-operation-name: DescribeFleets - operationId: GET_DescribeFleets - description: 'Describes the specified EC2 Fleets or all of your EC2 Fleets.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token for the next set of results.
- schema:
- type: string
- - name: FleetId
- in: query
- required: false
- description: 'The IDs of the EC2 Fleets.
If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.
The filters.
activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).
excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).
fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).
replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).
type - The type of request (instant | request | maintain).
Describes the specified EC2 Fleets or all of your EC2 Fleets.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeFlowLogs&Version=2016-11-15: - get: - x-aws-operation-name: DescribeFlowLogs - operationId: GET_DescribeFlowLogs - description: 'Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFlowLogsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).
log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and s3.
flow-log-id - The ID of the flow log.
log-group-name - The name of the log group.
resource-id - The ID of the VPC, subnet, or network interface.
traffic-type - The type of traffic (ACCEPT | REJECT | ALL).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcFlowLogId' - - xml: - name: item - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeFlowLogs
- operationId: POST_DescribeFlowLogs
- description: 'Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeFlowLogsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeFlowLogsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeFpgaImageAttribute&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeFpgaImageAttribute
- operationId: GET_DescribeFpgaImageAttribute
- description: Describes the specified attribute of the specified Amazon FPGA Image (AFI).
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeFpgaImageAttributeResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: FpgaImageId
- in: query
- required: true
- description: The ID of the AFI.
- schema:
- type: string
- - name: Attribute
- in: query
- required: true
- description: The AFI attribute.
- schema:
- type: string
- enum:
- - description
- - name
- - loadPermission
- - productCodes
- 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'
- post:
- x-aws-operation-name: DescribeFpgaImageAttribute
- operationId: POST_DescribeFpgaImageAttribute
- description: Describes the specified attribute of the specified Amazon FPGA Image (AFI).
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeFpgaImageAttributeResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeFpgaImageAttributeRequest'
- parameters: []
- /?Action=DescribeFpgaImages&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeFpgaImages
- operationId: GET_DescribeFpgaImages
- description: 'Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeFpgaImagesResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: FpgaImageId
- in: query
- required: false
- description: The AFI IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/FpgaImageId'
- - xml:
- name: item
- - name: Owner
- in: query
- required: false
- description: 'Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: Owner
- - name: Filter
- in: query
- required: false
- description: 'The filters.
create-time - The creation time of the AFI.
fpga-image-id - The FPGA image identifier (AFI ID).
fpga-image-global-id - The global FPGA image identifier (AGFI ID).
name - The name of the AFI.
owner-id - The Amazon Web Services account ID of the AFI owner.
product-code - The product code.
shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
state - The state of the AFI (pending | failed | available | unavailable).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
update-time - The time of the most recent update.
Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostReservationOfferingsResult' - parameters: - - name: Filter - in: query - required: false - description: 'The filters.
instance-family - The instance family of the offering (for example, m4).
payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
- schema:
- type: integer
- minimum: 5
- maximum: 500
- - name: MinDuration
- in: query
- required: false
- description: 'This is the minimum duration of the reservation you''d like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token to use to retrieve the next page of results.
- schema:
- type: string
- - name: OfferingId
- in: query
- required: false
- description: The ID of the reservation offering.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeHostReservationOfferings
- operationId: POST_DescribeHostReservationOfferings
- description: 'Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostReservationOfferingsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostReservationOfferingsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeHostReservations&Version=2016-11-15: - get: - x-aws-operation-name: DescribeHostReservations - operationId: GET_DescribeHostReservations - description: Describes reservations that are associated with Dedicated Hosts in your account. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostReservationsResult' - parameters: - - name: Filter - in: query - required: false - description: 'The filters.
instance-family - The instance family (for example, m4).
payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
state - The state of the reservation (payment-pending | payment-failed | active | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token to use to retrieve the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeHostReservations
- operationId: POST_DescribeHostReservations
- description: Describes reservations that are associated with Dedicated Hosts in your account.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeHostReservationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeHostReservationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeHosts&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeHosts
- operationId: GET_DescribeHosts
- description: Describes the specified Dedicated Hosts or all your Dedicated Hosts.
The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.
The filters.
auto-placement - Whether auto-placement is enabled or disabled (on | off).
availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you allocated the host.
host-reservation-id - The ID of the reservation assigned to this host.
instance-type - The instance type size that the Dedicated Host is configured to support.
state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to use to retrieve the next page of results. - schema: - type: string - 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' - post: - x-aws-operation-name: DescribeHosts - operationId: POST_DescribeHosts - description:Describes the specified Dedicated Hosts or all your Dedicated Hosts.
The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.
The filters.
instance-id - The ID of the instance.
state - The state of the association (associating | associated | disassociating).
NextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token to request the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeIamInstanceProfileAssociations
- operationId: POST_DescribeIamInstanceProfileAssociations
- description: Describes your IAM instance profile associations.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeIamInstanceProfileAssociationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeIamInstanceProfileAssociationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeIdFormat&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeIdFormat
- operationId: GET_DescribeIdFormat
- description: 'Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the IAM user who makes the request; they do not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeIdFormat
- operationId: POST_DescribeIdFormat
- description: 'Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the IAM user who makes the request; they do not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIdentityIdFormatResult' - parameters: - - name: PrincipalArn - in: query - required: true - description: 'The ARN of the principal, which can be an IAM role, IAM user, or the root user.' - schema: - type: string - - name: Resource - in: query - required: false - description: 'The type of resource:bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeIdentityIdFormat
- operationId: POST_DescribeIdentityIdFormat
- description: 'Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIdentityIdFormatResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIdentityIdFormatRequest' - parameters: [] - /?Action=DescribeImageAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeImageAttribute - operationId: GET_DescribeImageAttribute - description: Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImageAttribute' - parameters: - - name: Attribute - in: query - required: true - description: 'The AMI attribute.
Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeImageAttribute
- operationId: POST_DescribeImageAttribute
- description: Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ImageAttribute'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeImageAttributeRequest'
- parameters: []
- /?Action=DescribeImages&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeImages
- operationId: GET_DescribeImages
- description: 'Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImagesResult' - parameters: - - name: ExecutableBy - in: query - required: false - description: 'Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).
If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.
If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.
If you specify all, all public AMIs are returned.
The filters.
architecture - The image architecture (i386 | x86_64 | arm64).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
description - The description of the image (provided during image creation).
ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
platform - The platform. To only list Windows-based AMIs, use windows.
product-code - The product code.
product-code.type - The type of the product code (marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
virtualization-type - The virtualization type (paravirtual | hvm).
The image IDs.
Default: Describes all images available to you.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageId' - - xml: - name: ImageId - - name: Owner - in: query - required: false - description: 'Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs,self, amazon, and aws-marketplace. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: Owner
- - name: IncludeDeprecated
- in: query
- required: false
- description: 'If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeImages
- operationId: POST_DescribeImages
- description: 'Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImagesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImagesRequest' - parameters: [] - /?Action=DescribeImportImageTasks&Version=2016-11-15: - get: - x-aws-operation-name: DescribeImportImageTasks - operationId: GET_DescribeImportImageTasks - description: Displays details about an import virtual machine or import snapshot tasks that are already created. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImportImageTasksResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filters
- in: query
- required: false
- description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Filter'
- - xml:
- name: Filter
- - name: ImportTaskId
- in: query
- required: false
- description: The IDs of the import image tasks.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImportImageTaskId'
- - xml:
- name: ImportTaskId
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of results to return in a single call.
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: A token that indicates the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeImportImageTasks
- operationId: POST_DescribeImportImageTasks
- description: Displays details about an import virtual machine or import snapshot tasks that are already created.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeImportImageTasksResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeImportImageTasksRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeImportSnapshotTasks&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeImportSnapshotTasks
- operationId: GET_DescribeImportSnapshotTasks
- description: Describes your import snapshot tasks.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeImportSnapshotTasksResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filters
- in: query
- required: false
- description: The filters.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Filter'
- - xml:
- name: Filter
- - name: ImportTaskId
- in: query
- required: false
- description: A list of import snapshot task IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImportSnapshotTaskId'
- - xml:
- name: ImportTaskId
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: A token that indicates the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeImportSnapshotTasks
- operationId: POST_DescribeImportSnapshotTasks
- description: Describes your import snapshot tasks.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeImportSnapshotTasksResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeImportSnapshotTasksRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeInstanceAttribute&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeInstanceAttribute
- operationId: GET_DescribeInstanceAttribute
- description: 'Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport '
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/InstanceAttribute'
- parameters:
- - name: Attribute
- in: query
- required: true
- description: 'The instance attribute.
Note: The enaSupport attribute is not supported at this time.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeInstanceAttribute
- operationId: POST_DescribeInstanceAttribute
- description: 'Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport '
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/InstanceAttribute'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeInstanceAttributeRequest'
- parameters: []
- /?Action=DescribeInstanceCreditSpecifications&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeInstanceCreditSpecifications
- operationId: GET_DescribeInstanceCreditSpecifications
- description: 'Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: The filters.
instance-id - The ID of the instance.
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 1000 explicitly specified instance IDs.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returnedNextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token to retrieve the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeInstanceCreditSpecifications
- operationId: POST_DescribeInstanceCreditSpecifications
- description: 'Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeInstanceEventNotificationAttributes&Version=2016-11-15: - get: - x-aws-operation-name: DescribeInstanceEventNotificationAttributes - operationId: GET_DescribeInstanceEventNotificationAttributes - description: Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceEventNotificationAttributesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeInstanceEventNotificationAttributes
- operationId: POST_DescribeInstanceEventNotificationAttributes
- description: Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeInstanceEventNotificationAttributesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeInstanceEventNotificationAttributesRequest'
- parameters: []
- /?Action=DescribeInstanceEventWindows&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeInstanceEventWindows
- operationId: GET_DescribeInstanceEventWindows
- description: 'Describes the specified event windows or all event windows.
If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceEventWindowsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceEventWindowId
- in: query
- required: false
- description: The IDs of the event windows.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowId'
- - xml:
- name: InstanceEventWindowId
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
dedicated-host-id - The event windows associated with the specified Dedicated Host ID.
event-window-name - The event windows associated with the specified names.
instance-id - The event windows associated with the specified instance ID.
instance-tag - The event windows associated with the specified tag and value.
instance-tag-key - The event windows associated with the specified tag key, regardless of the value.
instance-tag-value - The event windows associated with the specified tag value, regardless of the key.
tag:<key> - The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.
tag-key - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.
tag-value - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.
NextToken value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.'
- schema:
- type: integer
- minimum: 20
- maximum: 500
- - name: NextToken
- in: query
- required: false
- description: The token to request the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeInstanceEventWindows
- operationId: POST_DescribeInstanceEventWindows
- description: 'Describes the specified event windows or all event windows.
If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceEventWindowsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceEventWindowsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeInstanceStatus&Version=2016-11-15: - get: - x-aws-operation-name: DescribeInstanceStatus - operationId: GET_DescribeInstanceStatus - description: 'Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returnedNextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token to retrieve the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IncludeAllInstances
- in: query
- required: false
- description: 'When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: LocationType
- in: query
- required: false
- description: The location type.
- schema:
- type: string
- enum:
- - region
- - availability-zone
- - availability-zone-id
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. Filter names and values are case-sensitive.
location - This depends on the location type. For example, if the location type is region (default), the location is the Region code (for example, us-east-2.)
instance-type - The instance type. For example, c5.2xlarge.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceType
- in: query
- required: false
- description: 'The instance types. For more information, see Instance types in the Amazon EC2 User Guide.'
- schema:
- type: array
- items:
- $ref: '#/components/schemas/InstanceType'
- minItems: 0
- maxItems: 100
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether auto recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether it is a burstable performance instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, "25 Gigabit").
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, "1" or "1,2".
Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstancesResult' - parameters: - - name: Filter - in: query - required: false - description: 'The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. EC2-Classic only.
group-name - The name of the security group for the instance. EC2-Classic only.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (enabled | disabled)
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance''s reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The instance IDs.
Default: Describes all your instances.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token to request the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeInstances
- operationId: POST_DescribeInstances
- description: 'Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstancesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeInternetGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeInternetGateways - operationId: GET_DescribeInternetGateways - description: Describes one or more of your internet gateways. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInternetGatewaysResult' - parameters: - - name: Filter - in: query - required: false - description: 'One or more filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InternetGatewayId
- in: query
- required: false
- description: 'One or more internet gateway IDs.
Default: Describes all your internet gateways.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InternetGatewayId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- 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'
- post:
- x-aws-operation-name: DescribeInternetGateways
- operationId: POST_DescribeInternetGateways
- description: Describes one or more of your internet gateways.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeInternetGatewaysResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeInternetGatewaysRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeIpamPools&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeIpamPools
- operationId: GET_DescribeIpamPools
- description: Get information about your IPAM pools.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeIpamPoolsResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Filter'
- - xml:
- name: Filter
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of results to return in the request.
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: IpamPoolId
- in: query
- required: false
- description: The IDs of the IPAM pools you would like information on.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: DescribeIpamPools
- operationId: POST_DescribeIpamPools
- description: Get information about your IPAM pools.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeIpamPoolsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeIpamPoolsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeIpamScopes&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeIpamScopes
- operationId: GET_DescribeIpamScopes
- description: Get information about your IPAM scopes.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeIpamScopesResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Filter'
- - xml:
- name: Filter
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of results to return in the request.
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: IpamScopeId
- in: query
- required: false
- description: The IDs of the scopes you want information on.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: DescribeIpamScopes
- operationId: POST_DescribeIpamScopes
- description: Get information about your IPAM scopes.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeIpamScopesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeIpamScopesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeIpams&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeIpams
- operationId: GET_DescribeIpams
- description: 'Get information about your IPAM pools.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpamsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Filter'
- - xml:
- name: Filter
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of results to return in the request.
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: IpamId
- in: query
- required: false
- description: The IDs of the IPAMs you want information on.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: DescribeIpams
- operationId: POST_DescribeIpams
- description: 'Get information about your IPAM pools.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpamsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpamsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeIpv6Pools&Version=2016-11-15: - get: - x-aws-operation-name: DescribeIpv6Pools - operationId: GET_DescribeIpv6Pools - description: Describes your IPv6 address pools. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpv6PoolsResult' - parameters: - - name: PoolId - in: query - required: false - description: The IDs of the IPv6 address pools. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv6PoolEc2Id' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 1000
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeKeyPairsResult' - parameters: - - name: Filter - in: query - required: false - description: 'The filters.
key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The key pair names.
Default: Describes all of your key pairs.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/KeyPairName' - - xml: - name: KeyName - - name: KeyPairId - in: query - required: false - description: The IDs of the key pairs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/KeyPairId' - - xml: - name: KeyPairId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IncludePublicKey
- in: query
- required: false
- description: 'If true, the public key material is included in the response.
Default: false
Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeKeyPairsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeKeyPairsRequest' - parameters: [] - /?Action=DescribeLaunchTemplateVersions&Version=2016-11-15: - get: - x-aws-operation-name: DescribeLaunchTemplateVersions - operationId: GET_DescribeLaunchTemplateVersions - description: 'Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLaunchTemplateVersionsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: LaunchTemplateId
- in: query
- required: false
- description: 'The ID of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter.'
- schema:
- type: string
- - name: LaunchTemplateName
- in: query
- required: false
- description: 'The name of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter.'
- schema:
- type: string
- pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
- minLength: 3
- maxLength: 128
- - name: LaunchTemplateVersion
- in: query
- required: false
- description: 'One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.
To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest. To describe all launch templates in your account that are defined as the default version, the valid value is $Default. You can specify $Latest and $Default in the same call. You cannot specify numbers.
NextToken value. This value can be between 1 and 200.'
- schema:
- type: integer
- - name: Filter
- in: query
- required: false
- description: One or more filters.
create-time - The time the launch template version was created.
ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).
http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).
host-resource-group-arn - The ARN of the host resource group in which to launch the instances.
http-tokens - The state of token usage for your instance metadata requests (optional | required).
iam-instance-profile - The ARN of the IAM instance profile.
image-id - The ID of the AMI.
instance-type - The instance type.
is-default-version - A boolean that indicates whether the launch template version is the default version.
kernel-id - The kernel ID.
license-configuration-arn - The ARN of the license configuration.
network-card-index - The index of the network card.
ram-disk-id - The RAM disk ID.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: LaunchTemplateId
- in: query
- required: false
- description: One or more launch template IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateId'
- - xml:
- name: item
- - name: LaunchTemplateName
- in: query
- required: false
- description: One or more launch template names.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateName'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
create-time - The time the launch template was created.
launch-template-name - The name of the launch template.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
NextToken value. This value can be between 1 and 200.'
- schema:
- type: integer
- minimum: 1
- maximum: 200
- 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'
- post:
- x-aws-operation-name: DescribeLaunchTemplates
- operationId: POST_DescribeLaunchTemplates
- description: Describes one or more launch templates.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLaunchTemplatesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLaunchTemplatesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
- operationId: GET_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
- description: Describes the associations between virtual interface groups and local gateway route tables.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult'
- parameters:
- - name: LocalGatewayRouteTableVirtualInterfaceGroupAssociationId
- in: query
- required: false
- description: The IDs of the associations.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
state - The state of the association.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
- operationId: POST_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
- description: Describes the associations between virtual interface groups and local gateway route tables.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeLocalGatewayRouteTableVpcAssociations&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeLocalGatewayRouteTableVpcAssociations
- operationId: GET_DescribeLocalGatewayRouteTableVpcAssociations
- description: Describes the specified associations between VPCs and local gateway route tables.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVpcAssociationsResult'
- parameters:
- - name: LocalGatewayRouteTableVpcAssociationId
- in: query
- required: false
- description: The IDs of the associations.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the association.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-vpc-association-id - The ID of the association.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route table for the association.
state - The state of the association.
vpc-id - The ID of the VPC.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeLocalGatewayRouteTableVpcAssociations
- operationId: POST_DescribeLocalGatewayRouteTableVpcAssociations
- description: Describes the specified associations between VPCs and local gateway route tables.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVpcAssociationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVpcAssociationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeLocalGatewayRouteTables&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeLocalGatewayRouteTables
- operationId: GET_DescribeLocalGatewayRouteTables
- description: 'Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayRouteTablesResult'
- parameters:
- - name: LocalGatewayRouteTableId
- in: query
- required: false
- description: The IDs of the local gateway route tables.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRoutetableId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table.
local-gateway-route-table-id - The ID of a local gateway route table.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route table.
state - The state of the local gateway route table.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeLocalGatewayRouteTables
- operationId: POST_DescribeLocalGatewayRouteTables
- description: 'Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayRouteTablesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayRouteTablesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeLocalGatewayVirtualInterfaceGroups&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeLocalGatewayVirtualInterfaceGroups
- operationId: GET_DescribeLocalGatewayVirtualInterfaceGroups
- description: Describes the specified local gateway virtual interface groups.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfaceGroupsResult'
- parameters:
- - name: LocalGatewayVirtualInterfaceGroupId
- in: query
- required: false
- description: The IDs of the virtual interface groups.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeLocalGatewayVirtualInterfaceGroups
- operationId: POST_DescribeLocalGatewayVirtualInterfaceGroups
- description: Describes the specified local gateway virtual interface groups.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfaceGroupsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfaceGroupsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeLocalGatewayVirtualInterfaces&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeLocalGatewayVirtualInterfaces
- operationId: GET_DescribeLocalGatewayVirtualInterfaces
- description: Describes the specified local gateway virtual interfaces.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesResult'
- parameters:
- - name: LocalGatewayVirtualInterfaceId
- in: query
- required: false
- description: The IDs of the virtual interfaces.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: One or more filters.
local-address - The local address.
local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
local-gateway-id - The ID of the local gateway.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.
peer-address - The peer address.
peer-bgp-asn - The peer BGP ASN.
vlan - The ID of the VLAN.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeLocalGatewayVirtualInterfaces
- operationId: POST_DescribeLocalGatewayVirtualInterfaces
- description: Describes the specified local gateway virtual interfaces.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeLocalGateways&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeLocalGateways
- operationId: GET_DescribeLocalGateways
- description: 'Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewaysResult'
- parameters:
- - name: LocalGatewayId
- in: query
- required: false
- description: The IDs of the local gateways.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: One or more filters.
local-gateway-id - The ID of a local gateway.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway.
state - The state of the association.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeLocalGateways
- operationId: POST_DescribeLocalGateways
- description: 'Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewaysResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeLocalGatewaysRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeManagedPrefixLists&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeManagedPrefixLists
- operationId: GET_DescribeManagedPrefixLists
- description: 'Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeManagedPrefixListsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: One or more filters.
owner-id - The ID of the prefix list owner.
prefix-list-id - The ID of the prefix list.
prefix-list-name - The name of the prefix list.
nextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 100
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: PrefixListId
- in: query
- required: false
- description: One or more prefix list IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: DescribeManagedPrefixLists
- operationId: POST_DescribeManagedPrefixLists
- description: 'Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeManagedPrefixListsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeManagedPrefixListsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeMovingAddresses&Version=2016-11-15: - get: - x-aws-operation-name: DescribeMovingAddresses - operationId: GET_DescribeMovingAddresses - description: 'Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeMovingAddressesResult' - parameters: - - name: Filter - in: query - required: false - description:One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: PublicIp - in: query - required: false - description: One or more Elastic IP addresses. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - 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' - post: - x-aws-operation-name: DescribeMovingAddresses - operationId: POST_DescribeMovingAddresses - description: 'Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeMovingAddressesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeMovingAddressesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeNatGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeNatGateways - operationId: GET_DescribeNatGateways - description: Describes one or more of your NAT gateways. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNatGatewaysResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
nat-gateway-id - The ID of the NAT gateway.
state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
subnet-id - The ID of the subnet in which the NAT gateway resides.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the NAT gateway resides.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NatGatewayId
- in: query
- required: false
- description: One or more NAT gateway IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NatGatewayId'
- - xml:
- name: item
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeNatGateways
- operationId: POST_DescribeNatGateways
- description: Describes one or more of your NAT gateways.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNatGatewaysResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNatGatewaysRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeNetworkAcls&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeNetworkAcls
- operationId: GET_DescribeNetworkAcls
- description: 'Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkAclsResult' - parameters: - - name: Filter - in: query - required: false - description: 'One or more filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the Amazon Web Services account that owns the network ACL.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network ACL.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NetworkAclId
- in: query
- required: false
- description: 'One or more network ACL IDs.
Default: Describes all your network ACLs.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkAclId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- 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'
- post:
- x-aws-operation-name: DescribeNetworkAcls
- operationId: POST_DescribeNetworkAcls
- description: 'Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkAclsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkAclsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeNetworkInsightsAccessScopeAnalyses&Version=2016-11-15: - get: - x-aws-operation-name: DescribeNetworkInsightsAccessScopeAnalyses - operationId: GET_DescribeNetworkInsightsAccessScopeAnalyses - description: Describes the specified Network Access Scope analyses. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopeAnalysesResult' - parameters: - - name: NetworkInsightsAccessScopeAnalysisId - in: query - required: false - description: The IDs of the Network Access Scope analyses. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId' - - xml: - name: item - - name: NetworkInsightsAccessScopeId - in: query - required: false - description: The ID of the Network Access Scope. - schema: - type: string - - name: AnalysisStartTimeBegin - in: query - required: false - description: Filters the results based on the start time. The analysis must have started on or after this time. - schema: - type: string - format: date-time - - name: AnalysisStartTimeEnd - in: query - required: false - description: Filters the results based on the start time. The analysis must have started on or before this time. - schema: - type: string - format: date-time - - name: Filter - in: query - required: false - description: There are no supported filters. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 100
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeNetworkInsightsAccessScopeAnalyses
- operationId: POST_DescribeNetworkInsightsAccessScopeAnalyses
- description: Describes the specified Network Access Scope analyses.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopeAnalysesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopeAnalysesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeNetworkInsightsAccessScopes&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeNetworkInsightsAccessScopes
- operationId: GET_DescribeNetworkInsightsAccessScopes
- description: Describes the specified Network Access Scopes.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesResult'
- parameters:
- - name: NetworkInsightsAccessScopeId
- in: query
- required: false
- description: The IDs of the Network Access Scopes.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: There are no supported filters.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Filter'
- - xml:
- name: Filter
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 100
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeNetworkInsightsAccessScopes
- operationId: POST_DescribeNetworkInsightsAccessScopes
- description: Describes the specified Network Access Scopes.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeNetworkInsightsAnalyses&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeNetworkInsightsAnalyses
- operationId: GET_DescribeNetworkInsightsAnalyses
- description: Describes one or more of your network insights analyses.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInsightsAnalysesResult'
- parameters:
- - name: NetworkInsightsAnalysisId
- in: query
- required: false
- description: The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAnalysisId'
- - xml:
- name: item
- - name: NetworkInsightsPathId
- in: query
- required: false
- description: The ID of the path. You must specify either a path ID or analysis IDs.
- schema:
- type: string
- - name: AnalysisStartTime
- in: query
- required: false
- description: The time when the network insights analyses started.
- schema:
- type: string
- format: date-time
- - name: AnalysisEndTime
- in: query
- required: false
- description: The time when the network insights analyses ended.
- schema:
- type: string
- format: date-time
- - name: Filter
- in: query
- required: false
- description: 'The filters. The following are the possible values:
PathFound - A Boolean value that indicates whether a feasible path is found.
Status - The status of the analysis (running | succeeded | failed).
nextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 100
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeNetworkInsightsAnalyses
- operationId: POST_DescribeNetworkInsightsAnalyses
- description: Describes one or more of your network insights analyses.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInsightsAnalysesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInsightsAnalysesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeNetworkInsightsPaths&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeNetworkInsightsPaths
- operationId: GET_DescribeNetworkInsightsPaths
- description: Describes one or more of your paths.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInsightsPathsResult'
- parameters:
- - name: NetworkInsightsPathId
- in: query
- required: false
- description: The IDs of the paths.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsPathId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: 'The filters. The following are the possible values:
Destination - The ID of the resource.
DestinationPort - The destination port.
Name - The path name.
Protocol - The protocol.
Source - The ID of the resource.
nextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 100
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeNetworkInsightsPaths
- operationId: POST_DescribeNetworkInsightsPaths
- description: Describes one or more of your paths.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInsightsPathsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInsightsPathsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeNetworkInterfaceAttribute&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeNetworkInterfaceAttribute
- operationId: GET_DescribeNetworkInterfaceAttribute
- description: Describes a network interface attribute. You can specify only one attribute at a time.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeResult'
- parameters:
- - name: Attribute
- in: query
- required: false
- description: The attribute of the network interface. This parameter is required.
- schema:
- type: string
- enum:
- - description
- - groupSet
- - sourceDestCheck
- - attachment
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NetworkInterfaceId
- in: query
- required: true
- description: The ID of the network interface.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeNetworkInterfaceAttribute
- operationId: POST_DescribeNetworkInterfaceAttribute
- description: Describes a network interface attribute. You can specify only one attribute at a time.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeRequest'
- parameters: []
- /?Action=DescribeNetworkInterfacePermissions&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeNetworkInterfacePermissions
- operationId: GET_DescribeNetworkInterfacePermissions
- description: 'Describes the permissions for your network interfaces. '
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsResult'
- parameters:
- - name: NetworkInterfacePermissionId
- in: query
- required: false
- description: One or more network interface permission IDs.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/NetworkInterfacePermissionId'
- - name: Filter
- in: query
- required: false
- description: One or more filters.
network-interface-permission.network-interface-permission-id - The ID of the permission.
network-interface-permission.network-interface-id - The ID of the network interface.
network-interface-permission.aws-account-id - The Amazon Web Services account ID.
network-interface-permission.aws-service - The Amazon Web Service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
NextToken value. If this parameter is not specified, up to 50 results are returned by default.'
- schema:
- type: integer
- minimum: 5
- maximum: 255
- 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'
- post:
- x-aws-operation-name: DescribeNetworkInterfacePermissions
- operationId: POST_DescribeNetworkInterfacePermissions
- description: 'Describes the permissions for your network interfaces. '
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeNetworkInterfaces&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeNetworkInterfaces
- operationId: GET_DescribeNetworkInterfaces
- description: Describes one or more of your network interfaces.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeNetworkInterfacesResult'
- parameters:
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attachment-id - The ID of the interface attachment.
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | efa | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NetworkInterfaceId
- in: query
- required: false
- description: 'One or more network interface IDs.
Default: Describes all your network interfaces.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request. - schema: - type: integer - minimum: 5 - maximum: 1000 - 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' - post: - x-aws-operation-name: DescribeNetworkInterfaces - operationId: POST_DescribeNetworkInterfaces - description: Describes one or more of your network interfaces. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInterfacesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInterfacesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribePlacementGroups&Version=2016-11-15: - get: - x-aws-operation-name: DescribePlacementGroups - operationId: GET_DescribePlacementGroups - description: 'Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePlacementGroupsResult' - parameters: - - name: Filter - in: query - required: false - description: 'The filters.
group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: GroupName
- in: query
- required: false
- description: 'The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
' - schema: - type: array - items: - $ref: '#/components/schemas/PlacementGroupName' - - name: GroupId - in: query - required: false - description: The IDs of the placement groups. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/PlacementGroupId' - - xml: - name: GroupId - 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' - post: - x-aws-operation-name: DescribePlacementGroups - operationId: POST_DescribePlacementGroups - description: 'Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePlacementGroupsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePlacementGroupsRequest' - parameters: [] - /?Action=DescribePrefixLists&Version=2016-11-15: - get: - x-aws-operation-name: DescribePrefixLists - operationId: GET_DescribePrefixLists - description: 'Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.
We recommend that you use DescribeManagedPrefixLists instead.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePrefixListsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.
nextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: PrefixListId
- in: query
- required: false
- description: One or more prefix list IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PrefixListResourceId'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: DescribePrefixLists
- operationId: POST_DescribePrefixLists
- description: 'Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.
We recommend that you use DescribeManagedPrefixLists instead.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePrefixListsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePrefixListsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribePrincipalIdFormat&Version=2016-11-15: - get: - x-aws-operation-name: DescribePrincipalIdFormat - operationId: GET_DescribePrincipalIdFormat - description: 'Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Resource
- in: query
- required: false
- description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. '
- schema:
- type: integer
- minimum: 1
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token to request the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribePrincipalIdFormat
- operationId: POST_DescribePrincipalIdFormat
- description: 'Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
nextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 10
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes the Regions that are enabled for your account, or all Regions.
For a list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud endpoints and quotas.
For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeRegionsResult' - parameters: - - name: Filter - in: query - required: false - description: 'The filters.
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).
region-name - The name of the Region (for example, us-east-1).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: AllRegions
- in: query
- required: false
- description: 'Indicates whether to display all Regions, including Regions that are disabled for your account.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeRegions
- operationId: POST_DescribeRegions
- description: 'Describes the Regions that are enabled for your account, or all Regions.
For a list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud endpoints and quotas.
For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeRegionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeRegionsRequest' - parameters: [] - /?Action=DescribeReplaceRootVolumeTasks&Version=2016-11-15: - get: - x-aws-operation-name: DescribeReplaceRootVolumeTasks - operationId: GET_DescribeReplaceRootVolumeTasks - description: 'Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReplaceRootVolumeTasksResult' - parameters: - - name: ReplaceRootVolumeTaskId - in: query - required: false - description: The ID of the root volume replacement task to view. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReplaceRootVolumeTaskId' - - xml: - name: ReplaceRootVolumeTaskId - - name: Filter - in: query - required: false - description: 'Filter to use:
instance-id - The ID of the instance for which the root volume replacement task was created.
nextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 50
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeReplaceRootVolumeTasks
- operationId: POST_DescribeReplaceRootVolumeTasks
- description: 'Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeReplaceRootVolumeTasksResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeReplaceRootVolumeTasksRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeReservedInstances&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeReservedInstances
- operationId: GET_DescribeReservedInstances
- description: 'Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesResult' - parameters: - - name: Filter - in: query - required: false - description: 'One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
scope - The scope of the Reserved Instance (Region or Availability Zone).
product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservationId' - - xml: - name: ReservedInstancesId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: OfferingType
- in: query
- required: false
- description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.'
- schema:
- type: string
- enum:
- - Heavy Utilization
- - Medium Utilization
- - Light Utilization
- - No Upfront
- - Partial Upfront
- - All Upfront
- 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'
- post:
- x-aws-operation-name: DescribeReservedInstances
- operationId: POST_DescribeReservedInstances
- description: 'Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesRequest' - parameters: [] - /?Action=DescribeReservedInstancesListings&Version=2016-11-15: - get: - x-aws-operation-name: DescribeReservedInstancesListings - operationId: GET_DescribeReservedInstancesListings - description: 'Describes your account''s Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you''re searching for with what''s available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesListingsResult' - parameters: - - name: Filter - in: query - required: false - description:One or more filters.
reserved-instances-id - The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active | cancelled | closed).
status-message - The reason for the status.
Describes your account''s Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you''re searching for with what''s available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesListingsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesListingsRequest' - parameters: [] - /?Action=DescribeReservedInstancesModifications&Version=2016-11-15: - get: - x-aws-operation-name: DescribeReservedInstancesModifications - operationId: GET_DescribeReservedInstancesModifications - description: 'Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesModificationsResult' - parameters: - - name: Filter - in: query - required: false - description:One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesModificationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesModificationsRequest' - parameters: - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeReservedInstancesOfferings&Version=2016-11-15: - get: - x-aws-operation-name: DescribeReservedInstancesOfferings - operationId: GET_DescribeReservedInstancesOfferings - description: 'Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesOfferingsResult' - parameters: - - name: AvailabilityZone - in: query - required: false - description: The Availability Zone in which the Reserved Instance can be used. - schema: - type: string - - name: Filter - in: query - required: false - description: 'One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))
reserved-instances-offering-id - The Reserved Instances offering ID.
scope - The scope of the Reserved Instance (Availability Zone or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
m1.small). For more information, see Instance types in the Amazon EC2 User Guide.'
- schema:
- type: string
- enum:
- - a1.medium
- - a1.large
- - a1.xlarge
- - a1.2xlarge
- - a1.4xlarge
- - a1.metal
- - c1.medium
- - c1.xlarge
- - c3.large
- - c3.xlarge
- - c3.2xlarge
- - c3.4xlarge
- - c3.8xlarge
- - c4.large
- - c4.xlarge
- - c4.2xlarge
- - c4.4xlarge
- - c4.8xlarge
- - c5.large
- - c5.xlarge
- - c5.2xlarge
- - c5.4xlarge
- - c5.9xlarge
- - c5.12xlarge
- - c5.18xlarge
- - c5.24xlarge
- - c5.metal
- - c5a.large
- - c5a.xlarge
- - c5a.2xlarge
- - c5a.4xlarge
- - c5a.8xlarge
- - c5a.12xlarge
- - c5a.16xlarge
- - c5a.24xlarge
- - c5ad.large
- - c5ad.xlarge
- - c5ad.2xlarge
- - c5ad.4xlarge
- - c5ad.8xlarge
- - c5ad.12xlarge
- - c5ad.16xlarge
- - c5ad.24xlarge
- - c5d.large
- - c5d.xlarge
- - c5d.2xlarge
- - c5d.4xlarge
- - c5d.9xlarge
- - c5d.12xlarge
- - c5d.18xlarge
- - c5d.24xlarge
- - c5d.metal
- - c5n.large
- - c5n.xlarge
- - c5n.2xlarge
- - c5n.4xlarge
- - c5n.9xlarge
- - c5n.18xlarge
- - c5n.metal
- - c6g.medium
- - c6g.large
- - c6g.xlarge
- - c6g.2xlarge
- - c6g.4xlarge
- - c6g.8xlarge
- - c6g.12xlarge
- - c6g.16xlarge
- - c6g.metal
- - c6gd.medium
- - c6gd.large
- - c6gd.xlarge
- - c6gd.2xlarge
- - c6gd.4xlarge
- - c6gd.8xlarge
- - c6gd.12xlarge
- - c6gd.16xlarge
- - c6gd.metal
- - c6gn.medium
- - c6gn.large
- - c6gn.xlarge
- - c6gn.2xlarge
- - c6gn.4xlarge
- - c6gn.8xlarge
- - c6gn.12xlarge
- - c6gn.16xlarge
- - c6i.large
- - c6i.xlarge
- - c6i.2xlarge
- - c6i.4xlarge
- - c6i.8xlarge
- - c6i.12xlarge
- - c6i.16xlarge
- - c6i.24xlarge
- - c6i.32xlarge
- - c6i.metal
- - cc1.4xlarge
- - cc2.8xlarge
- - cg1.4xlarge
- - cr1.8xlarge
- - d2.xlarge
- - d2.2xlarge
- - d2.4xlarge
- - d2.8xlarge
- - d3.xlarge
- - d3.2xlarge
- - d3.4xlarge
- - d3.8xlarge
- - d3en.xlarge
- - d3en.2xlarge
- - d3en.4xlarge
- - d3en.6xlarge
- - d3en.8xlarge
- - d3en.12xlarge
- - dl1.24xlarge
- - f1.2xlarge
- - f1.4xlarge
- - f1.16xlarge
- - g2.2xlarge
- - g2.8xlarge
- - g3.4xlarge
- - g3.8xlarge
- - g3.16xlarge
- - g3s.xlarge
- - g4ad.xlarge
- - g4ad.2xlarge
- - g4ad.4xlarge
- - g4ad.8xlarge
- - g4ad.16xlarge
- - g4dn.xlarge
- - g4dn.2xlarge
- - g4dn.4xlarge
- - g4dn.8xlarge
- - g4dn.12xlarge
- - g4dn.16xlarge
- - g4dn.metal
- - g5.xlarge
- - g5.2xlarge
- - g5.4xlarge
- - g5.8xlarge
- - g5.12xlarge
- - g5.16xlarge
- - g5.24xlarge
- - g5.48xlarge
- - g5g.xlarge
- - g5g.2xlarge
- - g5g.4xlarge
- - g5g.8xlarge
- - g5g.16xlarge
- - g5g.metal
- - hi1.4xlarge
- - hpc6a.48xlarge
- - hs1.8xlarge
- - h1.2xlarge
- - h1.4xlarge
- - h1.8xlarge
- - h1.16xlarge
- - i2.xlarge
- - i2.2xlarge
- - i2.4xlarge
- - i2.8xlarge
- - i3.large
- - i3.xlarge
- - i3.2xlarge
- - i3.4xlarge
- - i3.8xlarge
- - i3.16xlarge
- - i3.metal
- - i3en.large
- - i3en.xlarge
- - i3en.2xlarge
- - i3en.3xlarge
- - i3en.6xlarge
- - i3en.12xlarge
- - i3en.24xlarge
- - i3en.metal
- - im4gn.large
- - im4gn.xlarge
- - im4gn.2xlarge
- - im4gn.4xlarge
- - im4gn.8xlarge
- - im4gn.16xlarge
- - inf1.xlarge
- - inf1.2xlarge
- - inf1.6xlarge
- - inf1.24xlarge
- - is4gen.medium
- - is4gen.large
- - is4gen.xlarge
- - is4gen.2xlarge
- - is4gen.4xlarge
- - is4gen.8xlarge
- - m1.small
- - m1.medium
- - m1.large
- - m1.xlarge
- - m2.xlarge
- - m2.2xlarge
- - m2.4xlarge
- - m3.medium
- - m3.large
- - m3.xlarge
- - m3.2xlarge
- - m4.large
- - m4.xlarge
- - m4.2xlarge
- - m4.4xlarge
- - m4.10xlarge
- - m4.16xlarge
- - m5.large
- - m5.xlarge
- - m5.2xlarge
- - m5.4xlarge
- - m5.8xlarge
- - m5.12xlarge
- - m5.16xlarge
- - m5.24xlarge
- - m5.metal
- - m5a.large
- - m5a.xlarge
- - m5a.2xlarge
- - m5a.4xlarge
- - m5a.8xlarge
- - m5a.12xlarge
- - m5a.16xlarge
- - m5a.24xlarge
- - m5ad.large
- - m5ad.xlarge
- - m5ad.2xlarge
- - m5ad.4xlarge
- - m5ad.8xlarge
- - m5ad.12xlarge
- - m5ad.16xlarge
- - m5ad.24xlarge
- - m5d.large
- - m5d.xlarge
- - m5d.2xlarge
- - m5d.4xlarge
- - m5d.8xlarge
- - m5d.12xlarge
- - m5d.16xlarge
- - m5d.24xlarge
- - m5d.metal
- - m5dn.large
- - m5dn.xlarge
- - m5dn.2xlarge
- - m5dn.4xlarge
- - m5dn.8xlarge
- - m5dn.12xlarge
- - m5dn.16xlarge
- - m5dn.24xlarge
- - m5dn.metal
- - m5n.large
- - m5n.xlarge
- - m5n.2xlarge
- - m5n.4xlarge
- - m5n.8xlarge
- - m5n.12xlarge
- - m5n.16xlarge
- - m5n.24xlarge
- - m5n.metal
- - m5zn.large
- - m5zn.xlarge
- - m5zn.2xlarge
- - m5zn.3xlarge
- - m5zn.6xlarge
- - m5zn.12xlarge
- - m5zn.metal
- - m6a.large
- - m6a.xlarge
- - m6a.2xlarge
- - m6a.4xlarge
- - m6a.8xlarge
- - m6a.12xlarge
- - m6a.16xlarge
- - m6a.24xlarge
- - m6a.32xlarge
- - m6a.48xlarge
- - m6g.metal
- - m6g.medium
- - m6g.large
- - m6g.xlarge
- - m6g.2xlarge
- - m6g.4xlarge
- - m6g.8xlarge
- - m6g.12xlarge
- - m6g.16xlarge
- - m6gd.metal
- - m6gd.medium
- - m6gd.large
- - m6gd.xlarge
- - m6gd.2xlarge
- - m6gd.4xlarge
- - m6gd.8xlarge
- - m6gd.12xlarge
- - m6gd.16xlarge
- - m6i.large
- - m6i.xlarge
- - m6i.2xlarge
- - m6i.4xlarge
- - m6i.8xlarge
- - m6i.12xlarge
- - m6i.16xlarge
- - m6i.24xlarge
- - m6i.32xlarge
- - m6i.metal
- - mac1.metal
- - p2.xlarge
- - p2.8xlarge
- - p2.16xlarge
- - p3.2xlarge
- - p3.8xlarge
- - p3.16xlarge
- - p3dn.24xlarge
- - p4d.24xlarge
- - r3.large
- - r3.xlarge
- - r3.2xlarge
- - r3.4xlarge
- - r3.8xlarge
- - r4.large
- - r4.xlarge
- - r4.2xlarge
- - r4.4xlarge
- - r4.8xlarge
- - r4.16xlarge
- - r5.large
- - r5.xlarge
- - r5.2xlarge
- - r5.4xlarge
- - r5.8xlarge
- - r5.12xlarge
- - r5.16xlarge
- - r5.24xlarge
- - r5.metal
- - r5a.large
- - r5a.xlarge
- - r5a.2xlarge
- - r5a.4xlarge
- - r5a.8xlarge
- - r5a.12xlarge
- - r5a.16xlarge
- - r5a.24xlarge
- - r5ad.large
- - r5ad.xlarge
- - r5ad.2xlarge
- - r5ad.4xlarge
- - r5ad.8xlarge
- - r5ad.12xlarge
- - r5ad.16xlarge
- - r5ad.24xlarge
- - r5b.large
- - r5b.xlarge
- - r5b.2xlarge
- - r5b.4xlarge
- - r5b.8xlarge
- - r5b.12xlarge
- - r5b.16xlarge
- - r5b.24xlarge
- - r5b.metal
- - r5d.large
- - r5d.xlarge
- - r5d.2xlarge
- - r5d.4xlarge
- - r5d.8xlarge
- - r5d.12xlarge
- - r5d.16xlarge
- - r5d.24xlarge
- - r5d.metal
- - r5dn.large
- - r5dn.xlarge
- - r5dn.2xlarge
- - r5dn.4xlarge
- - r5dn.8xlarge
- - r5dn.12xlarge
- - r5dn.16xlarge
- - r5dn.24xlarge
- - r5dn.metal
- - r5n.large
- - r5n.xlarge
- - r5n.2xlarge
- - r5n.4xlarge
- - r5n.8xlarge
- - r5n.12xlarge
- - r5n.16xlarge
- - r5n.24xlarge
- - r5n.metal
- - r6g.medium
- - r6g.large
- - r6g.xlarge
- - r6g.2xlarge
- - r6g.4xlarge
- - r6g.8xlarge
- - r6g.12xlarge
- - r6g.16xlarge
- - r6g.metal
- - r6gd.medium
- - r6gd.large
- - r6gd.xlarge
- - r6gd.2xlarge
- - r6gd.4xlarge
- - r6gd.8xlarge
- - r6gd.12xlarge
- - r6gd.16xlarge
- - r6gd.metal
- - r6i.large
- - r6i.xlarge
- - r6i.2xlarge
- - r6i.4xlarge
- - r6i.8xlarge
- - r6i.12xlarge
- - r6i.16xlarge
- - r6i.24xlarge
- - r6i.32xlarge
- - r6i.metal
- - t1.micro
- - t2.nano
- - t2.micro
- - t2.small
- - t2.medium
- - t2.large
- - t2.xlarge
- - t2.2xlarge
- - t3.nano
- - t3.micro
- - t3.small
- - t3.medium
- - t3.large
- - t3.xlarge
- - t3.2xlarge
- - t3a.nano
- - t3a.micro
- - t3a.small
- - t3a.medium
- - t3a.large
- - t3a.xlarge
- - t3a.2xlarge
- - t4g.nano
- - t4g.micro
- - t4g.small
- - t4g.medium
- - t4g.large
- - t4g.xlarge
- - t4g.2xlarge
- - u-6tb1.56xlarge
- - u-6tb1.112xlarge
- - u-9tb1.112xlarge
- - u-12tb1.112xlarge
- - u-6tb1.metal
- - u-9tb1.metal
- - u-12tb1.metal
- - u-18tb1.metal
- - u-24tb1.metal
- - vt1.3xlarge
- - vt1.6xlarge
- - vt1.24xlarge
- - x1.16xlarge
- - x1.32xlarge
- - x1e.xlarge
- - x1e.2xlarge
- - x1e.4xlarge
- - x1e.8xlarge
- - x1e.16xlarge
- - x1e.32xlarge
- - x2iezn.2xlarge
- - x2iezn.4xlarge
- - x2iezn.6xlarge
- - x2iezn.8xlarge
- - x2iezn.12xlarge
- - x2iezn.metal
- - x2gd.medium
- - x2gd.large
- - x2gd.xlarge
- - x2gd.2xlarge
- - x2gd.4xlarge
- - x2gd.8xlarge
- - x2gd.12xlarge
- - x2gd.16xlarge
- - x2gd.metal
- - z1d.large
- - z1d.xlarge
- - z1d.2xlarge
- - z1d.3xlarge
- - z1d.6xlarge
- - z1d.12xlarge
- - z1d.metal
- - x2idn.16xlarge
- - x2idn.24xlarge
- - x2idn.32xlarge
- - x2iedn.xlarge
- - x2iedn.2xlarge
- - x2iedn.4xlarge
- - x2iedn.8xlarge
- - x2iedn.16xlarge
- - x2iedn.24xlarge
- - x2iedn.32xlarge
- - c6a.large
- - c6a.xlarge
- - c6a.2xlarge
- - c6a.4xlarge
- - c6a.8xlarge
- - c6a.12xlarge
- - c6a.16xlarge
- - c6a.24xlarge
- - c6a.32xlarge
- - c6a.48xlarge
- - c6a.metal
- - m6a.metal
- - i4i.large
- - i4i.xlarge
- - i4i.2xlarge
- - i4i.4xlarge
- - i4i.8xlarge
- - i4i.16xlarge
- - i4i.32xlarge
- - name: MaxDuration
- in: query
- required: false
- description: 'The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
' - schema: - type: integer - - name: MaxInstanceCount - in: query - required: false - description: 'The maximum number of instances to filter when searching for offerings.
Default: 20
' - schema: - type: integer - - name: MinDuration - in: query - required: false - description: 'The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
' - schema: - type: integer - - name: OfferingClass - in: query - required: false - description: The offering class of the Reserved Instance. Can bestandard or convertible.
- schema:
- type: string
- enum:
- - standard
- - convertible
- - name: ProductDescription
- in: query
- required: false
- description: The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
- schema:
- type: string
- enum:
- - Linux/UNIX
- - Linux/UNIX (Amazon VPC)
- - Windows
- - Windows (Amazon VPC)
- - name: ReservedInstancesOfferingId
- in: query
- required: false
- description: One or more Reserved Instances offering IDs.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/ReservedInstancesOfferingId'
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceTenancy
- in: query
- required: false
- description: 'The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.
Default: 100
' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - - name: OfferingType - in: query - required: false - description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to theMedium Utilization Reserved Instance offering type. '
- schema:
- type: string
- enum:
- - Heavy Utilization
- - Medium Utilization
- - Light Utilization
- - No Upfront
- - Partial Upfront
- - All Upfront
- 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'
- post:
- x-aws-operation-name: DescribeReservedInstancesOfferings
- operationId: POST_DescribeReservedInstancesOfferings
- description: 'Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesOfferingsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesOfferingsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeRouteTables&Version=2016-11-15: - get: - x-aws-operation-name: DescribeRouteTables - operationId: GET_DescribeRouteTables - description: 'Describes one or more of your route tables.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeRouteTablesResult' - parameters: - - name: Filter - in: query - required: false - description: 'One or more filters.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.
owner-id - The ID of the Amazon Web Services account that owns the route table.
route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service specified in a route in the table.
route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.transit-gateway-id - The ID of a transit gateway.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route''s target isn''t available (for example, the specified gateway isn''t attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the route table.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: RouteTableId
- in: query
- required: false
- description: 'One or more route table IDs.
Default: Describes all your route tables.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 100
- 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'
- post:
- x-aws-operation-name: DescribeRouteTables
- operationId: POST_DescribeRouteTables
- description: 'Describes one or more of your route tables.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeRouteTablesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeRouteTablesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeScheduledInstanceAvailability&Version=2016-11-15: - get: - x-aws-operation-name: DescribeScheduledInstanceAvailability - operationId: GET_DescribeScheduledInstanceAvailability - description: 'Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
network-platform - The network platform (EC2-Classic or EC2-VPC).
platform - The platform (Linux/UNIX or Windows).
NextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 300
- - name: MaxSlotDurationInHours
- in: query
- required: false
- description: 'The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.'
- schema:
- type: integer
- - name: MinSlotDurationInHours
- in: query
- required: false
- description: 'The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token for the next set of results.
- schema:
- type: string
- - name: Recurrence
- in: query
- required: true
- description: The schedule recurrence.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.'
- OccurrenceDay:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
- description: Describes the recurring schedule for a Scheduled Instance.
- 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'
- post:
- x-aws-operation-name: DescribeScheduledInstanceAvailability
- operationId: POST_DescribeScheduledInstanceAvailability
- description: 'Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeScheduledInstances&Version=2016-11-15: - get: - x-aws-operation-name: DescribeScheduledInstances - operationId: GET_DescribeScheduledInstances - description: Describes the specified Scheduled Instances or all your Scheduled Instances. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeScheduledInstancesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
network-platform - The network platform (EC2-Classic or EC2-VPC).
platform - The platform (Linux/UNIX or Windows).
NextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token for the next set of results.
- schema:
- type: string
- - name: ScheduledInstanceId
- in: query
- required: false
- description: The Scheduled Instance IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ScheduledInstanceId'
- - xml:
- name: ScheduledInstanceId
- - name: SlotStartTimeRange
- in: query
- required: false
- description: The time period for the first schedule to start.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The latest date and time, in UTC, for the Scheduled Instance to start.'
- description: Describes the time period for a Scheduled Instance to start its first schedule.
- 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'
- post:
- x-aws-operation-name: DescribeScheduledInstances
- operationId: POST_DescribeScheduledInstances
- description: Describes the specified Scheduled Instances or all your Scheduled Instances.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeScheduledInstancesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeScheduledInstancesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeSecurityGroupReferences&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeSecurityGroupReferences
- operationId: GET_DescribeSecurityGroupReferences
- description: '[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you''ve specified in this request.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSecurityGroupReferencesResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: GroupId
- in: query
- required: true
- description: The IDs of the security groups in your account.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: DescribeSecurityGroupReferences
- operationId: POST_DescribeSecurityGroupReferences
- description: '[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you''ve specified in this request.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSecurityGroupReferencesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSecurityGroupReferencesRequest'
- parameters: []
- /?Action=DescribeSecurityGroupRules&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeSecurityGroupRules
- operationId: GET_DescribeSecurityGroupRules
- description: Describes one or more of your security group rules.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSecurityGroupRulesResult'
- parameters:
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
group-id - The ID of the security group.
security-group-rule-id - The ID of the security group rule.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- 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'
- post:
- x-aws-operation-name: DescribeSecurityGroupRules
- operationId: POST_DescribeSecurityGroupRules
- description: Describes one or more of your security group rules.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSecurityGroupRulesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSecurityGroupRulesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeSecurityGroups&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeSecurityGroups
- operationId: GET_DescribeSecurityGroups
- description: 'Describes the specified security groups or all of your security groups.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSecurityGroupsResult' - parameters: - - name: Filter - in: query - required: false - description: 'The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
description - The description of the security group.
egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.
egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.
egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule.
egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an outbound security group rule.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.
ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule.
ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an inbound security group rule.
owner-id - The Amazon Web Services account ID of the owner of the security group.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC specified when the security group was created.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: groupId - - name: GroupName - in: query - required: false - description: '[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupName' - - xml: - name: GroupName - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NextToken
- in: query
- required: false
- description: The token to request the next page of results.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- 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'
- post:
- x-aws-operation-name: DescribeSecurityGroups
- operationId: POST_DescribeSecurityGroups
- description: 'Describes the specified security groups or all of your security groups.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSecurityGroupsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSecurityGroupsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSnapshotAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSnapshotAttribute - operationId: GET_DescribeSnapshotAttribute - description: 'Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotAttributeResult' - parameters: - - name: Attribute - in: query - required: true - description: The snapshot attribute you would like to view. - schema: - type: string - enum: - - productCodes - - createVolumePermission - - name: SnapshotId - in: query - required: true - description: The ID of the EBS snapshot. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeSnapshotAttribute
- operationId: POST_DescribeSnapshotAttribute
- description: 'Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotAttributeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotAttributeRequest' - parameters: [] - /?Action=DescribeSnapshotTierStatus&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSnapshotTierStatus - operationId: GET_DescribeSnapshotTierStatus - description: Describes the storage tier status of one or more Amazon EBS snapshots. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotTierStatusResult' - parameters: - - name: Filter - in: query - required: false - description:The filters.
snapshot-id - The snapshot ID.
volume-id - The ID of the volume the snapshot is for.
last-tiering-operation - The state of the last archive or restore action. (archival-in-progress | archival-completed | archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- 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'
- post:
- x-aws-operation-name: DescribeSnapshotTierStatus
- operationId: POST_DescribeSnapshotTierStatus
- description: Describes the storage tier status of one or more Amazon EBS snapshots.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSnapshotTierStatusResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSnapshotTierStatusRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeSnapshots&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeSnapshots
- operationId: GET_DescribeSnapshots
- description: 'Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotsResult' - parameters: - - name: Filter - in: query - required: false - description: 'The filters.
description - A description of the snapshot.
encrypted - Indicates whether the snapshot is encrypted (true | false)
owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
storage-tier - The storage tier of the snapshot (archive | standard).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
- schema:
- type: string
- - name: Owner
- in: query
- required: false
- description: 'Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: Owner
- - name: RestorableBy
- in: query
- required: false
- description: The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/String'
- - name: SnapshotId
- in: query
- required: false
- description: 'The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - xml: - name: SnapshotId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeSnapshots
- operationId: POST_DescribeSnapshots
- description: 'Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSpotDatafeedSubscription&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSpotDatafeedSubscription - operationId: GET_DescribeSpotDatafeedSubscription - description: 'Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeSpotDatafeedSubscription
- operationId: POST_DescribeSpotDatafeedSubscription
- description: 'Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionRequest'
- parameters: []
- /?Action=DescribeSpotFleetInstances&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeSpotFleetInstances
- operationId: GET_DescribeSpotFleetInstances
- description: Describes the running instances for the specified Spot Fleet.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSpotFleetInstancesResponse'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next set of results.
- schema:
- type: string
- - name: SpotFleetRequestId
- in: query
- required: true
- description: The ID of the Spot Fleet request.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeSpotFleetInstances
- operationId: POST_DescribeSpotFleetInstances
- description: Describes the running instances for the specified Spot Fleet.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSpotFleetInstancesResponse'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeSpotFleetInstancesRequest'
- parameters: []
- /?Action=DescribeSpotFleetRequestHistory&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeSpotFleetRequestHistory
- operationId: GET_DescribeSpotFleetRequestHistory
- description: 'Describes the events for the specified Spot Fleet request during the specified time.
Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide for Linux Instances.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryResponse' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: EventType
- in: query
- required: false
- description: 'The type of events to describe. By default, all events are described.'
- schema:
- type: string
- enum:
- - instanceChange
- - fleetRequestChange
- - error
- - information
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next set of results.
- schema:
- type: string
- - name: SpotFleetRequestId
- in: query
- required: true
- description: The ID of the Spot Fleet request.
- schema:
- type: string
- - name: StartTime
- in: query
- required: true
- description: 'The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- schema:
- type: string
- format: date-time
- 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'
- post:
- x-aws-operation-name: DescribeSpotFleetRequestHistory
- operationId: POST_DescribeSpotFleetRequestHistory
- description: 'Describes the events for the specified Spot Fleet request during the specified time.
Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide for Linux Instances.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryResponse' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryRequest' - parameters: [] - /?Action=DescribeSpotFleetRequests&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSpotFleetRequests - operationId: GET_DescribeSpotFleetRequests - description:Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetRequestsResponse' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token for the next set of results.
- schema:
- type: string
- - name: SpotFleetRequestId
- in: query
- required: false
- description: The IDs of the Spot Fleet requests.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SpotFleetRequestId'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: DescribeSpotFleetRequests
- operationId: POST_DescribeSpotFleetRequests
- description: Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetRequestsResponse' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetRequestsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSpotInstanceRequests&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSpotInstanceRequests - operationId: GET_DescribeSpotInstanceRequests - description: 'Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotInstanceRequestsResult' - parameters: - - name: Filter - in: query - required: false - description: 'One or more filters.
availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.
launch.group-id - The ID of the security group for the instance.
launch.group-name - The name of the security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m3.medium).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
launched-availability-zone - The Availability Zone in which the request is launched.
network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
network-interface.description - A description of the network interface.
network-interface.device-index - The index of the device for the network interface attachment on the instance.
network-interface.group-id - The ID of the security group associated with the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.private-ip-address - The primary private IP address of the network interface.
network-interface.subnet-id - The ID of the subnet for the instance.
product-description - The product description associated with the instance (Linux/UNIX | Windows).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of Spot Instance request (one-time | persistent).
valid-from - The start date of the request.
valid-until - The end date of the request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: SpotInstanceRequestId
- in: query
- required: false
- description: One or more Spot Instance request IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SpotInstanceRequestId'
- - xml:
- name: SpotInstanceRequestId
- - name: NextToken
- in: query
- required: false
- description: The token to request the next set of results. This value is null when there are no more results to return.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- schema:
- type: integer
- 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'
- post:
- x-aws-operation-name: DescribeSpotInstanceRequests
- operationId: POST_DescribeSpotInstanceRequests
- description: 'Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotInstanceRequestsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotInstanceRequestsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSpotPriceHistory&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSpotPriceHistory - operationId: GET_DescribeSpotPriceHistory - description: 'Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.
When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotPriceHistoryResult' - parameters: - - name: Filter - in: query - required: false - description: 'One or more filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m3.medium).
product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: EndTime
- in: query
- required: false
- description: 'The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- schema:
- type: string
- format: date-time
- - name: InstanceType
- in: query
- required: false
- description: Filters the results by the specified instance types.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/InstanceType'
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token for the next set of results.
- schema:
- type: string
- - name: ProductDescription
- in: query
- required: false
- description: Filters the results by the specified basic product descriptions.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/String'
- - name: StartTime
- in: query
- required: false
- description: 'The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- schema:
- type: string
- format: date-time
- 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'
- post:
- x-aws-operation-name: DescribeSpotPriceHistory
- operationId: POST_DescribeSpotPriceHistory
- description: 'Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.
When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotPriceHistoryResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotPriceHistoryRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeStaleSecurityGroups&Version=2016-11-15: - get: - x-aws-operation-name: DescribeStaleSecurityGroups - operationId: GET_DescribeStaleSecurityGroups - description: '[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, or if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeStaleSecurityGroupsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
- schema:
- type: integer
- minimum: 5
- maximum: 255
- - name: NextToken
- in: query
- required: false
- description: The token for the next set of items to return. (You received this token from a prior call.)
- schema:
- type: string
- minLength: 1
- maxLength: 1024
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeStaleSecurityGroups
- operationId: POST_DescribeStaleSecurityGroups
- description: '[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, or if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeStaleSecurityGroupsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeStaleSecurityGroupsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeStoreImageTasks&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeStoreImageTasks
- operationId: GET_DescribeStoreImageTasks
- description: 'Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don''t specify the AMIs, you get a paginated list of store tasks from the last 31 days.
For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeStoreImageTasksResult' - parameters: - - name: ImageId - in: query - required: false - description: The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'The filters.
task-state - Returns tasks in a certain state (InProgress | Completed | Failed)
bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.
NextToken value. This value can be between 1 and 200. You cannot specify this parameter and the ImageIDs parameter in the same call.'
- schema:
- type: integer
- minimum: 1
- maximum: 200
- 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'
- post:
- x-aws-operation-name: DescribeStoreImageTasks
- operationId: POST_DescribeStoreImageTasks
- description: 'Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don''t specify the AMIs, you get a paginated list of store tasks from the last 31 days.
For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeStoreImageTasksResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeStoreImageTasksRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSubnets&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSubnets - operationId: GET_DescribeSubnets - description: 'Describes one or more of your subnets.
For more information, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSubnetsResult' - parameters: - - name: Filter - in: query - required: false - description: 'One or more filters.
availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.
availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.
available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet''s CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.
default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the subnet.
state - The state of the subnet (pending | available).
subnet-arn - The Amazon Resource Name (ARN) of the subnet.
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the subnet.
One or more subnet IDs.
Default: Describes all your subnets.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: SubnetId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- 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'
- post:
- x-aws-operation-name: DescribeSubnets
- operationId: POST_DescribeSubnets
- description: 'Describes one or more of your subnets.
For more information, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSubnetsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSubnetsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTags&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTags - operationId: GET_DescribeTags - description: 'Describes the specified tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTagsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.
NextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token to retrieve the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeTags
- operationId: POST_DescribeTags
- description: 'Describes the specified tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTagsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTagsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTrafficMirrorFilters&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTrafficMirrorFilters - operationId: GET_DescribeTrafficMirrorFilters - description: Describes one or more Traffic Mirror filters. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrafficMirrorFiltersResult' - parameters: - - name: TrafficMirrorFilterId - in: query - required: false - description: The ID of the Traffic Mirror filter. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilterId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
description: The Traffic Mirror filter description.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeTrafficMirrorFilters
- operationId: POST_DescribeTrafficMirrorFilters
- description: Describes one or more Traffic Mirror filters.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTrafficMirrorFiltersResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTrafficMirrorFiltersRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeTrafficMirrorSessions&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeTrafficMirrorSessions
- operationId: GET_DescribeTrafficMirrorSessions
- description: 'Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTrafficMirrorSessionsResult'
- parameters:
- - name: TrafficMirrorSessionId
- in: query
- required: false
- description: The ID of the Traffic Mirror session.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorSessionId'
- - xml:
- name: item
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
description: The Traffic Mirror session description.
network-interface-id: The ID of the Traffic Mirror session network interface.
owner-id: The ID of the account that owns the Traffic Mirror session.
packet-length: The assigned number of packets to mirror.
session-number: The assigned session number.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
traffic-mirror-session-id: The ID of the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
virtual-network-id: The virtual network ID of the Traffic Mirror session.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeTrafficMirrorSessions
- operationId: POST_DescribeTrafficMirrorSessions
- description: 'Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTrafficMirrorSessionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTrafficMirrorSessionsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeTrafficMirrorTargets&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeTrafficMirrorTargets
- operationId: GET_DescribeTrafficMirrorTargets
- description: Information about one or more Traffic Mirror targets.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTrafficMirrorTargetsResult'
- parameters:
- - name: TrafficMirrorTargetId
- in: query
- required: false
- description: The ID of the Traffic Mirror targets.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorTargetId'
- - xml:
- name: item
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
description: The Traffic Mirror target description.
network-interface-id: The ID of the Traffic Mirror session network interface.
network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.
owner-id: The ID of the account that owns the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeTrafficMirrorTargets
- operationId: POST_DescribeTrafficMirrorTargets
- description: Information about one or more Traffic Mirror targets.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTrafficMirrorTargetsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTrafficMirrorTargetsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeTransitGatewayAttachments&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeTransitGatewayAttachments
- operationId: GET_DescribeTransitGatewayAttachments
- description: 'Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayAttachmentsResult'
- parameters:
- - name: TransitGatewayAttachmentIds
- in: query
- required: false
- description: The IDs of the attachments.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
association.state - The state of the association (associating | associated | disassociating).
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
resource-id - The ID of the resource.
resource-owner-id - The ID of the Amazon Web Services account that owns the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeTransitGatewayAttachments
- operationId: POST_DescribeTransitGatewayAttachments
- description: 'Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayAttachmentsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayAttachmentsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeTransitGatewayConnectPeers&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeTransitGatewayConnectPeers
- operationId: GET_DescribeTransitGatewayConnectPeers
- description: Describes one or more Connect peers.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayConnectPeersResult'
- parameters:
- - name: TransitGatewayConnectPeerIds
- in: query
- required: false
- description: The IDs of the Connect peers.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnectPeerId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
state - The state of the Connect peer (pending | available | deleting | deleted).
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-connect-peer-id - The ID of the Connect peer.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeTransitGatewayConnectPeers
- operationId: POST_DescribeTransitGatewayConnectPeers
- description: Describes one or more Connect peers.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayConnectPeersResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayConnectPeersRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeTransitGatewayConnects&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeTransitGatewayConnects
- operationId: GET_DescribeTransitGatewayConnects
- description: Describes one or more Connect attachments.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayConnectsResult'
- parameters:
- - name: TransitGatewayAttachmentIds
- in: query
- required: false
- description: The IDs of the attachments.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
options.protocol - The tunnel protocol (gre).
state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).
transit-gateway-attachment-id - The ID of the Connect attachment.
transit-gateway-id - The ID of the transit gateway.
transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeTransitGatewayConnects
- operationId: POST_DescribeTransitGatewayConnects
- description: Describes one or more Connect attachments.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayConnectsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayConnectsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeTransitGatewayMulticastDomains&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeTransitGatewayMulticastDomains
- operationId: GET_DescribeTransitGatewayMulticastDomains
- description: Describes one or more transit gateway multicast domains.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsResult'
- parameters:
- - name: TransitGatewayMulticastDomainIds
- in: query
- required: false
- description: The ID of the transit gateway multicast domain.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeTransitGatewayMulticastDomains
- operationId: POST_DescribeTransitGatewayMulticastDomains
- description: Describes one or more transit gateway multicast domains.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeTransitGatewayPeeringAttachments&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeTransitGatewayPeeringAttachments
- operationId: GET_DescribeTransitGatewayPeeringAttachments
- description: Describes your transit gateway peering attachments.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsResult'
- parameters:
- - name: TransitGatewayAttachmentIds
- in: query
- required: false
- description: One or more IDs of the transit gateway peering attachments.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
transit-gateway-attachment-id - The ID of the transit gateway attachment.
local-owner-id - The ID of your Amazon Web Services account.
remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
transit-gateway-id - The ID of the transit gateway.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeTransitGatewayPeeringAttachments
- operationId: POST_DescribeTransitGatewayPeeringAttachments
- description: Describes your transit gateway peering attachments.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeTransitGatewayRouteTables&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeTransitGatewayRouteTables
- operationId: GET_DescribeTransitGatewayRouteTables
- description: 'Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayRouteTablesResult'
- parameters:
- - name: TransitGatewayRouteTableIds
- in: query
- required: false
- description: The IDs of the transit gateway route tables.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false).
default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false).
state - The state of the route table (available | deleting | deleted | pending).
transit-gateway-id - The ID of the transit gateway.
transit-gateway-route-table-id - The ID of the transit gateway route table.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeTransitGatewayRouteTables
- operationId: POST_DescribeTransitGatewayRouteTables
- description: 'Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayRouteTablesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayRouteTablesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeTransitGatewayVpcAttachments&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeTransitGatewayVpcAttachments
- operationId: GET_DescribeTransitGatewayVpcAttachments
- description: 'Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsResult'
- parameters:
- - name: TransitGatewayAttachmentIds
- in: query
- required: false
- description: The IDs of the attachments.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
vpc-id - The ID of the VPC.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeTransitGatewayVpcAttachments
- operationId: POST_DescribeTransitGatewayVpcAttachments
- description: 'Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeTransitGateways&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeTransitGateways
- operationId: GET_DescribeTransitGateways
- description: 'Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewaysResult'
- parameters:
- - name: TransitGatewayIds
- in: query
- required: false
- description: The IDs of the transit gateways.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeTransitGateways
- operationId: POST_DescribeTransitGateways
- description: 'Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewaysResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeTransitGatewaysRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeTrunkInterfaceAssociations&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeTrunkInterfaceAssociations
- operationId: GET_DescribeTrunkInterfaceAssociations
- description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Describes one or more network interface trunk associations.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsResult' - parameters: - - name: AssociationId - in: query - required: false - description: The IDs of the associations. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrunkInterfaceAssociationId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: One or more filters.
gre-key - The ID of a trunk interface association.
interface-protocol - The interface protocol. Valid values are VLAN and GRE.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 255
- 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'
- post:
- x-aws-operation-name: DescribeTrunkInterfaceAssociations
- operationId: POST_DescribeTrunkInterfaceAssociations
- description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Describes one or more network interface trunk associations.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVolumeAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVolumeAttribute - operationId: GET_DescribeVolumeAttribute - description: 'Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumeAttributeResult' - parameters: - - name: Attribute - in: query - required: true - description: The attribute of the volume. This parameter is required. - schema: - type: string - enum: - - autoEnableIO - - productCodes - - name: VolumeId - in: query - required: true - description: The ID of the volume. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeVolumeAttribute
- operationId: POST_DescribeVolumeAttribute
- description: 'Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumeAttributeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumeAttributeRequest' - parameters: [] - /?Action=DescribeVolumeStatus&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVolumeStatus - operationId: GET_DescribeVolumeStatus - description: 'Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume''s underlying host. If the volume''s underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitor the status of your volumes in the Amazon Elastic Compute Cloud User Guide.
Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.
Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)
The filters.
action.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: 'The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.'
- schema:
- type: string
- - name: VolumeId
- in: query
- required: false
- description: 'The IDs of the volumes.
Default: Describes all your volumes.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeId' - - xml: - name: VolumeId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeVolumeStatus
- operationId: POST_DescribeVolumeStatus
- description: 'Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume''s underlying host. If the volume''s underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitor the status of your volumes in the Amazon Elastic Compute Cloud User Guide.
Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.
Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumesResult' - parameters: - - name: Filter - in: query - required: false - description: 'The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true | false)
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available | in-use | deleting | deleted | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeVolumes
- operationId: POST_DescribeVolumes
- description: 'Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVolumesModifications&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVolumesModifications - operationId: GET_DescribeVolumesModifications - description: 'Describes the most recent volume modification request for the specified EBS volumes.
If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.
You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumesModificationsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VolumeId
- in: query
- required: false
- description: The IDs of the volumes.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VolumeId'
- - xml:
- name: VolumeId
- - name: Filter
- in: query
- required: false
- description: 'The filters.
modification-state - The current modification state (modifying | optimizing | completed | failed).
original-iops - The original IOPS rate of the volume.
original-size - The original size of the volume, in GiB.
original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
start-time - The modification start time.
target-iops - The target IOPS rate of the volume.
target-size - The target size of the volume, in GiB.
target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
volume-id - The ID of the volume.
nextToken value returned by a previous paginated request.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of results (up to a limit of 500) to be returned in a paginated request.
- schema:
- type: integer
- 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'
- post:
- x-aws-operation-name: DescribeVolumesModifications
- operationId: POST_DescribeVolumesModifications
- description: 'Describes the most recent volume modification request for the specified EBS volumes.
If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.
You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumesModificationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumesModificationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVpcAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcAttribute - operationId: GET_DescribeVpcAttribute - description: Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcAttributeResult' - parameters: - - name: Attribute - in: query - required: true - description: The VPC attribute. - schema: - type: string - enum: - - enableDnsSupport - - enableDnsHostnames - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeVpcAttribute
- operationId: POST_DescribeVpcAttribute
- description: Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcAttributeResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcAttributeRequest'
- parameters: []
- /?Action=DescribeVpcClassicLink&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeVpcClassicLink
- operationId: GET_DescribeVpcClassicLink
- description: Describes the ClassicLink status of one or more VPCs.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcClassicLinkResult'
- parameters:
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcId
- in: query
- required: false
- description: One or more VPCs for which you want to describe the ClassicLink status.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - xml:
- name: VpcId
- 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'
- post:
- x-aws-operation-name: DescribeVpcClassicLink
- operationId: POST_DescribeVpcClassicLink
- description: Describes the ClassicLink status of one or more VPCs.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcClassicLinkResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcClassicLinkRequest'
- parameters: []
- /?Action=DescribeVpcClassicLinkDnsSupport&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeVpcClassicLinkDnsSupport
- operationId: GET_DescribeVpcClassicLinkDnsSupport
- description: 'Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it''s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportResult'
- parameters:
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 255
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- minLength: 1
- maxLength: 1024
- - name: VpcIds
- in: query
- required: false
- description: One or more VPC IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - xml:
- name: VpcId
- 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'
- post:
- x-aws-operation-name: DescribeVpcClassicLinkDnsSupport
- operationId: POST_DescribeVpcClassicLinkDnsSupport
- description: 'Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it''s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeVpcEndpointConnectionNotifications&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeVpcEndpointConnectionNotifications
- operationId: GET_DescribeVpcEndpointConnectionNotifications
- description: Describes the connection notifications for VPC endpoints and VPC endpoint services.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ConnectionNotificationId
- in: query
- required: false
- description: The ID of the notification.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: One or more filters.
connection-notification-arn - The ARN of the SNS topic for the notification.
connection-notification-id - The ID of the notification.
connection-notification-state - The state of the notification (Enabled | Disabled).
connection-notification-type - The type of notification (Topic).
service-id - The ID of the endpoint service.
vpc-endpoint-id - The ID of the VPC endpoint.
NextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token to request the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeVpcEndpointConnectionNotifications
- operationId: POST_DescribeVpcEndpointConnectionNotifications
- description: Describes the connection notifications for VPC endpoints and VPC endpoint services.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeVpcEndpointConnections&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeVpcEndpointConnections
- operationId: GET_DescribeVpcEndpointConnections
- description: 'Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcEndpointConnectionsResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: One or more filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-id - The ID of the service.
vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-id - The ID of the endpoint.
NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token to retrieve the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeVpcEndpointConnections
- operationId: POST_DescribeVpcEndpointConnections
- description: 'Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcEndpointConnectionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcEndpointConnectionsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeVpcEndpointServiceConfigurations&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeVpcEndpointServiceConfigurations
- operationId: GET_DescribeVpcEndpointServiceConfigurations
- description: Describes the VPC endpoint service configurations in your account (your services).
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ServiceId
- in: query
- required: false
- description: The IDs of one or more services.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointServiceId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
service-name - The name of the service.
service-id - The ID of the service.
service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token to retrieve the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeVpcEndpointServiceConfigurations
- operationId: POST_DescribeVpcEndpointServiceConfigurations
- description: Describes the VPC endpoint service configurations in your account (your services).
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeVpcEndpointServicePermissions&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeVpcEndpointServicePermissions
- operationId: GET_DescribeVpcEndpointServicePermissions
- description: Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ServiceId
- in: query
- required: true
- description: The ID of the service.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: One or more filters.
principal - The ARN of the principal.
principal-type - The principal type (All | Service | OrganizationUnit | Account | User | Role).
NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token to retrieve the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DescribeVpcEndpointServicePermissions
- operationId: POST_DescribeVpcEndpointServicePermissions
- description: Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeVpcEndpointServices&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeVpcEndpointServices
- operationId: GET_DescribeVpcEndpointServices
- description: 'Describes available services to which you can create a VPC endpoint.
When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses us-east-1a and us-east-1c and the consumer uses us-east-1a and us-east-1b, the response includes the VPC endpoint services in the common Availability Zone, us-east-1a.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ServiceName
- in: query
- required: false
- description: One or more service names.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
service-name - The name of the service.
service-type - The type of service (Interface | Gateway).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next set of items to return. (You received this token from a prior call.) - schema: - type: string - 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' - post: - x-aws-operation-name: DescribeVpcEndpointServices - operationId: POST_DescribeVpcEndpointServices - description: 'Describes available services to which you can create a VPC endpoint.
When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses us-east-1a and us-east-1c and the consumer uses us-east-1a and us-east-1b, the response includes the VPC endpoint services in the common Availability Zone, us-east-1a.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcEndpointId
- in: query
- required: false
- description: One or more endpoint IDs.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointId'
- - xml:
- name: item
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-name - The name of the service.
vpc-id - The ID of the VPC in which the endpoint resides.
vpc-endpoint-id - The ID of the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next set of items to return. (You received this token from a prior call.) - schema: - type: string - 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' - post: - x-aws-operation-name: DescribeVpcEndpoints - operationId: POST_DescribeVpcEndpoints - description: Describes one or more of your VPC endpoints. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVpcPeeringConnections&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcPeeringConnections - operationId: GET_DescribeVpcPeeringConnections - description: Describes one or more of your VPC peering connections. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcPeeringConnectionsResult' - parameters: - - name: Filter - in: query - required: false - description: 'One or more filters.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester''s VPC.
requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-peering-connection-id - The ID of the VPC peering connection.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcPeeringConnectionId
- in: query
- required: false
- description: 'One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- 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'
- post:
- x-aws-operation-name: DescribeVpcPeeringConnections
- operationId: POST_DescribeVpcPeeringConnections
- description: Describes one or more of your VPC peering connections.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcPeeringConnectionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcPeeringConnectionsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeVpcs&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeVpcs
- operationId: GET_DescribeVpcs
- description: Describes one or more of your VPCs.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcsResult'
- parameters:
- - name: Filter
- in: query
- required: false
- description: 'One or more filters.
cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC''s CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
is-default - Indicates whether the VPC is the default VPC.
owner-id - The ID of the Amazon Web Services account that owns the VPC.
state - The state of the VPC (pending | available).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC.
One or more VPC IDs.
Default: Describes all your VPCs.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcId' - - xml: - name: VpcId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- 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'
- post:
- x-aws-operation-name: DescribeVpcs
- operationId: POST_DescribeVpcs
- description: Describes one or more of your VPCs.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DescribeVpcsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=DescribeVpnConnections&Version=2016-11-15:
- get:
- x-aws-operation-name: DescribeVpnConnections
- operationId: GET_DescribeVpnConnections
- description: 'Describes one or more of your VPN connections.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpnConnectionsResult' - parameters: - - name: Filter - in: query - required: false - description: 'One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
One or more VPN connection IDs.
Default: Describes your VPN connections.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpnConnectionId' - - xml: - name: VpnConnectionId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeVpnConnections
- operationId: POST_DescribeVpnConnections
- description: 'Describes one or more of your VPN connections.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpnConnectionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpnConnectionsRequest' - parameters: [] - /?Action=DescribeVpnGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpnGateways - operationId: GET_DescribeVpnGateways - description: 'Describes one or more of your virtual private gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpnGatewaysResult' - parameters: - - name: Filter - in: query - required: false - description: 'One or more filters.
amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway (if applicable).
state - The state of the virtual private gateway (pending | available | deleting | deleted).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpnGatewayId' - - xml: - name: VpnGatewayId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DescribeVpnGateways
- operationId: POST_DescribeVpnGateways
- description: 'Describes one or more of your virtual private gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpnGatewaysResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpnGatewaysRequest' - parameters: [] - /?Action=DetachClassicLinkVpc&Version=2016-11-15: - get: - x-aws-operation-name: DetachClassicLinkVpc - operationId: GET_DetachClassicLinkVpc - description: 'Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it''s stopped.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachClassicLinkVpcResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance to unlink from the VPC.
- schema:
- type: string
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC to which the instance is linked.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DetachClassicLinkVpc
- operationId: POST_DetachClassicLinkVpc
- description: 'Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it''s stopped.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DetachClassicLinkVpcResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DetachClassicLinkVpcRequest'
- parameters: []
- /?Action=DetachInternetGateway&Version=2016-11-15:
- get:
- x-aws-operation-name: DetachInternetGateway
- operationId: GET_DetachInternetGateway
- description: 'Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.'
- responses:
- '200':
- description: Success
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InternetGatewayId
- in: query
- required: true
- description: The ID of the internet gateway.
- schema:
- type: string
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DetachInternetGateway
- operationId: POST_DetachInternetGateway
- description: 'Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.'
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DetachInternetGatewayRequest'
- parameters: []
- /?Action=DetachNetworkInterface&Version=2016-11-15:
- get:
- x-aws-operation-name: DetachNetworkInterface
- operationId: GET_DetachNetworkInterface
- description: Detaches a network interface from an instance.
- responses:
- '200':
- description: Success
- parameters:
- - name: AttachmentId
- in: query
- required: true
- description: The ID of the attachment.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Force
- in: query
- required: false
- description: 'Specifies whether to force a detachment.
Use the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.
Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can''t be detached while the instance is running. To detach the root volume, stop the instance first.
When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
For more information, see Detach an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/VolumeAttachment' - parameters: - - name: Device - in: query - required: false - description: The device name. - schema: - type: string - - name: Force - in: query - required: false - description: 'Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won''t have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.' - schema: - type: boolean - - name: InstanceId - in: query - required: false - description: 'The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.' - schema: - type: string - - name: VolumeId - in: query - required: true - description: The ID of the volume. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DetachVolume
- operationId: POST_DetachVolume
- description: 'Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can''t be detached while the instance is running. To detach the root volume, stop the instance first.
When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
For more information, see Detach an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/VolumeAttachment' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachVolumeRequest' - parameters: [] - /?Action=DetachVpnGateway&Version=2016-11-15: - get: - x-aws-operation-name: DetachVpnGateway - operationId: GET_DetachVpnGateway - description:Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).
You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DetachVpnGateway
- operationId: POST_DetachVpnGateway
- description: Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).
You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.
Disables EBS encryption by default for your account in the current Region.
After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.
Disabling encryption by default does not change the encryption status of your existing volumes.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableEbsEncryptionByDefaultResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisableEbsEncryptionByDefault
- operationId: POST_DisableEbsEncryptionByDefault
- description: 'Disables EBS encryption by default for your account in the current Region.
After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.
Disabling encryption by default does not change the encryption status of your existing volumes.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableEbsEncryptionByDefaultResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableEbsEncryptionByDefaultRequest' - parameters: [] - /?Action=DisableFastLaunch&Version=2016-11-15: - get: - x-aws-operation-name: DisableFastLaunch - operationId: GET_DisableFastLaunch - description: 'Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. When you disable faster launching, the AMI uses the standard launch process for each instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.
To change these settings, you must own the AMI.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisableFastLaunch
- operationId: POST_DisableFastLaunch
- description: 'Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. When you disable faster launching, the AMI uses the standard launch process for each instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.
To change these settings, you must own the AMI.
us-east-2a.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: AvailabilityZone
- - name: SourceSnapshotId
- in: query
- required: true
- description: 'The IDs of one or more snapshots. For example, snap-1234567890abcdef0.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SnapshotId'
- - xml:
- name: SnapshotId
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisableFastSnapshotRestores
- operationId: POST_DisableFastSnapshotRestores
- description: Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableFastSnapshotRestoresResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableFastSnapshotRestoresRequest'
- parameters: []
- /?Action=DisableImageDeprecation&Version=2016-11-15:
- get:
- x-aws-operation-name: DisableImageDeprecation
- operationId: GET_DisableImageDeprecation
- description: 'Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableImageDeprecationResult' - parameters: - - name: ImageId - in: query - required: true - description: The ID of the AMI. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisableImageDeprecation
- operationId: POST_DisableImageDeprecation
- description: 'Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableImageDeprecationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableImageDeprecationRequest' - parameters: [] - /?Action=DisableIpamOrganizationAdminAccount&Version=2016-11-15: - get: - x-aws-operation-name: DisableIpamOrganizationAdminAccount - operationId: GET_DisableIpamOrganizationAdminAccount - description: 'Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableIpamOrganizationAdminAccountResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: DelegatedAdminAccountId
- in: query
- required: true
- description: The Organizations member account ID that you want to disable as IPAM account.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DisableIpamOrganizationAdminAccount
- operationId: POST_DisableIpamOrganizationAdminAccount
- description: 'Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. '
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableIpamOrganizationAdminAccountResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableIpamOrganizationAdminAccountRequest'
- parameters: []
- /?Action=DisableSerialConsoleAccess&Version=2016-11-15:
- get:
- x-aws-operation-name: DisableSerialConsoleAccess
- operationId: GET_DisableSerialConsoleAccess
- description: 'Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableSerialConsoleAccessResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisableSerialConsoleAccess
- operationId: POST_DisableSerialConsoleAccess
- description: 'Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableSerialConsoleAccessResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableSerialConsoleAccessRequest'
- parameters: []
- /?Action=DisableTransitGatewayRouteTablePropagation&Version=2016-11-15:
- get:
- x-aws-operation-name: DisableTransitGatewayRouteTablePropagation
- operationId: GET_DisableTransitGatewayRouteTablePropagation
- description: Disables the specified resource attachment from propagating routes to the specified propagation route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationResult'
- parameters:
- - name: TransitGatewayRouteTableId
- in: query
- required: true
- description: The ID of the propagation route table.
- schema:
- type: string
- - name: TransitGatewayAttachmentId
- in: query
- required: true
- description: The ID of the attachment.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisableTransitGatewayRouteTablePropagation
- operationId: POST_DisableTransitGatewayRouteTablePropagation
- description: Disables the specified resource attachment from propagating routes to the specified propagation route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationRequest'
- parameters: []
- /?Action=DisableVgwRoutePropagation&Version=2016-11-15:
- get:
- x-aws-operation-name: DisableVgwRoutePropagation
- operationId: GET_DisableVgwRoutePropagation
- description: Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
- responses:
- '200':
- description: Success
- parameters:
- - name: GatewayId
- in: query
- required: true
- description: The ID of the virtual private gateway.
- schema:
- type: string
- - name: RouteTableId
- in: query
- required: true
- description: The ID of the route table.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisableVgwRoutePropagation
- operationId: POST_DisableVgwRoutePropagation
- description: Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableVgwRoutePropagationRequest'
- parameters: []
- /?Action=DisableVpcClassicLink&Version=2016-11-15:
- get:
- x-aws-operation-name: DisableVpcClassicLink
- operationId: GET_DisableVpcClassicLink
- description: Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableVpcClassicLinkResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: DisableVpcClassicLink
- operationId: POST_DisableVpcClassicLink
- description: Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableVpcClassicLinkResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisableVpcClassicLinkRequest'
- parameters: []
- /?Action=DisableVpcClassicLinkDnsSupport&Version=2016-11-15:
- get:
- x-aws-operation-name: DisableVpcClassicLinkDnsSupport
- operationId: GET_DisableVpcClassicLinkDnsSupport
- description: 'Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it''s linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
You must specify a VPC ID in the request.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportResult' - parameters: - - name: VpcId - in: query - required: false - description: The ID of the VPC. - schema: - type: string - 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' - post: - x-aws-operation-name: DisableVpcClassicLinkDnsSupport - operationId: POST_DisableVpcClassicLinkDnsSupport - description: 'Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it''s linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
You must specify a VPC ID in the request.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportRequest' - parameters: [] - /?Action=DisassociateAddress&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateAddress - operationId: GET_DisassociateAddress - description: 'Disassociates an Elastic IP address from the instance or network interface it''s associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.
' - responses: - '200': - description: Success - parameters: - - name: AssociationId - in: query - required: false - description: '[EC2-VPC] The association ID. Required for EC2-VPC.' - schema: - type: string - - name: PublicIp - in: query - required: false - description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisassociateAddress
- operationId: POST_DisassociateAddress
- description: 'Disassociates an Elastic IP address from the instance or network interface it''s associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateAddressRequest' - parameters: [] - /?Action=DisassociateClientVpnTargetNetwork&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateClientVpnTargetNetwork - operationId: GET_DisassociateClientVpnTargetNetwork - description: 'Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:
The route that was automatically added for the VPC is deleted
All active client connections are terminated
New client connections are disallowed
The Client VPN endpoint''s status changes to pending-associate
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisassociateClientVpnTargetNetwork
- operationId: POST_DisassociateClientVpnTargetNetwork
- description: 'Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:
The route that was automatically added for the VPC is deleted
All active client connections are terminated
New client connections are disallowed
The Client VPN endpoint''s status changes to pending-associate
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisassociateEnclaveCertificateIamRole
- operationId: POST_DisassociateEnclaveCertificateIamRole
- description: 'Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role''s permission to use the KMS key used to encrypt the private key. This effectively revokes the role''s permission to use the certificate.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisassociateEnclaveCertificateIamRoleResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisassociateEnclaveCertificateIamRoleRequest'
- parameters: []
- /?Action=DisassociateIamInstanceProfile&Version=2016-11-15:
- get:
- x-aws-operation-name: DisassociateIamInstanceProfile
- operationId: GET_DisassociateIamInstanceProfile
- description: Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateIamInstanceProfileResult' - parameters: - - name: AssociationId - in: query - required: true - description: The ID of the IAM instance profile association. - schema: - type: string - 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' - post: - x-aws-operation-name: DisassociateIamInstanceProfile - operationId: POST_DisassociateIamInstanceProfile - description:Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateIamInstanceProfileResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateIamInstanceProfileRequest' - parameters: [] - /?Action=DisassociateInstanceEventWindow&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateInstanceEventWindow - operationId: GET_DisassociateInstanceEventWindow - description: 'Disassociates one or more targets from an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateInstanceEventWindowResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceEventWindowId
- in: query
- required: true
- description: The ID of the event window.
- schema:
- type: string
- - name: AssociationTarget
- in: query
- required: true
- description: One or more targets to disassociate from the specified event window.
- schema:
- type: object
- properties:
- InstanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceIdList'
- - description: The IDs of the instances to disassociate from the event window.
- InstanceTag:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window.
- DedicatedHostId:
- allOf:
- - $ref: '#/components/schemas/DedicatedHostIdList'
- - description: The IDs of the Dedicated Hosts to disassociate from the event window.
- description: The targets to disassociate from the specified event window.
- 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'
- post:
- x-aws-operation-name: DisassociateInstanceEventWindow
- operationId: POST_DisassociateInstanceEventWindow
- description: 'Disassociates one or more targets from an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateInstanceEventWindowResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateInstanceEventWindowRequest' - parameters: [] - /?Action=DisassociateRouteTable&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateRouteTable - operationId: GET_DisassociateRouteTable - description: 'Disassociates a subnet or gateway from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC''s main route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - parameters: - - name: AssociationId - in: query - required: true - description: The association ID representing the current association between the route table and subnet or gateway. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisassociateRouteTable
- operationId: POST_DisassociateRouteTable
- description: 'Disassociates a subnet or gateway from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC''s main route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateRouteTableRequest' - parameters: [] - /?Action=DisassociateSubnetCidrBlock&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateSubnetCidrBlock - operationId: GET_DisassociateSubnetCidrBlock - description: 'Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateSubnetCidrBlockResult' - parameters: - - name: AssociationId - in: query - required: true - description: The association ID for the CIDR block. - schema: - type: string - 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' - post: - x-aws-operation-name: DisassociateSubnetCidrBlock - operationId: POST_DisassociateSubnetCidrBlock - description: 'Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateSubnetCidrBlockResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateSubnetCidrBlockRequest' - parameters: [] - /?Action=DisassociateTransitGatewayMulticastDomain&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateTransitGatewayMulticastDomain - operationId: GET_DisassociateTransitGatewayMulticastDomain - description: 'Disassociates the specified subnets from the transit gateway multicast domain. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the attachment. - schema: - type: string - - name: SubnetIds - in: query - required: false - description: The IDs of the subnets; - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisassociateTransitGatewayMulticastDomain
- operationId: POST_DisassociateTransitGatewayMulticastDomain
- description: 'Disassociates the specified subnets from the transit gateway multicast domain. '
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainRequest'
- parameters: []
- /?Action=DisassociateTransitGatewayRouteTable&Version=2016-11-15:
- get:
- x-aws-operation-name: DisassociateTransitGatewayRouteTable
- operationId: GET_DisassociateTransitGatewayRouteTable
- description: Disassociates a resource attachment from a transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisassociateTransitGatewayRouteTableResult'
- parameters:
- - name: TransitGatewayRouteTableId
- in: query
- required: true
- description: The ID of the transit gateway route table.
- schema:
- type: string
- - name: TransitGatewayAttachmentId
- in: query
- required: true
- description: The ID of the attachment.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisassociateTransitGatewayRouteTable
- operationId: POST_DisassociateTransitGatewayRouteTable
- description: Disassociates a resource attachment from a transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisassociateTransitGatewayRouteTableResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/DisassociateTransitGatewayRouteTableRequest'
- parameters: []
- /?Action=DisassociateTrunkInterface&Version=2016-11-15:
- get:
- x-aws-operation-name: DisassociateTrunkInterface
- operationId: GET_DisassociateTrunkInterface
- description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Removes an association between a branch network interface with a trunk network interface.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTrunkInterfaceResult' - parameters: - - name: AssociationId - in: query - required: true - description: The ID of the association - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: DisassociateTrunkInterface
- operationId: POST_DisassociateTrunkInterface
- description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Removes an association between a branch network interface with a trunk network interface.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTrunkInterfaceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTrunkInterfaceRequest' - parameters: [] - /?Action=DisassociateVpcCidrBlock&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateVpcCidrBlock - operationId: GET_DisassociateVpcCidrBlock - description: 'Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateVpcCidrBlockResult' - parameters: - - name: AssociationId - in: query - required: true - description: The association ID for the CIDR block. - schema: - type: string - 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' - post: - x-aws-operation-name: DisassociateVpcCidrBlock - operationId: POST_DisassociateVpcCidrBlock - description: 'Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateVpcCidrBlockResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateVpcCidrBlockRequest' - parameters: [] - /?Action=EnableEbsEncryptionByDefault&Version=2016-11-15: - get: - x-aws-operation-name: EnableEbsEncryptionByDefault - operationId: GET_EnableEbsEncryptionByDefault - description: 'Enables EBS encryption by default for your account in the current Region.
After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
Enabling encryption by default has no effect on the encryption status of your existing volumes.
After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableEbsEncryptionByDefaultResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: EnableEbsEncryptionByDefault
- operationId: POST_EnableEbsEncryptionByDefault
- description: 'Enables EBS encryption by default for your account in the current Region.
After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
Enabling encryption by default has no effect on the encryption status of your existing volumes.
After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableEbsEncryptionByDefaultResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableEbsEncryptionByDefaultRequest' - parameters: [] - /?Action=EnableFastLaunch&Version=2016-11-15: - get: - x-aws-operation-name: EnableFastLaunch - operationId: GET_EnableFastLaunch - description: 'When you enable faster launching for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.
To change these settings, you must own the AMI.
snapshot, which is the default value.'
- schema:
- type: string
- - name: SnapshotConfiguration
- in: query
- required: false
- description: Configuration settings for creating and managing the snapshots that are used for pre-provisioning the Windows AMI for faster launching. The associated ResourceType must be snapshot.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
- description: Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
- - name: LaunchTemplate
- in: query
- required: false
- description: 'The launch template to use when launching Windows instances from pre-provisioned snapshots. Launch template parameters can include either the name or ID of the launch template, but not both.'
- schema:
- type: object
- required:
- - Version
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The version of the launch template to use for faster launching for a Windows AMI.
- description: 'Request to create a launch template for a fast-launch enabled Windows AMI.
Note - You can specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
6 or greater. '
- schema:
- type: integer
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: EnableFastLaunch
- operationId: POST_EnableFastLaunch
- description: 'When you enable faster launching for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.
To change these settings, you must own the AMI.
Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.
You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores.
For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableFastSnapshotRestoresResult' - parameters: - - name: AvailabilityZone - in: query - required: true - description: 'One or more Availability Zones. For example,us-east-2a.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: AvailabilityZone
- - name: SourceSnapshotId
- in: query
- required: true
- description: 'The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify a snapshot that was shared with you from another Amazon Web Services account.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SnapshotId'
- - xml:
- name: SnapshotId
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: EnableFastSnapshotRestores
- operationId: POST_EnableFastSnapshotRestores
- description: 'Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.
You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores.
For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableFastSnapshotRestoresResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableFastSnapshotRestoresRequest' - parameters: [] - /?Action=EnableImageDeprecation&Version=2016-11-15: - get: - x-aws-operation-name: EnableImageDeprecation - operationId: GET_EnableImageDeprecation - description: 'Enables deprecation of the specified AMI at the specified date and time.
For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableImageDeprecationResult' - parameters: - - name: ImageId - in: query - required: true - description: The ID of the AMI. - schema: - type: string - - name: DeprecateAt - in: query - required: true - description: 'The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
You can’t specify a date in the past. The upper limit for DeprecateAt is 10 years from now.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: EnableImageDeprecation
- operationId: POST_EnableImageDeprecation
- description: 'Enables deprecation of the specified AMI at the specified date and time.
For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableImageDeprecationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableImageDeprecationRequest' - parameters: [] - /?Action=EnableIpamOrganizationAdminAccount&Version=2016-11-15: - get: - x-aws-operation-name: EnableIpamOrganizationAdminAccount - operationId: GET_EnableIpamOrganizationAdminAccount - description: 'Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableIpamOrganizationAdminAccountResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: DelegatedAdminAccountId
- in: query
- required: true
- description: The Organizations member account ID that you want to enable as the IPAM account.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: EnableIpamOrganizationAdminAccount
- operationId: POST_EnableIpamOrganizationAdminAccount
- description: 'Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. '
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableIpamOrganizationAdminAccountResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableIpamOrganizationAdminAccountRequest'
- parameters: []
- /?Action=EnableSerialConsoleAccess&Version=2016-11-15:
- get:
- x-aws-operation-name: EnableSerialConsoleAccess
- operationId: GET_EnableSerialConsoleAccess
- description: 'Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableSerialConsoleAccessResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: EnableSerialConsoleAccess
- operationId: POST_EnableSerialConsoleAccess
- description: 'Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableSerialConsoleAccessResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableSerialConsoleAccessRequest'
- parameters: []
- /?Action=EnableTransitGatewayRouteTablePropagation&Version=2016-11-15:
- get:
- x-aws-operation-name: EnableTransitGatewayRouteTablePropagation
- operationId: GET_EnableTransitGatewayRouteTablePropagation
- description: Enables the specified attachment to propagate routes to the specified propagation route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationResult'
- parameters:
- - name: TransitGatewayRouteTableId
- in: query
- required: true
- description: The ID of the propagation route table.
- schema:
- type: string
- - name: TransitGatewayAttachmentId
- in: query
- required: true
- description: The ID of the attachment.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: EnableTransitGatewayRouteTablePropagation
- operationId: POST_EnableTransitGatewayRouteTablePropagation
- description: Enables the specified attachment to propagate routes to the specified propagation route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationRequest'
- parameters: []
- /?Action=EnableVgwRoutePropagation&Version=2016-11-15:
- get:
- x-aws-operation-name: EnableVgwRoutePropagation
- operationId: GET_EnableVgwRoutePropagation
- description: Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
- responses:
- '200':
- description: Success
- parameters:
- - name: GatewayId
- in: query
- required: true
- description: 'The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with. '
- schema:
- type: string
- - name: RouteTableId
- in: query
- required: true
- description: 'The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to. '
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: EnableVgwRoutePropagation
- operationId: POST_EnableVgwRoutePropagation
- description: Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableVgwRoutePropagationRequest'
- parameters: []
- /?Action=EnableVolumeIO&Version=2016-11-15:
- get:
- x-aws-operation-name: EnableVolumeIO
- operationId: GET_EnableVolumeIO
- description: Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
- responses:
- '200':
- description: Success
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VolumeId
- in: query
- required: true
- description: The ID of the volume.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: EnableVolumeIO
- operationId: POST_EnableVolumeIO
- description: Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableVolumeIORequest'
- parameters: []
- /?Action=EnableVpcClassicLink&Version=2016-11-15:
- get:
- x-aws-operation-name: EnableVpcClassicLink
- operationId: GET_EnableVpcClassicLink
- description: 'Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableVpcClassicLinkResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: EnableVpcClassicLink
- operationId: POST_EnableVpcClassicLink
- description: 'Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableVpcClassicLinkResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/EnableVpcClassicLinkRequest'
- parameters: []
- /?Action=EnableVpcClassicLinkDnsSupport&Version=2016-11-15:
- get:
- x-aws-operation-name: EnableVpcClassicLinkDnsSupport
- operationId: GET_EnableVpcClassicLinkDnsSupport
- description: 'Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it''s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
You must specify a VPC ID in the request.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportResult' - parameters: - - name: VpcId - in: query - required: false - description: The ID of the VPC. - schema: - type: string - 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' - post: - x-aws-operation-name: EnableVpcClassicLinkDnsSupport - operationId: POST_EnableVpcClassicLinkDnsSupport - description: 'Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it''s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
You must specify a VPC ID in the request.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportRequest' - parameters: [] - /?Action=ExportClientVpnClientCertificateRevocationList&Version=2016-11-15: - get: - x-aws-operation-name: ExportClientVpnClientCertificateRevocationList - operationId: GET_ExportClientVpnClientCertificateRevocationList - description: Downloads the client certificate revocation list for the specified Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ExportClientVpnClientCertificateRevocationList
- operationId: POST_ExportClientVpnClientCertificateRevocationList
- description: Downloads the client certificate revocation list for the specified Client VPN endpoint.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListRequest'
- parameters: []
- /?Action=ExportClientVpnClientConfiguration&Version=2016-11-15:
- get:
- x-aws-operation-name: ExportClientVpnClientConfiguration
- operationId: GET_ExportClientVpnClientConfiguration
- description: Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ExportClientVpnClientConfigurationResult'
- parameters:
- - name: ClientVpnEndpointId
- in: query
- required: true
- description: The ID of the Client VPN endpoint.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ExportClientVpnClientConfiguration
- operationId: POST_ExportClientVpnClientConfiguration
- description: Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ExportClientVpnClientConfigurationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ExportClientVpnClientConfigurationRequest'
- parameters: []
- /?Action=ExportImage&Version=2016-11-15:
- get:
- x-aws-operation-name: ExportImage
- operationId: GET_ExportImage
- description: 'Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ExportImageResult'
- parameters:
- - name: ClientToken
- in: query
- required: false
- description: Token to enable idempotency for export image requests.
- schema:
- type: string
- - name: Description
- in: query
- required: false
- description: A description of the image being exported. The maximum length is 255 characters.
- schema:
- type: string
- - name: DiskImageFormat
- in: query
- required: true
- description: The disk image format.
- schema:
- type: string
- enum:
- - VMDK
- - RAW
- - VHD
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ImageId
- in: query
- required: true
- description: The ID of the image.
- schema:
- type: string
- - name: S3ExportLocation
- in: query
- required: true
- description: Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.
- schema:
- type: object
- required:
- - S3Bucket
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The prefix (logical hierarchy) in the bucket.
- description: Describes the destination for an export image task.
- - name: RoleName
- in: query
- required: false
- description: 'The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named ''vmimport''.'
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply to the export image task during creation.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: ExportImage
- operationId: POST_ExportImage
- description: 'Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ExportImageResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ExportImageRequest'
- parameters: []
- /?Action=ExportTransitGatewayRoutes&Version=2016-11-15:
- get:
- x-aws-operation-name: ExportTransitGatewayRoutes
- operationId: GET_ExportTransitGatewayRoutes
- description: 'Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.
The routes are saved to the specified bucket in a JSON file. For more information, see Export Route Tables to Amazon S3 in Transit Gateways.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportTransitGatewayRoutesResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the route table. - schema: - type: string - - name: Filter - in: query - required: false - description: 'One or more filters. The possible values are:
attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
transit-gateway-route-destination-cidr-block - The CIDR range.
type - The type of route (propagated | static).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ExportTransitGatewayRoutes
- operationId: POST_ExportTransitGatewayRoutes
- description: 'Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.
The routes are saved to the specified bucket in a JSON file. For more information, see Export Route Tables to Amazon S3 in Transit Gateways.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportTransitGatewayRoutesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportTransitGatewayRoutesRequest' - parameters: [] - /?Action=GetAssociatedEnclaveCertificateIamRoles&Version=2016-11-15: - get: - x-aws-operation-name: GetAssociatedEnclaveCertificateIamRoles - operationId: GET_GetAssociatedEnclaveCertificateIamRoles - description: 'Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key that''s used to encrypt the private key.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetAssociatedEnclaveCertificateIamRolesResult' - parameters: - - name: CertificateArn - in: query - required: false - description: 'The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon S3 object information.' - schema: - type: string - minLength: 1 - maxLength: 1283 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetAssociatedEnclaveCertificateIamRoles
- operationId: POST_GetAssociatedEnclaveCertificateIamRoles
- description: 'Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key that''s used to encrypt the private key.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetAssociatedEnclaveCertificateIamRolesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetAssociatedEnclaveCertificateIamRolesRequest'
- parameters: []
- /?Action=GetAssociatedIpv6PoolCidrs&Version=2016-11-15:
- get:
- x-aws-operation-name: GetAssociatedIpv6PoolCidrs
- operationId: GET_GetAssociatedIpv6PoolCidrs
- description: Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetAssociatedIpv6PoolCidrsResult'
- parameters:
- - name: PoolId
- in: query
- required: true
- description: The ID of the IPv6 address pool.
- schema:
- type: string
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 1000
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetAssociatedIpv6PoolCidrs
- operationId: POST_GetAssociatedIpv6PoolCidrs
- description: Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetAssociatedIpv6PoolCidrsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetAssociatedIpv6PoolCidrsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetCapacityReservationUsage&Version=2016-11-15:
- get:
- x-aws-operation-name: GetCapacityReservationUsage
- operationId: GET_GetCapacityReservationUsage
- description: 'Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner''s usage.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetCapacityReservationUsageResult'
- parameters:
- - name: CapacityReservationId
- in: query
- required: true
- description: The ID of the Capacity Reservation.
- schema:
- type: string
- - name: NextToken
- in: query
- required: false
- description: The token to use to retrieve the next page of results.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
' - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetCapacityReservationUsage
- operationId: POST_GetCapacityReservationUsage
- description: 'Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner''s usage.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetCapacityReservationUsageResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetCapacityReservationUsageRequest'
- parameters: []
- /?Action=GetCoipPoolUsage&Version=2016-11-15:
- get:
- x-aws-operation-name: GetCoipPoolUsage
- operationId: GET_GetCoipPoolUsage
- description: Describes the allocations from the specified customer-owned address pool.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetCoipPoolUsageResult'
- parameters:
- - name: PoolId
- in: query
- required: true
- description: The ID of the address pool.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: One or more filters.
coip-address-usage.allocation-id - The allocation ID of the address.
coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address.
coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address.
coip-address-usage.co-ip - The customer-owned IP address.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetCoipPoolUsage
- operationId: POST_GetCoipPoolUsage
- description: Describes the allocations from the specified customer-owned address pool.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetCoipPoolUsageResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetCoipPoolUsageRequest'
- parameters: []
- /?Action=GetConsoleOutput&Version=2016-11-15:
- get:
- x-aws-operation-name: GetConsoleOutput
- operationId: GET_GetConsoleOutput
- description: 'Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetConsoleOutputResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Latest
- in: query
- required: false
- description: 'When enabled, retrieves the latest console output for the instance.
Default: disabled (false)
Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetConsoleOutputResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetConsoleOutputRequest' - parameters: [] - /?Action=GetConsoleScreenshot&Version=2016-11-15: - get: - x-aws-operation-name: GetConsoleScreenshot - operationId: GET_GetConsoleScreenshot - description:Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetConsoleScreenshotResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance.
- schema:
- type: string
- - name: WakeUp
- in: query
- required: false
- description: 'When set to true, acts as keystroke input and wakes up an instance that''s in standby or "sleep" mode.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetConsoleScreenshot
- operationId: POST_GetConsoleScreenshot
- description: Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetConsoleScreenshotResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetConsoleScreenshotRequest' - parameters: [] - /?Action=GetDefaultCreditSpecification&Version=2016-11-15: - get: - x-aws-operation-name: GetDefaultCreditSpecification - operationId: GET_GetDefaultCreditSpecification - description: 'Describes the default credit option for CPU usage of a burstable performance instance family.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetDefaultCreditSpecificationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceFamily
- in: query
- required: true
- description: The instance family.
- schema:
- type: string
- enum:
- - t2
- - t3
- - t3a
- - t4g
- 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'
- post:
- x-aws-operation-name: GetDefaultCreditSpecification
- operationId: POST_GetDefaultCreditSpecification
- description: 'Describes the default credit option for CPU usage of a burstable performance instance family.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetDefaultCreditSpecificationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetDefaultCreditSpecificationRequest' - parameters: [] - /?Action=GetEbsDefaultKmsKeyId&Version=2016-11-15: - get: - x-aws-operation-name: GetEbsDefaultKmsKeyId - operationId: GET_GetEbsDefaultKmsKeyId - description: 'Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetEbsDefaultKmsKeyIdResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetEbsDefaultKmsKeyId
- operationId: POST_GetEbsDefaultKmsKeyId
- description: 'Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetEbsDefaultKmsKeyIdResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetEbsDefaultKmsKeyIdRequest' - parameters: [] - /?Action=GetEbsEncryptionByDefault&Version=2016-11-15: - get: - x-aws-operation-name: GetEbsEncryptionByDefault - operationId: GET_GetEbsEncryptionByDefault - description: 'Describes whether EBS encryption by default is enabled for your account in the current Region.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetEbsEncryptionByDefaultResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetEbsEncryptionByDefault
- operationId: POST_GetEbsEncryptionByDefault
- description: 'Describes whether EBS encryption by default is enabled for your account in the current Region.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetEbsEncryptionByDefaultResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetEbsEncryptionByDefaultRequest' - parameters: [] - /?Action=GetFlowLogsIntegrationTemplate&Version=2016-11-15: - get: - x-aws-operation-name: GetFlowLogsIntegrationTemplate - operationId: GET_GetFlowLogsIntegrationTemplate - description: 'Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:
Create a table in Athena that maps fields to a custom log format
Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis
Create a table partitioned between two timestamps in the past
Create a set of named queries in Athena that you can use to get started quickly
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: FlowLogId
- in: query
- required: true
- description: The ID of the flow log.
- schema:
- type: string
- - name: ConfigDeliveryS3DestinationArn
- in: query
- required: true
- description: 'To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.'
- schema:
- type: string
- - name: IntegrateService
- in: query
- required: true
- description: Information about the service integration.
- schema:
- type: object
- properties:
- AthenaIntegration:
- allOf:
- - $ref: '#/components/schemas/AthenaIntegrationsSet'
- - description: Information about the integration with Amazon Athena.
- description: Describes service integrations with VPC Flow logs.
- 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'
- post:
- x-aws-operation-name: GetFlowLogsIntegrationTemplate
- operationId: POST_GetFlowLogsIntegrationTemplate
- description: 'Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:
Create a table in Athena that maps fields to a custom log format
Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis
Create a table partitioned between two timestamps in the past
Create a set of named queries in Athena that you can use to get started quickly
nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
- schema:
- type: integer
- minimum: 1
- maximum: 1000
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetGroupsForCapacityReservation
- operationId: POST_GetGroupsForCapacityReservation
- description: Lists the resource groups to which a Capacity Reservation has been added.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetGroupsForCapacityReservationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetGroupsForCapacityReservationRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetHostReservationPurchasePreview&Version=2016-11-15:
- get:
- x-aws-operation-name: GetHostReservationPurchasePreview
- operationId: GET_GetHostReservationPurchasePreview
- description: Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.
This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetHostReservationPurchasePreviewResult' - parameters: - - name: HostIdSet - in: query - required: true - description: The IDs of the Dedicated Hosts with which the reservation is associated. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - xml: - name: item - - name: OfferingId - in: query - required: true - description: The offering ID of the reservation. - schema: - type: string - 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' - post: - x-aws-operation-name: GetHostReservationPurchasePreview - operationId: POST_GetHostReservationPurchasePreview - description:Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.
This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetHostReservationPurchasePreviewResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetHostReservationPurchasePreviewRequest' - parameters: [] - /?Action=GetInstanceTypesFromInstanceRequirements&Version=2016-11-15: - get: - x-aws-operation-name: GetInstanceTypesFromInstanceRequirements - operationId: GET_GetInstanceTypesFromInstanceRequirements - description: 'Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceTypesFromInstanceRequirementsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ArchitectureType
- in: query
- required: true
- description: The processor architecture type.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ArchitectureType'
- - xml:
- name: item
- minItems: 0
- maxItems: 3
- - name: VirtualizationType
- in: query
- required: true
- description: The virtualization type.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VirtualizationType'
- - xml:
- name: item
- minItems: 0
- maxItems: 2
- - name: InstanceRequirements
- in: query
- required: true
- description: The attributes required for the instance types.
- schema:
- type: object
- required:
- - VCpuCount
- - MemoryMiB
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/MemoryMiBRequest'
- - description: 'The minimum and maximum amount of memory, in MiB.'
- CpuManufacturer:
- allOf:
- - $ref: '#/components/schemas/MemoryGiBPerVCpuRequest'
- - description: 'The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
' - ExcludedInstanceType: - allOf: - - $ref: '#/components/schemas/ExcludedInstanceTypeSet' - - description: 'The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
Default: No excluded instance types
' - InstanceGeneration: - allOf: - - $ref: '#/components/schemas/LocalStorage' - - description: 'Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
To include instance types with instance store volumes, specify included.
To require only instance types with instance store volumes, specify required.
To exclude instance types with instance store volumes, specify excluded.
Default: included
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
' - AcceleratorType: - allOf: - - $ref: '#/components/schemas/AcceleratorCountRequest' - - description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
' - AcceleratorManufacturer: - allOf: - - $ref: '#/components/schemas/AcceleratorManufacturerSet' - - description: 'Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
' - AcceleratorName: - allOf: - - $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest' - - description: 'The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
' - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
You must specify VCpuCount and MemoryMiB. All other parameters are optional. Any unspecified optional parameter is set to its default.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
' - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returnedNextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token for the next set of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: GetInstanceTypesFromInstanceRequirements
- operationId: POST_GetInstanceTypesFromInstanceRequirements
- description: 'Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceTypesFromInstanceRequirementsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceTypesFromInstanceRequirementsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetInstanceUefiData&Version=2016-11-15: - get: - x-aws-operation-name: GetInstanceUefiData - operationId: GET_GetInstanceUefiData - description: 'A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded.
When you use register-image to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on GitHub. You can use the tool to convert the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert back into the binary format to use with register-image.
For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceUefiDataResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance from which to retrieve the UEFI data. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetInstanceUefiData
- operationId: POST_GetInstanceUefiData
- description: 'A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded.
When you use register-image to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on GitHub. You can use the tool to convert the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert back into the binary format to use with register-image.
For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceUefiDataResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceUefiDataRequest' - parameters: [] - /?Action=GetIpamAddressHistory&Version=2016-11-15: - get: - x-aws-operation-name: GetIpamAddressHistory - operationId: GET_GetIpamAddressHistory - description: 'Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamAddressHistoryResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Cidr
- in: query
- required: true
- description: 'The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.'
- schema:
- type: string
- - name: IpamScopeId
- in: query
- required: true
- description: The ID of the IPAM scope that the CIDR is in.
- schema:
- type: string
- - name: VpcId
- in: query
- required: false
- description: The ID of the VPC you want your history records filtered by.
- schema:
- type: string
- - name: StartTime
- in: query
- required: false
- description: 'The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.'
- schema:
- type: string
- format: date-time
- - name: EndTime
- in: query
- required: false
- description: 'The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.'
- schema:
- type: string
- format: date-time
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of historical results you would like returned per page. Defaults to 100.
- schema:
- type: integer
- minimum: 1
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: GetIpamAddressHistory
- operationId: POST_GetIpamAddressHistory
- description: 'Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetIpamAddressHistoryResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetIpamAddressHistoryRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetIpamPoolAllocations&Version=2016-11-15:
- get:
- x-aws-operation-name: GetIpamPoolAllocations
- operationId: GET_GetIpamPoolAllocations
- description: Get a list of all the CIDR allocations in an IPAM pool.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetIpamPoolAllocationsResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamPoolId
- in: query
- required: true
- description: The ID of the IPAM pool you want to see the allocations for.
- schema:
- type: string
- - name: IpamPoolAllocationId
- in: query
- required: false
- description: The ID of the allocation.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Filter'
- - xml:
- name: Filter
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of results you would like returned per page.
- schema:
- type: integer
- minimum: 1000
- maximum: 100000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: GetIpamPoolAllocations
- operationId: POST_GetIpamPoolAllocations
- description: Get a list of all the CIDR allocations in an IPAM pool.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetIpamPoolAllocationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetIpamPoolAllocationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetIpamPoolCidrs&Version=2016-11-15:
- get:
- x-aws-operation-name: GetIpamPoolCidrs
- operationId: GET_GetIpamPoolCidrs
- description: Get the CIDRs provisioned to an IPAM pool.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetIpamPoolCidrsResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamPoolId
- in: query
- required: true
- description: The ID of the IPAM pool you want the CIDR for.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Filter'
- - xml:
- name: Filter
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of results to return in the request.
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: GetIpamPoolCidrs
- operationId: POST_GetIpamPoolCidrs
- description: Get the CIDRs provisioned to an IPAM pool.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetIpamPoolCidrsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetIpamPoolCidrsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetIpamResourceCidrs&Version=2016-11-15:
- get:
- x-aws-operation-name: GetIpamResourceCidrs
- operationId: GET_GetIpamResourceCidrs
- description: Get information about the resources in a scope.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetIpamResourceCidrsResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Filter
- in: query
- required: false
- description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Filter'
- - xml:
- name: Filter
- - name: MaxResults
- in: query
- required: false
- description: The maximum number of results to return in the request.
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: IpamScopeId
- in: query
- required: true
- description: The ID of the scope that the resource is in.
- schema:
- type: string
- - name: IpamPoolId
- in: query
- required: false
- description: The ID of the IPAM pool that the resource is in.
- schema:
- type: string
- - name: ResourceId
- in: query
- required: false
- description: The ID of the resource.
- schema:
- type: string
- - name: ResourceType
- in: query
- required: false
- description: The resource type.
- schema:
- type: string
- enum:
- - vpc
- - subnet
- - eip
- - public-ipv4-pool
- - ipv6-pool
- - name: ResourceTag
- in: query
- required: false
- description: ''
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The value for the tag.
- description: A tag on an IPAM resource.
- - name: ResourceOwner
- in: query
- required: false
- description: The ID of the Amazon Web Services account that owns the resource.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: GetIpamResourceCidrs
- operationId: POST_GetIpamResourceCidrs
- description: Get information about the resources in a scope.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetIpamResourceCidrsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetIpamResourceCidrsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetLaunchTemplateData&Version=2016-11-15:
- get:
- x-aws-operation-name: GetLaunchTemplateData
- operationId: GET_GetLaunchTemplateData
- description: 'Retrieves the configuration data of the specified instance. You can use this data to create a launch template.
This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, DescribeVolumes, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: GetLaunchTemplateData
- operationId: POST_GetLaunchTemplateData
- description: 'Retrieves the configuration data of the specified instance. You can use this data to create a launch template.
This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, DescribeVolumes, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PrefixListId
- in: query
- required: true
- description: The ID of the prefix list.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 255
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: GetManagedPrefixListAssociations
- operationId: POST_GetManagedPrefixListAssociations
- description: Gets information about the resources that are associated with the specified managed prefix list.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetManagedPrefixListAssociationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetManagedPrefixListAssociationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetManagedPrefixListEntries&Version=2016-11-15:
- get:
- x-aws-operation-name: GetManagedPrefixListEntries
- operationId: GET_GetManagedPrefixListEntries
- description: Gets information about the entries for a specified managed prefix list.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetManagedPrefixListEntriesResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PrefixListId
- in: query
- required: true
- description: The ID of the prefix list.
- schema:
- type: string
- - name: TargetVersion
- in: query
- required: false
- description: The version of the prefix list for which to return the entries. The default is the current version.
- schema:
- type: integer
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 100
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: GetManagedPrefixListEntries
- operationId: POST_GetManagedPrefixListEntries
- description: Gets information about the entries for a specified managed prefix list.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetManagedPrefixListEntriesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetManagedPrefixListEntriesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetNetworkInsightsAccessScopeAnalysisFindings&Version=2016-11-15:
- get:
- x-aws-operation-name: GetNetworkInsightsAccessScopeAnalysisFindings
- operationId: GET_GetNetworkInsightsAccessScopeAnalysisFindings
- description: Gets the findings for the specified Network Access Scope analysis.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetNetworkInsightsAccessScopeAnalysisFindingsResult'
- parameters:
- - name: NetworkInsightsAccessScopeAnalysisId
- in: query
- required: true
- description: The ID of the Network Access Scope analysis.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 1
- maximum: 100
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetNetworkInsightsAccessScopeAnalysisFindings
- operationId: POST_GetNetworkInsightsAccessScopeAnalysisFindings
- description: Gets the findings for the specified Network Access Scope analysis.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetNetworkInsightsAccessScopeAnalysisFindingsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetNetworkInsightsAccessScopeAnalysisFindingsRequest'
- parameters: []
- /?Action=GetNetworkInsightsAccessScopeContent&Version=2016-11-15:
- get:
- x-aws-operation-name: GetNetworkInsightsAccessScopeContent
- operationId: GET_GetNetworkInsightsAccessScopeContent
- description: Gets the content for the specified Network Access Scope.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetNetworkInsightsAccessScopeContentResult'
- parameters:
- - name: NetworkInsightsAccessScopeId
- in: query
- required: true
- description: The ID of the Network Access Scope.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetNetworkInsightsAccessScopeContent
- operationId: POST_GetNetworkInsightsAccessScopeContent
- description: Gets the content for the specified Network Access Scope.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetNetworkInsightsAccessScopeContentResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetNetworkInsightsAccessScopeContentRequest'
- parameters: []
- /?Action=GetPasswordData&Version=2016-11-15:
- get:
- x-aws-operation-name: GetPasswordData
- operationId: GET_GetPasswordData
- description: 'Retrieves the encrypted administrator password for a running Windows instance.
The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon EC2 User Guide.
For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it''s available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetPasswordDataResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the Windows instance. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetPasswordData
- operationId: POST_GetPasswordData
- description: 'Retrieves the encrypted administrator password for a running Windows instance.
The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon EC2 User Guide.
For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it''s available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetPasswordDataResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetPasswordDataRequest' - parameters: [] - /?Action=GetReservedInstancesExchangeQuote&Version=2016-11-15: - get: - x-aws-operation-name: GetReservedInstancesExchangeQuote - operationId: GET_GetReservedInstancesExchangeQuote - description: 'Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetReservedInstancesExchangeQuoteResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ReservedInstanceId
- in: query
- required: true
- description: The IDs of the Convertible Reserved Instances to exchange.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservationId'
- - xml:
- name: ReservedInstanceId
- - name: TargetConfiguration
- in: query
- required: false
- description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TargetConfigurationRequest'
- - xml:
- name: TargetConfigurationRequest
- 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'
- post:
- x-aws-operation-name: GetReservedInstancesExchangeQuote
- operationId: POST_GetReservedInstancesExchangeQuote
- description: 'Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetReservedInstancesExchangeQuoteResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetReservedInstancesExchangeQuoteRequest'
- parameters: []
- /?Action=GetSerialConsoleAccessStatus&Version=2016-11-15:
- get:
- x-aws-operation-name: GetSerialConsoleAccessStatus
- operationId: GET_GetSerialConsoleAccessStatus
- description: 'Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetSerialConsoleAccessStatusResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetSerialConsoleAccessStatus
- operationId: POST_GetSerialConsoleAccessStatus
- description: 'Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetSerialConsoleAccessStatusResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetSerialConsoleAccessStatusRequest'
- parameters: []
- /?Action=GetSpotPlacementScores&Version=2016-11-15:
- get:
- x-aws-operation-name: GetSpotPlacementScores
- operationId: GET_GetSpotPlacementScores
- description: 'Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.
You can specify your compute requirements either by using InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using InstanceTypes.
For more information, see Spot placement score in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSpotPlacementScoresResult' - parameters: - - name: InstanceType - in: query - required: false - description: 'The instance types. We recommend that you specify at least three instance types. If you specify one or two instance types, or specify variations of a single instance type (for example, an m3.xlarge with and without instance storage), the returned placement score will always be low.
If you specify InstanceTypes, you can''t specify InstanceRequirementsWithMetadata.
The unit for the target capacity.
Default: units (translates to number of instances)
Specify true so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions.
A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone.
' - schema: - type: boolean - - name: RegionName - in: query - required: false - description: 'The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,us-east-1.'
- schema:
- type: array
- items:
- $ref: '#/components/schemas/String'
- minItems: 0
- maxItems: 10
- - name: InstanceRequirementsWithMetadata
- in: query
- required: false
- description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadata, you can''t specify InstanceTypes.
The architecture type, virtualization type, and other attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadataRequest, you can''t specify InstanceTypes.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return in a single call. Specify a value between 1 and
1000. The default value is 1000. To retrieve the remaining results, make another call with
the returned NextToken value.'
- schema:
- type: integer
- minimum: 10
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next set of results.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: GetSpotPlacementScores
- operationId: POST_GetSpotPlacementScores
- description: 'Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.
You can specify your compute requirements either by using InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using InstanceTypes.
For more information, see Spot placement score in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSpotPlacementScoresResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSpotPlacementScoresRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetSubnetCidrReservations&Version=2016-11-15: - get: - x-aws-operation-name: GetSubnetCidrReservations - operationId: GET_GetSubnetCidrReservations - description: Gets information about the subnet CIDR reservations. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSubnetCidrReservationsResult' - parameters: - - name: Filter - in: query - required: false - description: 'One or more filters.
reservationType - The type of reservation (prefix | explicit).
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- 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'
- post:
- x-aws-operation-name: GetSubnetCidrReservations
- operationId: POST_GetSubnetCidrReservations
- description: Gets information about the subnet CIDR reservations.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetSubnetCidrReservationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetSubnetCidrReservationsRequest'
- parameters: []
- /?Action=GetTransitGatewayAttachmentPropagations&Version=2016-11-15:
- get:
- x-aws-operation-name: GetTransitGatewayAttachmentPropagations
- operationId: GET_GetTransitGatewayAttachmentPropagations
- description: Lists the route tables to which the specified resource attachment propagates routes.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsResult'
- parameters:
- - name: TransitGatewayAttachmentId
- in: query
- required: true
- description: The ID of the attachment.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
transit-gateway-route-table-id - The ID of the transit gateway route table.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetTransitGatewayAttachmentPropagations
- operationId: POST_GetTransitGatewayAttachmentPropagations
- description: Lists the route tables to which the specified resource attachment propagates routes.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetTransitGatewayMulticastDomainAssociations&Version=2016-11-15:
- get:
- x-aws-operation-name: GetTransitGatewayMulticastDomainAssociations
- operationId: GET_GetTransitGatewayMulticastDomainAssociations
- description: Gets information about the associations for the transit gateway multicast domain.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayMulticastDomainAssociationsResult'
- parameters:
- - name: TransitGatewayMulticastDomainId
- in: query
- required: false
- description: The ID of the transit gateway multicast domain.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The type of resource. The valid value is: vpc.
state - The state of the subnet association. Valid values are associated | associating | disassociated | disassociating.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetTransitGatewayMulticastDomainAssociations
- operationId: POST_GetTransitGatewayMulticastDomainAssociations
- description: Gets information about the associations for the transit gateway multicast domain.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayMulticastDomainAssociationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayMulticastDomainAssociationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetTransitGatewayPrefixListReferences&Version=2016-11-15:
- get:
- x-aws-operation-name: GetTransitGatewayPrefixListReferences
- operationId: GET_GetTransitGatewayPrefixListReferences
- description: Gets information about the prefix list references in a specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesResult'
- parameters:
- - name: TransitGatewayRouteTableId
- in: query
- required: true
- description: The ID of the transit gateway route table.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
attachment.resource-id - The ID of the resource for the attachment.
attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.
attachment.transit-gateway-attachment-id - The ID of the attachment.
is-blackhole - Whether traffic matching the route is blocked (true | false).
prefix-list-id - The ID of the prefix list.
prefix-list-owner-id - The ID of the owner of the prefix list.
state - The state of the prefix list reference (pending | available | modifying | deleting).
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetTransitGatewayPrefixListReferences
- operationId: POST_GetTransitGatewayPrefixListReferences
- description: Gets information about the prefix list references in a specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetTransitGatewayRouteTableAssociations&Version=2016-11-15:
- get:
- x-aws-operation-name: GetTransitGatewayRouteTableAssociations
- operationId: GET_GetTransitGatewayRouteTableAssociations
- description: Gets information about the associations for the specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsResult'
- parameters:
- - name: TransitGatewayRouteTableId
- in: query
- required: true
- description: The ID of the transit gateway route table.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetTransitGatewayRouteTableAssociations
- operationId: POST_GetTransitGatewayRouteTableAssociations
- description: Gets information about the associations for the specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetTransitGatewayRouteTablePropagations&Version=2016-11-15:
- get:
- x-aws-operation-name: GetTransitGatewayRouteTablePropagations
- operationId: GET_GetTransitGatewayRouteTablePropagations
- description: Gets information about the route table propagations for the specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsResult'
- parameters:
- - name: TransitGatewayRouteTableId
- in: query
- required: true
- description: The ID of the transit gateway route table.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetTransitGatewayRouteTablePropagations
- operationId: POST_GetTransitGatewayRouteTablePropagations
- description: Gets information about the route table propagations for the specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=GetVpnConnectionDeviceSampleConfiguration&Version=2016-11-15:
- get:
- x-aws-operation-name: GetVpnConnectionDeviceSampleConfiguration
- operationId: GET_GetVpnConnectionDeviceSampleConfiguration
- description: Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetVpnConnectionDeviceSampleConfigurationResult'
- parameters:
- - name: VpnConnectionId
- in: query
- required: true
- description: The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration.
- schema:
- type: string
- - name: VpnConnectionDeviceTypeId
- in: query
- required: true
- description: Device identifier provided by the GetVpnConnectionDeviceTypes API.
- schema:
- type: string
- - name: InternetKeyExchangeVersion
- in: query
- required: false
- description: 'The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ikev1 or ikev2.'
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetVpnConnectionDeviceSampleConfiguration
- operationId: POST_GetVpnConnectionDeviceSampleConfiguration
- description: Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetVpnConnectionDeviceSampleConfigurationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetVpnConnectionDeviceSampleConfigurationRequest'
- parameters: []
- /?Action=GetVpnConnectionDeviceTypes&Version=2016-11-15:
- get:
- x-aws-operation-name: GetVpnConnectionDeviceTypes
- operationId: GET_GetVpnConnectionDeviceTypes
- description: 'Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetVpnConnectionDeviceTypesResult'
- parameters:
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results returned by GetVpnConnectionDeviceTypes in paginated output. When this parameter is used, GetVpnConnectionDeviceTypes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another GetVpnConnectionDeviceTypes request with the returned NextToken value. This value can be between 200 and 1000. If this parameter is not used, then GetVpnConnectionDeviceTypes returns all results.'
- schema:
- type: integer
- minimum: 200
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: 'The NextToken value returned from a previous paginated GetVpnConnectionDeviceTypes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return. '
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: GetVpnConnectionDeviceTypes
- operationId: POST_GetVpnConnectionDeviceTypes
- description: 'Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetVpnConnectionDeviceTypesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetVpnConnectionDeviceTypesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=ImportClientVpnClientCertificateRevocationList&Version=2016-11-15:
- get:
- x-aws-operation-name: ImportClientVpnClientCertificateRevocationList
- operationId: GET_ImportClientVpnClientCertificateRevocationList
- description: Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.
Uploading a client certificate revocation list resets existing client connections.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint to which the client certificate revocation list applies. - schema: - type: string - - name: CertificateRevocationList - in: query - required: true - description: 'The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the Client VPN Administrator Guide.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ImportClientVpnClientCertificateRevocationList
- operationId: POST_ImportClientVpnClientCertificateRevocationList
- description: Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.
Uploading a client certificate revocation list resets existing client connections.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListRequest' - parameters: [] - /?Action=ImportImage&Version=2016-11-15: - get: - x-aws-operation-name: ImportImage - operationId: GET_ImportImage - description: 'Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportImageResult' - parameters: - - name: Architecture - in: query - required: false - description: 'The architecture of the virtual machine.
Valid values: i386 | x86_64
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Encrypted
- in: query
- required: false
- description: 'Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.'
- schema:
- type: boolean
- - name: Hypervisor
- in: query
- required: false
- description: 'The target hypervisor platform.
Valid values: xen
An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the AMI is being copied to.
Amazon EBS does not support asymmetric KMS keys.
' - schema: - type: string - - name: LicenseType - in: query - required: false - description: 'The license type to be used for the Amazon Machine Image (AMI) after importing.
By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an Amazon Web Services license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.
To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.
The operating system of the virtual machine.
Valid values: Windows | Linux
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportImageRequest' - parameters: [] - /?Action=ImportInstance&Version=2016-11-15: - get: - x-aws-operation-name: ImportInstance - operationId: GET_ImportInstance - description: 'Creates an import instance task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportInstanceResult' - parameters: - - name: Description - in: query - required: false - description: A description for the instance being imported. - schema: - type: string - - name: DiskImage - in: query - required: false - description: The disk image. - schema: - type: array - items: - $ref: '#/components/schemas/DiskImage' - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: LaunchSpecification
- in: query
- required: false
- description: The launch specification.
- schema:
- type: object
- properties:
- additionalInfo:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Reserved.
- architecture:
- allOf:
- - $ref: '#/components/schemas/ArchitectureValues'
- - description: The architecture of the instance.
- GroupId:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupIdStringList'
- - description: The security group IDs.
- GroupName:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupStringList'
- - description: The security group names.
- instanceInitiatedShutdownBehavior:
- allOf:
- - $ref: '#/components/schemas/ShutdownBehavior'
- - description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
- instanceType:
- allOf:
- - $ref: '#/components/schemas/InstanceType'
- - description: 'The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.'
- monitoring:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether monitoring is enabled.
- placement:
- allOf:
- - $ref: '#/components/schemas/Placement'
- - description: The placement information for the instance.
- privateIpAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: '[EC2-VPC] An available IP address from the IP address range of the subnet.'
- subnetId:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - description: '[EC2-VPC] The ID of the subnet in which to launch the instance.'
- userData:
- allOf:
- - $ref: '#/components/schemas/UserData'
- - description: The Base64-encoded user data to make available to the instance.
- description: Describes the launch specification for VM import.
- - name: Platform
- in: query
- required: true
- description: The instance operating system.
- schema:
- type: string
- enum:
- - Windows
- 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'
- post:
- x-aws-operation-name: ImportInstance
- operationId: POST_ImportInstance
- description: 'Creates an import instance task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportInstanceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportInstanceRequest' - parameters: [] - /?Action=ImportKeyPair&Version=2016-11-15: - get: - x-aws-operation-name: ImportKeyPair - operationId: GET_ImportKeyPair - description: 'Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportKeyPairResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: KeyName
- in: query
- required: true
- description: A unique name for the key pair.
- schema:
- type: string
- - name: PublicKeyMaterial
- in: query
- required: true
- description: 'The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.'
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply to the imported key pair.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: ImportKeyPair
- operationId: POST_ImportKeyPair
- description: 'Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportKeyPairResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportKeyPairRequest' - parameters: [] - /?Action=ImportSnapshot&Version=2016-11-15: - get: - x-aws-operation-name: ImportSnapshot - operationId: GET_ImportSnapshot - description: 'Imports a disk into an EBS snapshot.
For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportSnapshotResult' - parameters: - - name: ClientData - in: query - required: false - description: The client-specific data. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time that the disk upload starts. - description: Describes the client-specific data. - - name: ClientToken - in: query - required: false - description: Token to enable idempotency for VM import requests. - schema: - type: string - - name: Description - in: query - required: false - description: The description string for the import snapshot task. - schema: - type: string - - name: DiskContainer - in: query - required: false - description: Information about the disk container. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/UserBucket' - - description: The Amazon S3 bucket for the disk image. - description: The disk container object for the import snapshot request. - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Encrypted
- in: query
- required: false
- description: 'Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.'
- schema:
- type: boolean
- - name: KmsKeyId
- in: query
- required: false
- description: 'An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric KMS keys.
' - schema: - type: string - - name: RoleName - in: query - required: false - description: 'The name of the role to use when not using the default role, ''vmimport''.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the import snapshot task during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - 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' - post: - x-aws-operation-name: ImportSnapshot - operationId: POST_ImportSnapshot - description: 'Imports a disk into an EBS snapshot.
For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportSnapshotResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportSnapshotRequest' - parameters: [] - /?Action=ImportVolume&Version=2016-11-15: - get: - x-aws-operation-name: ImportVolume - operationId: GET_ImportVolume - description: 'Creates an import volume task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportVolumeResult' - parameters: - - name: AvailabilityZone - in: query - required: true - description: The Availability Zone for the resulting EBS volume. - schema: - type: string - - name: Description - in: query - required: false - description: A description of the volume. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Image
- in: query
- required: true
- description: The disk image.
- schema:
- type: object
- required:
- - Bytes
- - Format
- - ImportManifestUrl
- properties:
- bytes:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: 'The size of the disk image, in GiB.'
- format:
- allOf:
- - $ref: '#/components/schemas/DiskImageFormat'
- - description: The disk image format.
- importManifestUrl:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' - description: Describes a disk image. - - name: Volume - in: query - required: true - description: The volume size. - schema: - type: object - required: - - Size - properties: - size: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The size of the volume, in GiB.' - description: Describes an EBS volume. - 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' - post: - x-aws-operation-name: ImportVolume - operationId: POST_ImportVolume - description: 'Creates an import volume task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportVolumeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportVolumeRequest' - parameters: [] - /?Action=ListImagesInRecycleBin&Version=2016-11-15: - get: - x-aws-operation-name: ListImagesInRecycleBin - operationId: GET_ListImagesInRecycleBin - description: 'Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListImagesInRecycleBinResult' - parameters: - - name: ImageId - in: query - required: false - description: The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageId' - - xml: - name: ImageId - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If you do not specify a value for MaxResults, the request returns 1,000 items per page by default. For more information, see Pagination.
' - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ListImagesInRecycleBin
- operationId: POST_ListImagesInRecycleBin
- description: 'Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ListImagesInRecycleBinResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ListImagesInRecycleBinRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=ListSnapshotsInRecycleBin&Version=2016-11-15:
- get:
- x-aws-operation-name: ListSnapshotsInRecycleBin
- operationId: GET_ListSnapshotsInRecycleBin
- description: Lists one or more snapshots that are currently in the Recycle Bin.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ListSnapshotsInRecycleBinResult'
- parameters:
- - name: MaxResults
- in: query
- required: false
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: SnapshotId
- in: query
- required: false
- description: The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SnapshotId'
- - xml:
- name: SnapshotId
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ListSnapshotsInRecycleBin
- operationId: POST_ListSnapshotsInRecycleBin
- description: Lists one or more snapshots that are currently in the Recycle Bin.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ListSnapshotsInRecycleBinResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ListSnapshotsInRecycleBinRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=ModifyAddressAttribute&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyAddressAttribute
- operationId: GET_ModifyAddressAttribute
- description: 'Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyAddressAttributeResult'
- parameters:
- - name: AllocationId
- in: query
- required: true
- description: '[EC2-VPC] The allocation ID.'
- schema:
- type: string
- - name: DomainName
- in: query
- required: false
- description: The domain name to modify for the IP address.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyAddressAttribute
- operationId: POST_ModifyAddressAttribute
- description: 'Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyAddressAttributeResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyAddressAttributeRequest'
- parameters: []
- /?Action=ModifyAvailabilityZoneGroup&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyAvailabilityZoneGroup
- operationId: GET_ModifyAvailabilityZoneGroup
- description: 'Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.
Use DescribeAvailabilityZones to view the value for GroupName.
opted-in. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.'
- schema:
- type: string
- enum:
- - opted-in
- - not-opted-in
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyAvailabilityZoneGroup
- operationId: POST_ModifyAvailabilityZoneGroup
- description: 'Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.
Use DescribeAvailabilityZones to view the value for GroupName.
1000 in a single request.
- schema:
- type: integer
- - name: EndDate
- in: query
- required: false
- description: 'The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: AdditionalInfo
- in: query
- required: false
- description: Reserved for future use.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ModifyCapacityReservation
- operationId: POST_ModifyCapacityReservation
- description: 'Modifies a Capacity Reservation''s capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation''s instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyCapacityReservationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyCapacityReservationRequest'
- parameters: []
- /?Action=ModifyCapacityReservationFleet&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyCapacityReservationFleet
- operationId: GET_ModifyCapacityReservationFleet
- description: 'Modifies a Capacity Reservation Fleet.
When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyCapacityReservationFleetResult' - parameters: - - name: CapacityReservationFleetId - in: query - required: true - description: The ID of the Capacity Reservation Fleet to modify. - schema: - type: string - - name: TotalTargetCapacity - in: query - required: false - description: 'The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.' - schema: - type: integer - - name: EndDate - in: query - required: false - description: 'The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.
You can''t specify EndDate and RemoveEndDate in the same request.
' - schema: - type: string - format: date-time - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: RemoveEndDate
- in: query
- required: false
- description: 'Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the CancelCapacityReservationFleet action.
You can''t specify RemoveEndDate and EndDate in the same request.
' - schema: - type: boolean - 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' - post: - x-aws-operation-name: ModifyCapacityReservationFleet - operationId: POST_ModifyCapacityReservationFleet - description: 'Modifies a Capacity Reservation Fleet.
When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyCapacityReservationFleetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyCapacityReservationFleetRequest' - parameters: [] - /?Action=ModifyClientVpnEndpoint&Version=2016-11-15: - get: - x-aws-operation-name: ModifyClientVpnEndpoint - operationId: GET_ModifyClientVpnEndpoint - description: Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyClientVpnEndpointResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint to modify. - schema: - type: string - - name: ServerCertificateArn - in: query - required: false - description: The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM). - schema: - type: string - - name: ConnectionLogOptions - in: query - required: false - description: 'Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
False to delete the existing DNS servers.
- description: Information about the DNS server to be used.
- - name: VpnPort
- in: query
- required: false
- description: 'The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
Indicates whether the VPN is split-tunnel.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
' - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: SecurityGroupId
- in: query
- required: false
- description: The IDs of one or more security groups to apply to the target network.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: item
- - name: VpcId
- in: query
- required: false
- description: The ID of the VPC to associate with the Client VPN endpoint.
- schema:
- type: string
- - name: SelfServicePortal
- in: query
- required: false
- description: Specify whether to enable the self-service portal for the Client VPN endpoint.
- schema:
- type: string
- enum:
- - enabled
- - disabled
- - name: ClientConnectOptions
- in: query
- required: false
- description: The options for managing connection authorization for new client connections.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
- description: The options for managing connection authorization for new client connections.
- - name: SessionTimeoutHours
- in: query
- required: false
- description: 'The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.
ModifyDefaultCreditSpecification is an asynchronous operation, which works at an Amazon Web Services Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyDefaultCreditSpecificationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceFamily
- in: query
- required: true
- description: The instance family.
- schema:
- type: string
- enum:
- - t2
- - t3
- - t3a
- - t4g
- - name: CpuCredits
- in: query
- required: true
- description: 'The credit option for CPU usage of the instance family.
Valid Values: standard | unlimited
Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.
ModifyDefaultCreditSpecification is an asynchronous operation, which works at an Amazon Web Services Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyDefaultCreditSpecificationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyDefaultCreditSpecificationRequest' - parameters: [] - /?Action=ModifyEbsDefaultKmsKeyId&Version=2016-11-15: - get: - x-aws-operation-name: ModifyEbsDefaultKmsKeyId - operationId: GET_ModifyEbsDefaultKmsKeyId - description: 'Changes the default KMS key for EBS encryption by default for your account in this Region.
Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.
If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyEbsDefaultKmsKeyIdResult' - parameters: - - name: KmsKeyId - in: query - required: true - description: 'The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
Amazon EBS does not support asymmetric KMS keys.
' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyEbsDefaultKmsKeyId
- operationId: POST_ModifyEbsDefaultKmsKeyId
- description: 'Changes the default KMS key for EBS encryption by default for your account in this Region.
Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.
If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyEbsDefaultKmsKeyIdResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyEbsDefaultKmsKeyIdRequest' - parameters: [] - /?Action=ModifyFleet&Version=2016-11-15: - get: - x-aws-operation-name: ModifyFleet - operationId: GET_ModifyFleet - description: 'Modifies the specified EC2 Fleet.
You can only modify an EC2 Fleet request of type maintain.
While the EC2 Fleet is being modified, it is in the modifying state.
To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.
If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyFleetResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ExcessCapacityTerminationPolicy
- in: query
- required: false
- description: Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
- schema:
- type: string
- enum:
- - no-termination
- - termination
- - name: LaunchTemplateConfig
- in: query
- required: false
- description: The launch template and overrides.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/FleetLaunchTemplateConfigRequest'
- - xml:
- name: item
- minItems: 0
- maxItems: 50
- - name: FleetId
- in: query
- required: true
- description: The ID of the EC2 Fleet.
- schema:
- type: string
- - name: TargetCapacitySpecification
- in: query
- required: false
- description: The size of the EC2 Fleet.
- schema:
- type: object
- required:
- - TotalTargetCapacity
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TargetCapacityUnitType'
- - description: 'The unit for the target capacity.
Default: units (translates to number of instances)
The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.
Modifies the specified EC2 Fleet.
You can only modify an EC2 Fleet request of type maintain.
While the EC2 Fleet is being modified, it is in the modifying state.
To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.
If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyFleetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyFleetRequest' - parameters: [] - /?Action=ModifyFpgaImageAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifyFpgaImageAttribute - operationId: GET_ModifyFpgaImageAttribute - description: Modifies the specified attribute of the specified Amazon FPGA Image (AFI). - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyFpgaImageAttributeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: FpgaImageId
- in: query
- required: true
- description: The ID of the AFI.
- schema:
- type: string
- - name: Attribute
- in: query
- required: false
- description: The name of the attribute.
- schema:
- type: string
- enum:
- - description
- - name
- - loadPermission
- - productCodes
- - name: OperationType
- in: query
- required: false
- description: The operation type.
- schema:
- type: string
- enum:
- - add
- - remove
- - name: UserId
- in: query
- required: false
- description: The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: UserId
- - name: UserGroup
- in: query
- required: false
- description: The user groups. This parameter is valid only when modifying the loadPermission attribute.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: UserGroup
- - name: ProductCode
- in: query
- required: false
- description: 'The product codes. After you add a product code to an AFI, it can''t be removed. This parameter is valid only when modifying the productCodes attribute.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: ProductCode
- - name: LoadPermission
- in: query
- required: false
- description: The load permission for the AFI.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/LoadPermissionListRequest'
- - description: The load permissions to remove.
- description: Describes modifications to the load permissions of an Amazon FPGA image (AFI).
- - name: Description
- in: query
- required: false
- description: A description for the AFI.
- schema:
- type: string
- - name: Name
- in: query
- required: false
- description: A name for the AFI.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ModifyFpgaImageAttribute
- operationId: POST_ModifyFpgaImageAttribute
- description: Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyFpgaImageAttributeResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyFpgaImageAttributeRequest'
- parameters: []
- /?Action=ModifyHosts&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyHosts
- operationId: GET_ModifyHosts
- description: 'Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.
You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyHostsResult' - parameters: - - name: AutoPlacement - in: query - required: false - description: Specify whether to enable or disable auto-placement. - schema: - type: string - enum: - - 'on' - - 'off' - - name: HostId - in: query - required: true - description: The IDs of the Dedicated Hosts to modify. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - xml: - name: item - - name: HostRecovery - in: query - required: false - description: 'Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.' - schema: - type: string - enum: - - 'on' - - 'off' - - name: InstanceType - in: query - required: false - description: 'Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type.
If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
' - schema: - type: string - - name: InstanceFamily - in: query - required: false - description: 'Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.
If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
' - schema: - type: string - 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' - post: - x-aws-operation-name: ModifyHosts - operationId: POST_ModifyHosts - description: 'Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.
You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyHostsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyHostsRequest' - parameters: [] - /?Action=ModifyIdFormat&Version=2016-11-15: - get: - x-aws-operation-name: ModifyIdFormat - operationId: GET_ModifyIdFormat - description: 'Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you''re using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you''re using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
all to modify the ID format for all IAM users, IAM roles, and the root user of the account.'
- schema:
- type: string
- - name: Resource
- in: query
- required: true
- description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
' - responses: - '200': - description: Success - parameters: - - name: Attribute - in: query - required: false - description: 'The name of the attribute to modify.
Valid values: description | launchPermission
Attribute parameter is launchPermission.
- schema:
- type: string
- enum:
- - add
- - remove
- - name: ProductCode
- in: query
- required: false
- description: Not supported.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: ProductCode
- - name: UserGroup
- in: query
- required: false
- description: The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: UserGroup
- - name: UserId
- in: query
- required: false
- description: The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: UserId
- - name: Value
- in: query
- required: false
- description: The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: OrganizationArn
- in: query
- required: false
- description: The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: OrganizationArn
- - name: OrganizationalUnitArn
- in: query
- required: false
- description: The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: OrganizationalUnitArn
- 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'
- post:
- x-aws-operation-name: ModifyImageAttribute
- operationId: POST_ModifyImageAttribute
- description: 'Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyImageAttributeRequest' - parameters: [] - /?Action=ModifyInstanceAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifyInstanceAttribute - operationId: GET_ModifyInstanceAttribute - description: 'Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.
To modify some attributes, the instance must be stopped. For more information, see Modify a stopped instance in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - parameters: - - name: SourceDestCheck - in: query - required: false - description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value istrue, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
- schema:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The attribute value. The valid values are true or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: Attribute
- in: query
- required: false
- description: The name of the attribute.
- schema:
- type: string
- enum:
- - instanceType
- - kernel
- - ramdisk
- - userData
- - disableApiTermination
- - instanceInitiatedShutdownBehavior
- - rootDeviceName
- - blockDeviceMapping
- - productCodes
- - sourceDestCheck
- - groupSet
- - ebsOptimized
- - sriovNetSupport
- - enaSupport
- - enclaveOptions
- - name: BlockDeviceMapping
- in: query
- required: false
- description: 'Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceBlockDeviceMappingSpecification' - - xml: - name: item - - name: DisableApiTermination - in: query - required: false - description: 'If the value istrue, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.'
- schema:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The attribute value. The valid values are true or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: EbsOptimized
- in: query
- required: false
- description: Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
- schema:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The attribute value. The valid values are true or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: EnaSupport
- in: query
- required: false
- description: Set to true to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
- schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values aretrue or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: GroupId
- in: query
- required: false
- description: '[EC2-VPC] Replaces the security groups of the instance with the specified security groups. You must specify at least one security group, even if it''s just the default security group for the VPC. You must specify the security group ID, not the security group name.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: groupId
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance.
- schema:
- type: string
- - name: InstanceInitiatedShutdownBehavior
- in: query
- required: false
- description: Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
- schema:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The attribute value. The value is case-sensitive.
- description: Describes a value for a resource attribute that is a String.
- - name: InstanceType
- in: query
- required: false
- description: 'Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.'
- schema:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The attribute value. The value is case-sensitive.
- description: Describes a value for a resource attribute that is a String.
- - name: Kernel
- in: query
- required: false
- description: 'Changes the instance''s kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.'
- schema:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The attribute value. The value is case-sensitive.
- description: Describes a value for a resource attribute that is a String.
- - name: Ramdisk
- in: query
- required: false
- description: 'Changes the instance''s RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.'
- schema:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The attribute value. The value is case-sensitive.
- description: Describes a value for a resource attribute that is a String.
- - name: SriovNetSupport
- in: query
- required: false
- description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
- schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The attribute value. The value is case-sensitive. - description: Describes a value for a resource attribute that is a String. - - name: UserData - in: query - required: false - description: 'Changes the instance''s user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.' - schema: - type: object - properties: - value: - $ref: '#/components/schemas/Blob' - - name: Value - in: query - required: false - description: 'A new value for the attribute. Use only with thekernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.'
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ModifyInstanceAttribute
- operationId: POST_ModifyInstanceAttribute
- description: 'Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.
To modify some attributes, the instance must be stopped. For more information, see Modify a stopped instance in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceAttributeRequest' - parameters: [] - /?Action=ModifyInstanceCapacityReservationAttributes&Version=2016-11-15: - get: - x-aws-operation-name: ModifyInstanceCapacityReservationAttributes - operationId: GET_ModifyInstanceCapacityReservationAttributes - description: 'Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in anyopen Capacity Reservation with matching attributes, or run On-Demand Instance capacity.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesResult'
- parameters:
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance to be modified.
- schema:
- type: string
- - name: CapacityReservationSpecification
- in: query
- required: true
- description: Information about the Capacity Reservation targeting option.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationTarget'
- - description: Information about the target Capacity Reservation or Capacity Reservation group.
- description: 'Describes an instance''s Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyInstanceCapacityReservationAttributes
- operationId: POST_ModifyInstanceCapacityReservationAttributes
- description: 'Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesRequest'
- parameters: []
- /?Action=ModifyInstanceCreditSpecification&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyInstanceCreditSpecification
- operationId: GET_ModifyInstanceCreditSpecification
- description: 'Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceCreditSpecificationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: false
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
- schema:
- type: string
- - name: InstanceCreditSpecification
- in: query
- required: true
- description: Information about the credit option for CPU usage.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceCreditSpecificationRequest'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: ModifyInstanceCreditSpecification
- operationId: POST_ModifyInstanceCreditSpecification
- description: 'Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceCreditSpecificationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceCreditSpecificationRequest' - parameters: [] - /?Action=ModifyInstanceEventStartTime&Version=2016-11-15: - get: - x-aws-operation-name: ModifyInstanceEventStartTime - operationId: GET_ModifyInstanceEventStartTime - description: Modifies the start time for a scheduled Amazon EC2 instance event. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceEventStartTimeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance with the scheduled event.
- schema:
- type: string
- - name: InstanceEventId
- in: query
- required: true
- description: The ID of the event whose date and time you are modifying.
- schema:
- type: string
- - name: NotBefore
- in: query
- required: true
- description: The new date and time when the event will take place.
- schema:
- type: string
- format: date-time
- 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'
- post:
- x-aws-operation-name: ModifyInstanceEventStartTime
- operationId: POST_ModifyInstanceEventStartTime
- description: Modifies the start time for a scheduled Amazon EC2 instance event.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyInstanceEventStartTimeResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyInstanceEventStartTimeRequest'
- parameters: []
- /?Action=ModifyInstanceEventWindow&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyInstanceEventWindow
- operationId: GET_ModifyInstanceEventWindow
- description: 'Modifies the specified event window.
You can define either a set of time ranges or a cron expression when modifying the event window, but not both.
To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.
If Amazon Web Services has already scheduled an event, modifying an event window won''t change the time of the scheduled event.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceEventWindowResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Name
- in: query
- required: false
- description: The name of the event window.
- schema:
- type: string
- - name: InstanceEventWindowId
- in: query
- required: true
- description: The ID of the event window.
- schema:
- type: string
- - name: TimeRange
- in: query
- required: false
- description: The time ranges of the event window.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest'
- - name: CronExpression
- in: query
- required: false
- description: 'The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.
Constraints:
Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
' - schema: - type: string - 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' - post: - x-aws-operation-name: ModifyInstanceEventWindow - operationId: POST_ModifyInstanceEventWindow - description: 'Modifies the specified event window.
You can define either a set of time ranges or a cron expression when modifying the event window, but not both.
To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.
If Amazon Web Services has already scheduled an event, modifying an event window won''t change the time of the scheduled event.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceEventWindowResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceEventWindowRequest' - parameters: [] - /?Action=ModifyInstanceMaintenanceOptions&Version=2016-11-15: - get: - x-aws-operation-name: ModifyInstanceMaintenanceOptions - operationId: GET_ModifyInstanceMaintenanceOptions - description: 'Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceMaintenanceOptionsResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: AutoRecovery - in: query - required: false - description: Disables the automatic recovery behavior of your instance or sets it to default. - schema: - type: string - enum: - - disabled - - default - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyInstanceMaintenanceOptions
- operationId: POST_ModifyInstanceMaintenanceOptions
- description: 'Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyInstanceMaintenanceOptionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyInstanceMaintenanceOptionsRequest'
- parameters: []
- /?Action=ModifyInstanceMetadataOptions&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyInstanceMetadataOptions
- operationId: GET_ModifyInstanceMetadataOptions
- description: 'Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyInstanceMetadataOptionsResult'
- parameters:
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance.
- schema:
- type: string
- - name: HttpTokens
- in: query
- required: false
- description: 'The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
Possible values: Integers from 1 to 64
' - schema: - type: integer - - name: HttpEndpoint - in: query - required: false - description: 'Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
If you specify a value of disabled, you cannot access your instance metadata.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: HttpProtocolIpv6
- in: query
- required: false
- description: Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only if you have enabled the HTTP metadata endpoint.
- schema:
- type: string
- enum:
- - disabled
- - enabled
- - name: InstanceMetadataTags
- in: query
- required: false
- description: 'Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
Modifies the placement attributes for a specified instance. You can do the following:
Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
Change the instance tenancy of an instance.
Move an instance to or from a placement group.
At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.
To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.
The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.
To remove an instance from a placement group, specify an empty string ("").
' - schema: - type: string - - name: HostId - in: query - required: false - description: The ID of the Dedicated Host with which to associate the instance. - schema: - type: string - - name: InstanceId - in: query - required: true - description: The ID of the instance that you are modifying. - schema: - type: string - - name: Tenancy - in: query - required: false - description: 'The tenancy for the instance.
For T3 instances, you can''t change the tenancy from dedicated to host, or from host to dedicated. Attempting to make one of these unsupported tenancy changes results in the InvalidTenancy error code.
partition.
- schema:
- type: integer
- - name: HostResourceGroupArn
- in: query
- required: false
- description: The ARN of the host resource group in which to place the instance.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ModifyInstancePlacement
- operationId: POST_ModifyInstancePlacement
- description: 'Modifies the placement attributes for a specified instance. You can do the following:
Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
Change the instance tenancy of an instance.
Move an instance to or from a placement group.
At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.
To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamId
- in: query
- required: true
- description: The ID of the IPAM you want to modify.
- schema:
- type: string
- - name: Description
- in: query
- required: false
- description: The description of the IPAM you want to modify.
- schema:
- type: string
- - name: AddOperatingRegion
- in: query
- required: false
- description: 'Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' - schema: - type: array - items: - $ref: '#/components/schemas/AddIpamOperatingRegion' - minItems: 0 - maxItems: 50 - - name: RemoveOperatingRegion - in: query - required: false - description: The operating Regions to remove. - schema: - type: array - items: - $ref: '#/components/schemas/RemoveIpamOperatingRegion' - minItems: 0 - maxItems: 50 - 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' - post: - x-aws-operation-name: ModifyIpam - operationId: POST_ModifyIpam - description: 'Modify the configurations of an IPAM. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamRequest' - parameters: [] - /?Action=ModifyIpamPool&Version=2016-11-15: - get: - x-aws-operation-name: ModifyIpamPool - operationId: GET_ModifyIpamPool - description: 'Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamPoolResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamPoolId
- in: query
- required: true
- description: The ID of the IPAM pool you want to modify.
- schema:
- type: string
- - name: Description
- in: query
- required: false
- description: The description of the IPAM pool you want to modify.
- schema:
- type: string
- - name: AutoImport
- in: query
- required: false
- description: 'If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
' - schema: - type: boolean - - name: AllocationMinNetmaskLength - in: query - required: false - description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length. - schema: - type: integer - minimum: 0 - maximum: 128 - - name: AllocationMaxNetmaskLength - in: query - required: false - description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length. - schema: - type: integer - minimum: 0 - maximum: 128 - - name: AllocationDefaultNetmaskLength - in: query - required: false - description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.' - schema: - type: integer - minimum: 0 - maximum: 128 - - name: ClearAllocationDefaultNetmaskLength - in: query - required: false - description: Clear the default netmask length allocation rule for this pool. - schema: - type: boolean - - name: AddAllocationResourceTag - in: query - required: false - description: 'Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/RequestIpamResourceTag' - - xml: - name: item - - name: RemoveAllocationResourceTag - in: query - required: false - description: Remove tag allocation rules from a pool. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/RequestIpamResourceTag' - - xml: - name: item - 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' - post: - x-aws-operation-name: ModifyIpamPool - operationId: POST_ModifyIpamPool - description: 'Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamPoolResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamPoolRequest' - parameters: [] - /?Action=ModifyIpamResourceCidr&Version=2016-11-15: - get: - x-aws-operation-name: ModifyIpamResourceCidr - operationId: GET_ModifyIpamResourceCidr - description: 'Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.
For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamResourceCidrResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ResourceId
- in: query
- required: true
- description: The ID of the resource you want to modify.
- schema:
- type: string
- - name: ResourceCidr
- in: query
- required: true
- description: The CIDR of the resource you want to modify.
- schema:
- type: string
- - name: ResourceRegion
- in: query
- required: true
- description: The Amazon Web Services Region of the resource you want to modify.
- schema:
- type: string
- - name: CurrentIpamScopeId
- in: query
- required: true
- description: The ID of the current scope that the resource CIDR is in.
- schema:
- type: string
- - name: DestinationIpamScopeId
- in: query
- required: false
- description: The ID of the scope you want to transfer the resource CIDR to.
- schema:
- type: string
- - name: Monitored
- in: query
- required: true
- description: 'Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyIpamResourceCidr
- operationId: POST_ModifyIpamResourceCidr
- description: 'Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.
For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamResourceCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamResourceCidrRequest' - parameters: [] - /?Action=ModifyIpamScope&Version=2016-11-15: - get: - x-aws-operation-name: ModifyIpamScope - operationId: GET_ModifyIpamScope - description: Modify an IPAM scope. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamScopeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamScopeId
- in: query
- required: true
- description: The ID of the scope you want to modify.
- schema:
- type: string
- - name: Description
- in: query
- required: false
- description: The description of the scope you want to modify.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ModifyIpamScope
- operationId: POST_ModifyIpamScope
- description: Modify an IPAM scope.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyIpamScopeResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyIpamScopeRequest'
- parameters: []
- /?Action=ModifyLaunchTemplate&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyLaunchTemplate
- operationId: GET_ModifyLaunchTemplate
- description: 'Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyLaunchTemplateResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ClientToken
- in: query
- required: false
- description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraint: Maximum 128 ASCII characters.
' - schema: - type: string - - name: LaunchTemplateId - in: query - required: false - description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request. - schema: - type: string - - name: LaunchTemplateName - in: query - required: false - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. - schema: - type: string - pattern: '[a-zA-Z0-9\(\)\.\-/_]+' - minLength: 3 - maxLength: 128 - - name: SetDefaultVersion - in: query - required: false - description: The version number of the launch template to set as the default version. - schema: - type: string - 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' - post: - x-aws-operation-name: ModifyLaunchTemplate - operationId: POST_ModifyLaunchTemplate - description: 'Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyLaunchTemplateResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyLaunchTemplateRequest' - parameters: [] - /?Action=ModifyManagedPrefixList&Version=2016-11-15: - get: - x-aws-operation-name: ModifyManagedPrefixList - operationId: GET_ModifyManagedPrefixList - description: 'Modifies the specified managed prefix list.
Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.
If you specify a current version number that does not match the true current version number, the request fails.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyManagedPrefixListResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PrefixListId
- in: query
- required: true
- description: The ID of the prefix list.
- schema:
- type: string
- - name: CurrentVersion
- in: query
- required: false
- description: The current version of the prefix list.
- schema:
- type: integer
- - name: PrefixListName
- in: query
- required: false
- description: A name for the prefix list.
- schema:
- type: string
- - name: AddEntry
- in: query
- required: false
- description: One or more entries to add to the prefix list.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/AddPrefixListEntry'
- minItems: 0
- maxItems: 100
- - name: RemoveEntry
- in: query
- required: false
- description: One or more entries to remove from the prefix list.
- schema:
- type: array
- items:
- $ref: '#/components/schemas/RemovePrefixListEntry'
- minItems: 0
- maxItems: 100
- - name: MaxEntries
- in: query
- required: false
- description: 'The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.
If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.
' - schema: - type: integer - 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' - post: - x-aws-operation-name: ModifyManagedPrefixList - operationId: POST_ModifyManagedPrefixList - description: 'Modifies the specified managed prefix list.
Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.
If you specify a current version number that does not match the true current version number, the request fails.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyManagedPrefixListResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyManagedPrefixListRequest' - parameters: [] - /?Action=ModifyNetworkInterfaceAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifyNetworkInterfaceAttribute - operationId: GET_ModifyNetworkInterfaceAttribute - description: Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance. - responses: - '200': - description: Success - parameters: - - name: Attachment - in: query - required: false - description: 'Information about the interface attachment. If modifying the ''delete on termination'' attribute, you must specify the ID of the interface attachment.' - schema: - type: object - properties: - attachmentId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAttachmentId' - - description: The ID of the network interface attachment. - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the network interface is deleted when the instance is terminated. - description: Describes an attachment change. - - name: Description - in: query - required: false - description: A description for the network interface. - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The attribute value. The value is case-sensitive. - description: Describes a value for a resource attribute that is a String. - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: SecurityGroupId
- in: query
- required: false
- description: 'Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it''s just the default security group in the VPC. You must specify the ID of the security group, not the name.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: SecurityGroupId
- - name: NetworkInterfaceId
- in: query
- required: true
- description: The ID of the network interface.
- schema:
- type: string
- - name: SourceDestCheck
- in: query
- required: false
- description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
- schema:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The attribute value. The valid values are true or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- 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'
- post:
- x-aws-operation-name: ModifyNetworkInterfaceAttribute
- operationId: POST_ModifyNetworkInterfaceAttribute
- description: Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyNetworkInterfaceAttributeRequest'
- parameters: []
- /?Action=ModifyPrivateDnsNameOptions&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyPrivateDnsNameOptions
- operationId: GET_ModifyPrivateDnsNameOptions
- description: Modifies the options for instance hostnames for the specified instance.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyPrivateDnsNameOptionsResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceId
- in: query
- required: false
- description: The ID of the instance.
- schema:
- type: string
- - name: PrivateDnsHostnameType
- in: query
- required: false
- description: 'The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.'
- schema:
- type: string
- enum:
- - ip-name
- - resource-name
- - name: EnableResourceNameDnsARecord
- in: query
- required: false
- description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
- schema:
- type: boolean
- - name: EnableResourceNameDnsAAAARecord
- in: query
- required: false
- description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyPrivateDnsNameOptions
- operationId: POST_ModifyPrivateDnsNameOptions
- description: Modifies the options for instance hostnames for the specified instance.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyPrivateDnsNameOptionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyPrivateDnsNameOptionsRequest'
- parameters: []
- /?Action=ModifyReservedInstances&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyReservedInstances
- operationId: GET_ModifyReservedInstances
- description: 'Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyReservedInstancesResult' - parameters: - - name: ReservedInstancesId - in: query - required: true - description: The IDs of the Reserved Instances to modify. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservationId' - - xml: - name: ReservedInstancesId - - name: ClientToken - in: query - required: false - description: 'A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: ReservedInstancesConfigurationSetItemType - in: query - required: true - description: The configuration settings for the Reserved Instances to modify. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservedInstancesConfiguration' - - xml: - name: item - 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' - post: - x-aws-operation-name: ModifyReservedInstances - operationId: POST_ModifyReservedInstances - description: 'Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyReservedInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyReservedInstancesRequest' - parameters: [] - /?Action=ModifySecurityGroupRules&Version=2016-11-15: - get: - x-aws-operation-name: ModifySecurityGroupRules - operationId: GET_ModifySecurityGroupRules - description: Modifies the rules of a security group. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySecurityGroupRulesResult' - parameters: - - name: GroupId - in: query - required: true - description: The ID of the security group. - schema: - type: string - - name: SecurityGroupRule - in: query - required: true - description: Information about the security group properties to update. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleUpdate' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifySecurityGroupRules
- operationId: POST_ModifySecurityGroupRules
- description: Modifies the rules of a security group.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifySecurityGroupRulesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifySecurityGroupRulesRequest'
- parameters: []
- /?Action=ModifySnapshotAttribute&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifySnapshotAttribute
- operationId: GET_ModifySnapshotAttribute
- description: 'Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot''s list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.
Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - parameters: - - name: Attribute - in: query - required: false - description: The snapshot attribute to modify. Only volume creation permissions can be modified. - schema: - type: string - enum: - - productCodes - - createVolumePermission - - name: CreateVolumePermission - in: query - required: false - description: A JSON representation of the snapshot attribute modification. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/CreateVolumePermissionList' - - description: Removes the specified Amazon Web Services account ID or group from the list. - description: Describes modifications to the list of create volume permissions for a volume. - - name: UserGroup - in: query - required: false - description: The group to modify for the snapshot. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupName' - - xml: - name: GroupName - - name: OperationType - in: query - required: false - description: The type of operation to perform to the attribute. - schema: - type: string - enum: - - add - - remove - - name: SnapshotId - in: query - required: true - description: The ID of the snapshot. - schema: - type: string - - name: UserId - in: query - required: false - description: The account ID to modify for the snapshot. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: UserId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifySnapshotAttribute
- operationId: POST_ModifySnapshotAttribute
- description: 'Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot''s list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.
Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySnapshotAttributeRequest' - parameters: [] - /?Action=ModifySnapshotTier&Version=2016-11-15: - get: - x-aws-operation-name: ModifySnapshotTier - operationId: GET_ModifySnapshotTier - description: 'Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySnapshotTierResult' - parameters: - - name: SnapshotId - in: query - required: true - description: The ID of the snapshot. - schema: - type: string - - name: StorageTier - in: query - required: false - description: The name of the storage tier. You must specifyarchive.
- schema:
- type: string
- enum:
- - archive
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifySnapshotTier
- operationId: POST_ModifySnapshotTier
- description: 'Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifySnapshotTierResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifySnapshotTierRequest'
- parameters: []
- /?Action=ModifySpotFleetRequest&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifySpotFleetRequest
- operationId: GET_ModifySpotFleetRequest
- description: 'Modifies the specified Spot Fleet request.
You can only modify a Spot Fleet request of type maintain.
While the Spot Fleet request is being modified, it is in the modifying state.
To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacityOptimized, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.
If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySpotFleetRequestResponse' - parameters: - - name: ExcessCapacityTerminationPolicy - in: query - required: false - description: Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet. - schema: - type: string - enum: - - noTermination - - default - - name: LaunchTemplateConfig - in: query - required: false - description: 'The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateConfig'
- - xml:
- name: item
- - name: SpotFleetRequestId
- in: query
- required: true
- description: The ID of the Spot Fleet request.
- schema:
- type: string
- - name: TargetCapacity
- in: query
- required: false
- description: The size of the fleet.
- schema:
- type: integer
- - name: OnDemandTargetCapacity
- in: query
- required: false
- description: The number of On-Demand Instances in the fleet.
- schema:
- type: integer
- - name: Context
- in: query
- required: false
- description: Reserved.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ModifySpotFleetRequest
- operationId: POST_ModifySpotFleetRequest
- description: 'Modifies the specified Spot Fleet request.
You can only modify a Spot Fleet request of type maintain.
While the Spot Fleet request is being modified, it is in the modifying state.
To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacityOptimized, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.
If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySpotFleetRequestResponse' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySpotFleetRequestRequest' - parameters: [] - /?Action=ModifySubnetAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifySubnetAttribute - operationId: GET_ModifySubnetAttribute - description: 'Modifies a subnet attribute. You can only modify one attribute at a time.
Use this action to modify subnets on Amazon Web Services Outposts.
To modify a subnet on an Outpost rack, set both MapCustomerOwnedIpOnLaunch and CustomerOwnedIpv4Pool. These two parameters act as a single attribute.
To modify a subnet on an Outpost server, set either EnableLniAtDeviceIndex or DisableLniAtDeviceIndex.
For more information about Amazon Web Services Outposts, see the following:
' - responses: - '200': - description: Success - parameters: - - name: AssignIpv6AddressOnCreation - in: query - required: false - description: 'Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that''s created when launching an instance into the subnet (the instance therefore receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it''s created using version 2016-11-15 or later of the Amazon EC2 API.
true or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: MapPublicIpOnLaunch
- in: query
- required: false
- description: Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address.
- schema:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The attribute value. The valid values are true or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: SubnetId
- in: query
- required: true
- description: The ID of the subnet.
- schema:
- type: string
- - name: MapCustomerOwnedIpOnLaunch
- in: query
- required: false
- description: 'Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
true or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: CustomerOwnedIpv4Pool
- in: query
- required: false
- description: The customer-owned IPv4 address pool associated with the subnet.
You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
true or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: PrivateDnsHostnameTypeOnLaunch
- in: query
- required: false
- description: 'The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).'
- schema:
- type: string
- enum:
- - ip-name
- - resource-name
- - name: EnableResourceNameDnsARecordOnLaunch
- in: query
- required: false
- description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
- schema:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The attribute value. The valid values are true or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: EnableResourceNameDnsAAAARecordOnLaunch
- in: query
- required: false
- description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
- schema:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The attribute value. The valid values are true or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: EnableLniAtDeviceIndex
- in: query
- required: false
- description: ' Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1). A local network interface cannot be the primary network interface (eth0). '
- schema:
- type: integer
- - name: DisableLniAtDeviceIndex
- in: query
- required: false
- description: ' Specify true to indicate that local network interfaces at the current position should be disabled. '
- schema:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The attribute value. The valid values are true or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- 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'
- post:
- x-aws-operation-name: ModifySubnetAttribute
- operationId: POST_ModifySubnetAttribute
- description: 'Modifies a subnet attribute. You can only modify one attribute at a time.
Use this action to modify subnets on Amazon Web Services Outposts.
To modify a subnet on an Outpost rack, set both MapCustomerOwnedIpOnLaunch and CustomerOwnedIpv4Pool. These two parameters act as a single attribute.
To modify a subnet on an Outpost server, set either EnableLniAtDeviceIndex or DisableLniAtDeviceIndex.
For more information about Amazon Web Services Outposts, see the following:
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySubnetAttributeRequest' - parameters: [] - /?Action=ModifyTrafficMirrorFilterNetworkServices&Version=2016-11-15: - get: - x-aws-operation-name: ModifyTrafficMirrorFilterNetworkServices - operationId: GET_ModifyTrafficMirrorFilterNetworkServices - description: 'Allows or restricts mirroring network services.
By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyTrafficMirrorFilterNetworkServices
- operationId: POST_ModifyTrafficMirrorFilterNetworkServices
- description: 'Allows or restricts mirroring network services.
By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.
Modifies the specified Traffic Mirror rule.
DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.
The properties that you want to remove from the Traffic Mirror filter rule.
When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
' - schema: - type: array - items: - $ref: '#/components/schemas/TrafficMirrorFilterRuleField' - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyTrafficMirrorFilterRule
- operationId: POST_ModifyTrafficMirrorFilterRule
- description: Modifies the specified Traffic Mirror rule.
DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
- schema: - type: integer - - name: VirtualNetworkId - in: query - required: false - description: The virtual network ID of the Traffic Mirror session. - schema: - type: integer - - name: Description - in: query - required: false - description: The description to assign to the Traffic Mirror session. - schema: - type: string - - name: RemoveField - in: query - required: false - description: 'The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the default.
' - schema: - type: array - items: - $ref: '#/components/schemas/TrafficMirrorSessionField' - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyTrafficMirrorSession
- operationId: POST_ModifyTrafficMirrorSession
- description: Modifies a Traffic Mirror session.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyTrafficMirrorSessionResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyTrafficMirrorSessionRequest'
- parameters: []
- /?Action=ModifyTransitGateway&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyTransitGateway
- operationId: GET_ModifyTransitGateway
- description: 'Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyTransitGatewayResult'
- parameters:
- - name: TransitGatewayId
- in: query
- required: true
- description: The ID of the transit gateway.
- schema:
- type: string
- - name: Description
- in: query
- required: false
- description: The description for the transit gateway.
- schema:
- type: string
- - name: Options
- in: query
- required: false
- description: The options to modify.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableId'
- - description: The ID of the default propagation route table.
- description: The transit gateway options.
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyTransitGateway
- operationId: POST_ModifyTransitGateway
- description: 'Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyTransitGatewayResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyTransitGatewayRequest'
- parameters: []
- /?Action=ModifyTransitGatewayPrefixListReference&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyTransitGatewayPrefixListReference
- operationId: GET_ModifyTransitGatewayPrefixListReference
- description: Modifies a reference (route) to a prefix list in a specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceResult'
- parameters:
- - name: TransitGatewayRouteTableId
- in: query
- required: true
- description: The ID of the transit gateway route table.
- schema:
- type: string
- - name: PrefixListId
- in: query
- required: true
- description: The ID of the prefix list.
- schema:
- type: string
- - name: TransitGatewayAttachmentId
- in: query
- required: false
- description: The ID of the attachment to which traffic is routed.
- schema:
- type: string
- - name: Blackhole
- in: query
- required: false
- description: Indicates whether to drop traffic that matches this route.
- schema:
- type: boolean
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyTransitGatewayPrefixListReference
- operationId: POST_ModifyTransitGatewayPrefixListReference
- description: Modifies a reference (route) to a prefix list in a specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceRequest'
- parameters: []
- /?Action=ModifyTransitGatewayVpcAttachment&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyTransitGatewayVpcAttachment
- operationId: GET_ModifyTransitGatewayVpcAttachment
- description: Modifies the specified VPC attachment.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentResult'
- parameters:
- - name: TransitGatewayAttachmentId
- in: query
- required: true
- description: The ID of the attachment.
- schema:
- type: string
- - name: AddSubnetIds
- in: query
- required: false
- description: The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - xml:
- name: item
- - name: RemoveSubnetIds
- in: query
- required: false
- description: The IDs of one or more subnets to remove.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - xml:
- name: item
- - name: Options
- in: query
- required: false
- description: The new VPC attachment options.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ApplianceModeSupportValue'
- - description: 'Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.'
- description: Describes the options for a VPC attachment.
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyTransitGatewayVpcAttachment
- operationId: POST_ModifyTransitGatewayVpcAttachment
- description: Modifies the specified VPC attachment.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentRequest'
- parameters: []
- /?Action=ModifyVolume&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyVolume
- operationId: GET_ModifyVolume
- description: 'You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) or Amazon EBS Elastic Volumes (Windows instances).
When you complete a resize operation on your volume, you need to extend the volume''s file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or Extend a Windows file system.
You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitor the progress of volume modifications.
With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.
After modifying a volume, you must wait at least six hours and ensure that the volume is in the in-use or available state before you can modify the same volume. This is sometimes referred to as a cooldown period.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VolumeId
- in: query
- required: true
- description: The ID of the volume.
- schema:
- type: string
- - name: Size
- in: query
- required: false
- description: 'The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.
The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
Default: The existing size is retained.
' - schema: - type: integer - - name: VolumeType - in: query - required: false - description: 'The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: The existing type is retained.
' - schema: - type: string - enum: - - standard - - io1 - - io2 - - gp2 - - sc1 - - st1 - - gp3 - - name: Iops - in: query - required: false - description: 'The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1, io2, or gp3, the default is 3,000.
The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.
Default: The existing value is retained if the source and target volume type is gp3. Otherwise, the default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
' - schema: - type: integer - - name: MultiAttachEnabled - in: query - required: false - description: 'Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported withio1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyVolume
- operationId: POST_ModifyVolume
- description: 'You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) or Amazon EBS Elastic Volumes (Windows instances).
When you complete a resize operation on your volume, you need to extend the volume''s file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or Extend a Windows file system.
You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitor the progress of volume modifications.
With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.
After modifying a volume, you must wait at least six hours and ensure that the volume is in the in-use or available state before you can modify the same volume. This is sometimes referred to as a cooldown period.
Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
' - responses: - '200': - description: Success - parameters: - - name: AutoEnableIO - in: query - required: false - description: Indicates whether the volume should be auto-enabled for I/O operations. - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values aretrue or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: VolumeId
- in: query
- required: true
- description: The ID of the volume.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyVolumeAttribute
- operationId: POST_ModifyVolumeAttribute
- description: 'Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVolumeAttributeRequest' - parameters: [] - /?Action=ModifyVpcAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpcAttribute - operationId: GET_ModifyVpcAttribute - description: Modifies the specified attribute of the specified VPC. - responses: - '200': - description: Success - parameters: - - name: EnableDnsHostnames - in: query - required: false - description: 'Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you''ve enabled DNS support.
' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values aretrue or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: EnableDnsSupport
- in: query
- required: false
- description: 'Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values aretrue or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- - name: VpcId
- in: query
- required: true
- description: The ID of the VPC.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ModifyVpcAttribute
- operationId: POST_ModifyVpcAttribute
- description: Modifies the specified attribute of the specified VPC.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpcAttributeRequest'
- parameters: []
- /?Action=ModifyVpcEndpoint&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyVpcEndpoint
- operationId: GET_ModifyVpcEndpoint
- description: 'Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpcEndpointResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcEndpointId
- in: query
- required: true
- description: The ID of the endpoint.
- schema:
- type: string
- - name: ResetPolicy
- in: query
- required: false
- description: (Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.
- schema:
- type: boolean
- - name: PolicyDocument
- in: query
- required: false
- description: (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.
- schema:
- type: string
- - name: AddRouteTableId
- in: query
- required: false
- description: (Gateway endpoint) One or more route tables IDs to associate with the endpoint.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/RouteTableId'
- - xml:
- name: item
- - name: RemoveRouteTableId
- in: query
- required: false
- description: (Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/RouteTableId'
- - xml:
- name: item
- - name: AddSubnetId
- in: query
- required: false
- description: '(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - xml:
- name: item
- - name: RemoveSubnetId
- in: query
- required: false
- description: (Interface endpoint) One or more subnets IDs in which to remove the endpoint.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - xml:
- name: item
- - name: AddSecurityGroupId
- in: query
- required: false
- description: (Interface endpoint) One or more security group IDs to associate with the network interface.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: item
- - name: RemoveSecurityGroupId
- in: query
- required: false
- description: (Interface endpoint) One or more security group IDs to disassociate from the network interface.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: item
- - name: IpAddressType
- in: query
- required: false
- description: The IP address type for the endpoint.
- schema:
- type: string
- enum:
- - ipv4
- - dualstack
- - ipv6
- - name: DnsOptions
- in: query
- required: false
- description: The DNS options for the endpoint.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/DnsRecordIpType'
- - description: The DNS records created for the endpoint.
- description: Describes the DNS options for an endpoint.
- - name: PrivateDnsEnabled
- in: query
- required: false
- description: (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyVpcEndpoint
- operationId: POST_ModifyVpcEndpoint
- description: 'Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpcEndpointResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpcEndpointRequest'
- parameters: []
- /?Action=ModifyVpcEndpointConnectionNotification&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyVpcEndpointConnectionNotification
- operationId: GET_ModifyVpcEndpointConnectionNotification
- description: 'Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified. '
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ConnectionNotificationId
- in: query
- required: true
- description: The ID of the notification.
- schema:
- type: string
- - name: ConnectionNotificationArn
- in: query
- required: false
- description: The ARN for the SNS topic for the notification.
- schema:
- type: string
- - name: ConnectionEvents
- in: query
- required: false
- description: 'One or more events for the endpoint. Valid values are Accept, Connect, Delete, and Reject.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: ModifyVpcEndpointConnectionNotification
- operationId: POST_ModifyVpcEndpointConnectionNotification
- description: 'Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified. '
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationRequest'
- parameters: []
- /?Action=ModifyVpcEndpointServiceConfiguration&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyVpcEndpointServiceConfiguration
- operationId: GET_ModifyVpcEndpointServiceConfiguration
- description: 'Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ServiceId
- in: query
- required: true
- description: The ID of the service.
- schema:
- type: string
- - name: PrivateDnsName
- in: query
- required: false
- description: (Interface endpoint configuration) The private DNS name to assign to the endpoint service.
- schema:
- type: string
- - name: RemovePrivateDnsName
- in: query
- required: false
- description: (Interface endpoint configuration) Removes the private DNS name of the endpoint service.
- schema:
- type: boolean
- - name: AcceptanceRequired
- in: query
- required: false
- description: Indicates whether requests to create an endpoint to your service must be accepted.
- schema:
- type: boolean
- - name: AddNetworkLoadBalancerArn
- in: query
- required: false
- description: The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: RemoveNetworkLoadBalancerArn
- in: query
- required: false
- description: The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: AddGatewayLoadBalancerArn
- in: query
- required: false
- description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: RemoveGatewayLoadBalancerArn
- in: query
- required: false
- description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: AddSupportedIpAddressType
- in: query
- required: false
- description: The IP address types to add to your service configuration.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: RemoveSupportedIpAddressType
- in: query
- required: false
- description: The IP address types to remove from your service configuration.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: ModifyVpcEndpointServiceConfiguration
- operationId: POST_ModifyVpcEndpointServiceConfiguration
- description: 'Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationRequest' - parameters: [] - /?Action=ModifyVpcEndpointServicePayerResponsibility&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpcEndpointServicePayerResponsibility - operationId: GET_ModifyVpcEndpointServicePayerResponsibility - description: Modifies the payer responsibility for your VPC endpoint service. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServicePayerResponsibilityResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ServiceId
- in: query
- required: true
- description: The ID of the service.
- schema:
- type: string
- - name: PayerResponsibility
- in: query
- required: true
- description: 'The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.'
- schema:
- type: string
- enum:
- - ServiceOwner
- 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'
- post:
- x-aws-operation-name: ModifyVpcEndpointServicePayerResponsibility
- operationId: POST_ModifyVpcEndpointServicePayerResponsibility
- description: Modifies the payer responsibility for your VPC endpoint service.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpcEndpointServicePayerResponsibilityResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpcEndpointServicePayerResponsibilityRequest'
- parameters: []
- /?Action=ModifyVpcEndpointServicePermissions&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyVpcEndpointServicePermissions
- operationId: GET_ModifyVpcEndpointServicePermissions
- description: 'Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.
If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ServiceId
- in: query
- required: true
- description: The ID of the service.
- schema:
- type: string
- - name: AddAllowedPrincipals
- in: query
- required: false
- description: 'The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: RemoveAllowedPrincipals
- in: query
- required: false
- description: The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: ModifyVpcEndpointServicePermissions
- operationId: POST_ModifyVpcEndpointServicePermissions
- description: 'Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.
If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsRequest' - parameters: [] - /?Action=ModifyVpcPeeringConnectionOptions&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpcPeeringConnectionOptions - operationId: GET_ModifyVpcPeeringConnectionOptions - description: 'Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
Enable/disable communication over the peering connection between an EC2-Classic instance that''s linked to your VPC (using ClassicLink) and instances in the peer VPC.
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that''s linked to the peer VPC.
Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsResult' - parameters: - - name: AccepterPeeringConnectionOptions - in: query - required: false - description: The VPC peering connection options for the accepter VPC. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that''s linked to a peer VPC using ClassicLink.' - description: The VPC peering connection options. - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: RequesterPeeringConnectionOptions
- in: query
- required: false
- description: The VPC peering connection options for the requester VPC.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that''s linked to a peer VPC using ClassicLink.'
- description: The VPC peering connection options.
- - name: VpcPeeringConnectionId
- in: query
- required: true
- description: The ID of the VPC peering connection.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ModifyVpcPeeringConnectionOptions
- operationId: POST_ModifyVpcPeeringConnectionOptions
- description: 'Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
Enable/disable communication over the peering connection between an EC2-Classic instance that''s linked to your VPC (using ClassicLink) and instances in the peer VPC.
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that''s linked to the peer VPC.
Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsRequest' - parameters: [] - /?Action=ModifyVpcTenancy&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpcTenancy - operationId: GET_ModifyVpcTenancy - description: 'Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated.
After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.
For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcTenancyResult' - parameters: - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: InstanceTenancy - in: query - required: true - description: 'The instance tenancy attribute for the VPC. ' - schema: - type: string - enum: - - default - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyVpcTenancy
- operationId: POST_ModifyVpcTenancy
- description: 'Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated.
After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.
For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcTenancyResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcTenancyRequest' - parameters: [] - /?Action=ModifyVpnConnection&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpnConnection - operationId: GET_ModifyVpnConnection - description: 'Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:
An existing virtual private gateway to a new virtual private gateway
An existing virtual private gateway to a transit gateway
An existing transit gateway to a new transit gateway
An existing transit gateway to a virtual private gateway
Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.
This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.
You must delete the static routes before you migrate to the new gateway.
Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.
After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route tables in the Amazon Web Services Site-to-Site VPN User Guide.
When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.
If you deleted VPN static routes, you must add the static routes to the transit gateway route table.
After you perform this operation, the VPN endpoint''s IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnConnectionResult' - parameters: - - name: VpnConnectionId - in: query - required: true - description: The ID of the VPN connection. - schema: - type: string - - name: TransitGatewayId - in: query - required: false - description: The ID of the transit gateway. - schema: - type: string - - name: CustomerGatewayId - in: query - required: false - description: The ID of the customer gateway at your end of the VPN connection. - schema: - type: string - - name: VpnGatewayId - in: query - required: false - description: The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyVpnConnection
- operationId: POST_ModifyVpnConnection
- description: 'Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:
An existing virtual private gateway to a new virtual private gateway
An existing virtual private gateway to a transit gateway
An existing transit gateway to a new transit gateway
An existing transit gateway to a virtual private gateway
Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.
This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.
You must delete the static routes before you migrate to the new gateway.
Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.
After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route tables in the Amazon Web Services Site-to-Site VPN User Guide.
When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.
If you deleted VPN static routes, you must add the static routes to the transit gateway route table.
After you perform this operation, the VPN endpoint''s IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnConnectionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnConnectionRequest' - parameters: [] - /?Action=ModifyVpnConnectionOptions&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpnConnectionOptions - operationId: GET_ModifyVpnConnectionOptions - description: 'Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnConnectionOptionsResult' - parameters: - - name: VpnConnectionId - in: query - required: true - description: 'The ID of the Site-to-Site VPN connection. ' - schema: - type: string - - name: LocalIpv4NetworkCidr - in: query - required: false - description: 'The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
Default: 0.0.0.0/0
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyVpnConnectionOptions
- operationId: POST_ModifyVpnConnectionOptions
- description: 'Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnConnectionOptionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnConnectionOptionsRequest' - parameters: [] - /?Action=ModifyVpnTunnelCertificate&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpnTunnelCertificate - operationId: GET_ModifyVpnTunnelCertificate - description: Modifies the VPN tunnel endpoint certificate. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnTunnelCertificateResult' - parameters: - - name: VpnConnectionId - in: query - required: true - description: The ID of the Amazon Web Services Site-to-Site VPN connection. - schema: - type: string - - name: VpnTunnelOutsideIpAddress - in: query - required: true - description: The external IP address of the VPN tunnel. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyVpnTunnelCertificate
- operationId: POST_ModifyVpnTunnelCertificate
- description: Modifies the VPN tunnel endpoint certificate.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpnTunnelCertificateResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpnTunnelCertificateRequest'
- parameters: []
- /?Action=ModifyVpnTunnelOptions&Version=2016-11-15:
- get:
- x-aws-operation-name: ModifyVpnTunnelOptions
- operationId: GET_ModifyVpnTunnelOptions
- description: 'Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpnTunnelOptionsResult'
- parameters:
- - name: VpnConnectionId
- in: query
- required: true
- description: The ID of the Amazon Web Services Site-to-Site VPN connection.
- schema:
- type: string
- - name: VpnTunnelOutsideIpAddress
- in: query
- required: true
- description: The external IP address of the VPN tunnel.
- schema:
- type: string
- - name: TunnelOptions
- in: query
- required: true
- description: The tunnel options to modify.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ModifyVpnTunnelOptions
- operationId: POST_ModifyVpnTunnelOptions
- description: 'Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpnTunnelOptionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ModifyVpnTunnelOptionsRequest'
- parameters: []
- /?Action=MonitorInstances&Version=2016-11-15:
- get:
- x-aws-operation-name: MonitorInstances
- operationId: GET_MonitorInstances
- description: 'Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.
To disable detailed monitoring, see UnmonitorInstances.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/MonitorInstancesResult' - parameters: - - name: InstanceId - in: query - required: true - description: The IDs of the instances. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: MonitorInstances
- operationId: POST_MonitorInstances
- description: 'Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.
To disable detailed monitoring, see UnmonitorInstances.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/MonitorInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/MonitorInstancesRequest' - parameters: [] - /?Action=MoveAddressToVpc&Version=2016-11-15: - get: - x-aws-operation-name: MoveAddressToVpc - operationId: GET_MoveAddressToVpc - description: 'Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/MoveAddressToVpcResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PublicIp
- in: query
- required: true
- description: The Elastic IP address.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: MoveAddressToVpc
- operationId: POST_MoveAddressToVpc
- description: 'Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform. '
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/MoveAddressToVpcResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/MoveAddressToVpcRequest'
- parameters: []
- /?Action=MoveByoipCidrToIpam&Version=2016-11-15:
- get:
- x-aws-operation-name: MoveByoipCidrToIpam
- operationId: GET_MoveByoipCidrToIpam
- description: 'Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.
If you already have an IPv4 BYOIP CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/MoveByoipCidrToIpamResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Cidr
- in: query
- required: true
- description: The BYOIP CIDR.
- schema:
- type: string
- - name: IpamPoolId
- in: query
- required: true
- description: The IPAM pool ID.
- schema:
- type: string
- - name: IpamPoolOwner
- in: query
- required: true
- description: The Amazon Web Services account ID of the owner of the IPAM pool.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: MoveByoipCidrToIpam
- operationId: POST_MoveByoipCidrToIpam
- description: 'Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.
If you already have an IPv4 BYOIP CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/MoveByoipCidrToIpamResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/MoveByoipCidrToIpamRequest' - parameters: [] - /?Action=ProvisionByoipCidr&Version=2016-11-15: - get: - x-aws-operation-name: ProvisionByoipCidr - operationId: GET_ProvisionByoipCidr - description: 'Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
' - schema: - type: boolean - - name: Description - in: query - required: false - description: A description for the address range and the address pool. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PoolTagSpecification
- in: query
- required: false
- description: The tags to apply to the address pool.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: MultiRegion
- in: query
- required: false
- description: Reserved.
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ProvisionByoipCidr
- operationId: POST_ProvisionByoipCidr
- description: 'Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.
For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionIpamPoolCidrResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamPoolId
- in: query
- required: true
- description: The ID of the IPAM pool to which you want to assign a CIDR.
- schema:
- type: string
- - name: Cidr
- in: query
- required: false
- description: The CIDR you want to assign to the IPAM pool.
- schema:
- type: string
- - name: CidrAuthorizationContext
- in: query
- required: false
- description: A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The signed authorization message for the prefix and account.
- description: A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
- 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'
- post:
- x-aws-operation-name: ProvisionIpamPoolCidr
- operationId: POST_ProvisionIpamPoolCidr
- description: 'Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.
For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionIpamPoolCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionIpamPoolCidrRequest' - parameters: [] - /?Action=ProvisionPublicIpv4PoolCidr&Version=2016-11-15: - get: - x-aws-operation-name: ProvisionPublicIpv4PoolCidr - operationId: GET_ProvisionPublicIpv4PoolCidr - description: 'Provision a CIDR to a public IPv4 pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionPublicIpv4PoolCidrResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamPoolId
- in: query
- required: true
- description: The ID of the IPAM pool you would like to use to allocate this CIDR.
- schema:
- type: string
- - name: PoolId
- in: query
- required: true
- description: The ID of the public IPv4 pool you would like to use for this CIDR.
- schema:
- type: string
- - name: NetmaskLength
- in: query
- required: true
- description: The netmask length of the CIDR you would like to allocate to the public IPv4 pool.
- schema:
- type: integer
- 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'
- post:
- x-aws-operation-name: ProvisionPublicIpv4PoolCidr
- operationId: POST_ProvisionPublicIpv4PoolCidr
- description: 'Provision a CIDR to a public IPv4 pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionPublicIpv4PoolCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionPublicIpv4PoolCidrRequest' - parameters: [] - /?Action=PurchaseHostReservation&Version=2016-11-15: - get: - x-aws-operation-name: PurchaseHostReservation - operationId: GET_PurchaseHostReservation - description: Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseHostReservationResult' - parameters: - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: CurrencyCode - in: query - required: false - description: 'The currency in which thetotalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.'
- schema:
- type: string
- enum:
- - USD
- - name: HostIdSet
- in: query
- required: true
- description: The IDs of the Dedicated Hosts with which the reservation will be associated.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DedicatedHostId'
- - xml:
- name: item
- - name: LimitPrice
- in: query
- required: false
- description: 'The specified limit is checked against the total upfront cost of the reservation (calculated as the offering''s upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.'
- schema:
- type: string
- - name: OfferingId
- in: query
- required: true
- description: The ID of the offering.
- schema:
- type: string
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply to the Dedicated Host Reservation during purchase.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: PurchaseHostReservation
- operationId: POST_PurchaseHostReservation
- description: Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/PurchaseHostReservationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/PurchaseHostReservationRequest'
- parameters: []
- /?Action=PurchaseReservedInstancesOffering&Version=2016-11-15:
- get:
- x-aws-operation-name: PurchaseReservedInstancesOffering
- operationId: GET_PurchaseReservedInstancesOffering
- description: 'Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you''ve purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseReservedInstancesOfferingResult' - parameters: - - name: InstanceCount - in: query - required: true - description: The number of Reserved Instances to purchase. - schema: - type: integer - - name: ReservedInstancesOfferingId - in: query - required: true - description: The ID of the Reserved Instance offering to purchase. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: LimitPrice
- in: query
- required: false
- description: Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
- schema:
- type: object
- properties:
- amount:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
- currencyCode:
- allOf:
- - $ref: '#/components/schemas/CurrencyCodeValues'
- - description: 'The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.'
- description: Describes the limit price of a Reserved Instance offering.
- - name: PurchaseTime
- in: query
- required: false
- description: 'The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- schema:
- type: string
- format: date-time
- 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'
- post:
- x-aws-operation-name: PurchaseReservedInstancesOffering
- operationId: POST_PurchaseReservedInstancesOffering
- description: 'Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you''ve purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseReservedInstancesOfferingResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseReservedInstancesOfferingRequest' - parameters: [] - /?Action=PurchaseScheduledInstances&Version=2016-11-15: - get: - x-aws-operation-name: PurchaseScheduledInstances - operationId: GET_PurchaseScheduledInstances - description: 'Purchases the Scheduled Instances with the specified schedule.
Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.
After you purchase a Scheduled Instance, you can''t cancel, modify, or resell your purchase.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseScheduledInstancesResult' - parameters: - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PurchaseRequest
- in: query
- required: true
- description: The purchase requests.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PurchaseRequest'
- - xml:
- name: PurchaseRequest
- minItems: 1
- 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'
- post:
- x-aws-operation-name: PurchaseScheduledInstances
- operationId: POST_PurchaseScheduledInstances
- description: 'Purchases the Scheduled Instances with the specified schedule.
Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.
After you purchase a Scheduled Instance, you can''t cancel, modify, or resell your purchase.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseScheduledInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseScheduledInstancesRequest' - parameters: [] - /?Action=RebootInstances&Version=2016-11-15: - get: - x-aws-operation-name: RebootInstances - operationId: GET_RebootInstances - description: 'Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Troubleshoot an unreachable instance in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - parameters: - - name: InstanceId - in: query - required: true - description: The instance IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: RebootInstances
- operationId: POST_RebootInstances
- description: 'Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Troubleshoot an unreachable instance in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RebootInstancesRequest' - parameters: [] - /?Action=RegisterImage&Version=2016-11-15: - get: - x-aws-operation-name: RegisterImage - operationId: GET_RegisterImage - description: 'Registers an AMI. When you''re creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating your own AMIs in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don''t have to register the AMI yourself.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can''t set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
Amazon Web Services Marketplace product codes
If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterImageResult' - parameters: - - name: ImageLocation - in: query - required: false - description: 'The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have theaws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.'
- schema:
- type: string
- - name: Architecture
- in: query
- required: false
- description: 'The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
The block device mapping entries.
If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can''t specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/BlockDeviceMapping' - - xml: - name: BlockDeviceMapping - - name: Description - in: query - required: false - description: A description for your AMI. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: EnaSupport
- in: query
- required: false
- description: Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
- schema: - type: boolean - - name: KernelId - in: query - required: false - description: The ID of the kernel. - schema: - type: string - - name: Name - in: query - required: true - description: 'A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)
' - schema: - type: string - - name: BillingProduct - in: query - required: false - description: 'The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the Amazon Web Services Marketplace to bill for the use of an AMI.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: RamdiskId - in: query - required: false - description: The ID of the RAM disk. - schema: - type: string - - name: RootDeviceName - in: query - required: false - description: 'The device name of the root device volume (for example,/dev/sda1).'
- schema:
- type: string
- - name: SriovNetSupport
- in: query
- required: false
- description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
- schema: - type: string - - name: VirtualizationType - in: query - required: false - description: 'The type of virtualization (hvm | paravirtual).
Default: paravirtual
v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.'
- schema:
- type: string
- enum:
- - v2.0
- - name: UefiData
- in: query
- required: false
- description: 'Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.'
- schema:
- type: string
- minLength: 0
- maxLength: 64000
- 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'
- post:
- x-aws-operation-name: RegisterImage
- operationId: POST_RegisterImage
- description: 'Registers an AMI. When you''re creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating your own AMIs in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don''t have to register the AMI yourself.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can''t set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
Amazon Web Services Marketplace product codes
If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterImageRequest' - parameters: [] - /?Action=RegisterInstanceEventNotificationAttributes&Version=2016-11-15: - get: - x-aws-operation-name: RegisterInstanceEventNotificationAttributes - operationId: GET_RegisterInstanceEventNotificationAttributes - description: 'Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use DeregisterInstanceEventNotificationAttributes.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterInstanceEventNotificationAttributesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceTagAttribute
- in: query
- required: false
- description: Information about the tag keys to register.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to register all tag keys in the current Region. Specify true to register all tag keys.
- InstanceTagKey:
- allOf:
- - $ref: '#/components/schemas/InstanceTagKeySet'
- - description: The tag keys to register.
- description: Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
- 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'
- post:
- x-aws-operation-name: RegisterInstanceEventNotificationAttributes
- operationId: POST_RegisterInstanceEventNotificationAttributes
- description: 'Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use DeregisterInstanceEventNotificationAttributes.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterInstanceEventNotificationAttributesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterInstanceEventNotificationAttributesRequest' - parameters: [] - /?Action=RegisterTransitGatewayMulticastGroupMembers&Version=2016-11-15: - get: - x-aws-operation-name: RegisterTransitGatewayMulticastGroupMembers - operationId: GET_RegisterTransitGatewayMulticastGroupMembers - description: 'Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupMembersResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: GroupIpAddress - in: query - required: false - description: The IP address assigned to the transit gateway multicast group. - schema: - type: string - - name: NetworkInterfaceIds - in: query - required: false - description: The group members' network interface IDs to register with the transit gateway multicast group. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: RegisterTransitGatewayMulticastGroupMembers
- operationId: POST_RegisterTransitGatewayMulticastGroupMembers
- description: 'Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupMembersResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupMembersRequest' - parameters: [] - /?Action=RegisterTransitGatewayMulticastGroupSources&Version=2016-11-15: - get: - x-aws-operation-name: RegisterTransitGatewayMulticastGroupSources - operationId: GET_RegisterTransitGatewayMulticastGroupSources - description: 'Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupSourcesResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: GroupIpAddress - in: query - required: false - description: The IP address assigned to the transit gateway multicast group. - schema: - type: string - - name: NetworkInterfaceIds - in: query - required: false - description: The group sources' network interface IDs to register with the transit gateway multicast group. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: RegisterTransitGatewayMulticastGroupSources
- operationId: POST_RegisterTransitGatewayMulticastGroupSources
- description: 'Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupSourcesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupSourcesRequest' - parameters: [] - /?Action=RejectTransitGatewayMulticastDomainAssociations&Version=2016-11-15: - get: - x-aws-operation-name: RejectTransitGatewayMulticastDomainAssociations - operationId: GET_RejectTransitGatewayMulticastDomainAssociations - description: Rejects a request to associate cross-account subnets with a transit gateway multicast domain. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectTransitGatewayMulticastDomainAssociationsResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the transit gateway attachment. - schema: - type: string - - name: SubnetIds - in: query - required: false - description: The IDs of the subnets to associate with the transit gateway multicast domain. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: RejectTransitGatewayMulticastDomainAssociations
- operationId: POST_RejectTransitGatewayMulticastDomainAssociations
- description: Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RejectTransitGatewayMulticastDomainAssociationsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RejectTransitGatewayMulticastDomainAssociationsRequest'
- parameters: []
- /?Action=RejectTransitGatewayPeeringAttachment&Version=2016-11-15:
- get:
- x-aws-operation-name: RejectTransitGatewayPeeringAttachment
- operationId: GET_RejectTransitGatewayPeeringAttachment
- description: Rejects a transit gateway peering attachment request.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentResult'
- parameters:
- - name: TransitGatewayAttachmentId
- in: query
- required: true
- description: The ID of the transit gateway peering attachment.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: RejectTransitGatewayPeeringAttachment
- operationId: POST_RejectTransitGatewayPeeringAttachment
- description: Rejects a transit gateway peering attachment request.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentRequest'
- parameters: []
- /?Action=RejectTransitGatewayVpcAttachment&Version=2016-11-15:
- get:
- x-aws-operation-name: RejectTransitGatewayVpcAttachment
- operationId: GET_RejectTransitGatewayVpcAttachment
- description: Rejects a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: RejectTransitGatewayVpcAttachment
- operationId: POST_RejectTransitGatewayVpcAttachment
- description: Rejects a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ServiceId
- in: query
- required: true
- description: The ID of the service.
- schema:
- type: string
- - name: VpcEndpointId
- in: query
- required: true
- description: The IDs of one or more VPC endpoints.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointId'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: RejectVpcEndpointConnections
- operationId: POST_RejectVpcEndpointConnections
- description: Rejects one or more VPC endpoint connection requests to your VPC endpoint service.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RejectVpcEndpointConnectionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RejectVpcEndpointConnectionsRequest'
- parameters: []
- /?Action=RejectVpcPeeringConnection&Version=2016-11-15:
- get:
- x-aws-operation-name: RejectVpcPeeringConnection
- operationId: GET_RejectVpcPeeringConnection
- description: 'Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RejectVpcPeeringConnectionResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcPeeringConnectionId
- in: query
- required: true
- description: The ID of the VPC peering connection.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: RejectVpcPeeringConnection
- operationId: POST_RejectVpcPeeringConnection
- description: 'Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RejectVpcPeeringConnectionResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RejectVpcPeeringConnectionRequest'
- parameters: []
- /?Action=ReleaseAddress&Version=2016-11-15:
- get:
- x-aws-operation-name: ReleaseAddress
- operationId: GET_ReleaseAddress
- description: 'Releases the specified Elastic IP address.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it''s associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you''ll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.
' - responses: - '200': - description: Success - parameters: - - name: AllocationId - in: query - required: false - description: '[EC2-VPC] The allocation ID. Required for EC2-VPC.' - schema: - type: string - - name: PublicIp - in: query - required: false - description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.' - schema: - type: string - - name: NetworkBorderGroup - in: query - required: false - description: 'The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you receive an InvalidParameterCombination error.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ReleaseAddress
- operationId: POST_ReleaseAddress
- description: 'Releases the specified Elastic IP address.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it''s associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you''ll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReleaseAddressRequest' - parameters: [] - /?Action=ReleaseHosts&Version=2016-11-15: - get: - x-aws-operation-name: ReleaseHosts - operationId: GET_ReleaseHosts - description: 'When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.
When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.
Released hosts still appear in a DescribeHosts response.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReleaseHostsResult' - parameters: - - name: HostId - in: query - required: true - description: The IDs of the Dedicated Hosts to release. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - xml: - name: item - 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' - post: - x-aws-operation-name: ReleaseHosts - operationId: POST_ReleaseHosts - description: 'When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.
When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.
Released hosts still appear in a DescribeHosts response.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReleaseHostsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReleaseHostsRequest' - parameters: [] - /?Action=ReleaseIpamPoolAllocation&Version=2016-11-15: - get: - x-aws-operation-name: ReleaseIpamPoolAllocation - operationId: GET_ReleaseIpamPoolAllocation - description: 'Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReleaseIpamPoolAllocationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: IpamPoolId
- in: query
- required: true
- description: The ID of the IPAM pool which contains the allocation you want to release.
- schema:
- type: string
- - name: Cidr
- in: query
- required: true
- description: The CIDR of the allocation you want to release.
- schema:
- type: string
- - name: IpamPoolAllocationId
- in: query
- required: true
- description: The ID of the allocation.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ReleaseIpamPoolAllocation
- operationId: POST_ReleaseIpamPoolAllocation
- description: 'Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide. '
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ReleaseIpamPoolAllocationResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ReleaseIpamPoolAllocationRequest'
- parameters: []
- /?Action=ReplaceIamInstanceProfileAssociation&Version=2016-11-15:
- get:
- x-aws-operation-name: ReplaceIamInstanceProfileAssociation
- operationId: GET_ReplaceIamInstanceProfileAssociation
- description: Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.
Use DescribeIamInstanceProfileAssociations to get the association ID.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationResult' - parameters: - - name: IamInstanceProfile - in: query - required: true - description: The IAM instance profile. - schema: - type: object - properties: - arn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the instance profile. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the instance profile. - description: Describes an IAM instance profile. - - name: AssociationId - in: query - required: true - description: The ID of the existing IAM instance profile association. - schema: - type: string - 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' - post: - x-aws-operation-name: ReplaceIamInstanceProfileAssociation - operationId: POST_ReplaceIamInstanceProfileAssociation - description:Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.
Use DescribeIamInstanceProfileAssociations to get the association ID.
- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationRequest' - parameters: [] - /?Action=ReplaceNetworkAclAssociation&Version=2016-11-15: - get: - x-aws-operation-name: ReplaceNetworkAclAssociation - operationId: GET_ReplaceNetworkAclAssociation - description: 'Changes which network ACL a subnet is associated with. By default when you create a subnet, it''s automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
This is an idempotent operation.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceNetworkAclAssociationResult' - parameters: - - name: AssociationId - in: query - required: true - description: The ID of the current association between the original network ACL and the subnet. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NetworkAclId
- in: query
- required: true
- description: The ID of the new network ACL to associate with the subnet.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ReplaceNetworkAclAssociation
- operationId: POST_ReplaceNetworkAclAssociation
- description: 'Changes which network ACL a subnet is associated with. By default when you create a subnet, it''s automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
This is an idempotent operation.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceNetworkAclAssociationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceNetworkAclAssociationRequest' - parameters: [] - /?Action=ReplaceNetworkAclEntry&Version=2016-11-15: - get: - x-aws-operation-name: ReplaceNetworkAclEntry - operationId: GET_ReplaceNetworkAclEntry - description: 'Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.' - responses: - '200': - description: Success - parameters: - - name: CidrBlock - in: query - required: false - description: 'The IPv4 network range to allow or deny, in CIDR notation (for example172.16.0.0/24).'
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Egress
- in: query
- required: true
- description: 'Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
' - schema: - type: boolean - - name: Icmp - in: query - required: false - description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.' - schema: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The ICMP code. A value of -1 means all codes for the specified ICMP type. - type: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The ICMP type. A value of -1 means all types. - description: Describes the ICMP type and code. - - name: Ipv6CidrBlock - in: query - required: false - description: 'The IPv6 network range to allow or deny, in CIDR notation (for example2001:bd8:1234:1a00::/64).'
- schema:
- type: string
- - name: NetworkAclId
- in: query
- required: true
- description: The ID of the ACL.
- schema:
- type: string
- - name: PortRange
- in: query
- required: false
- description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).'
- schema:
- type: object
- properties:
- from:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The first port in the range.
- to:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The last port in the range.
- description: Describes a range of ports.
- - name: Protocol
- in: query
- required: true
- description: 'The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.'
- schema:
- type: string
- - name: RuleAction
- in: query
- required: true
- description: Indicates whether to allow or deny the traffic that matches the rule.
- schema:
- type: string
- enum:
- - allow
- - deny
- - name: RuleNumber
- in: query
- required: true
- description: The rule number of the entry to replace.
- schema:
- type: integer
- 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'
- post:
- x-aws-operation-name: ReplaceNetworkAclEntry
- operationId: POST_ReplaceNetworkAclEntry
- description: 'Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.'
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ReplaceNetworkAclEntryRequest'
- parameters: []
- /?Action=ReplaceRoute&Version=2016-11-15:
- get:
- x-aws-operation-name: ReplaceRoute
- operationId: GET_ReplaceRoute
- description: 'Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - parameters: - - name: DestinationCidrBlock - in: query - required: false - description: The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table. - schema: - type: string - - name: DestinationIpv6CidrBlock - in: query - required: false - description: The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table. - schema: - type: string - - name: DestinationPrefixListId - in: query - required: false - description: The ID of the prefix list for the route. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: VpcEndpointId
- in: query
- required: false
- description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
- schema:
- type: string
- - name: EgressOnlyInternetGatewayId
- in: query
- required: false
- description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
- schema:
- type: string
- - name: GatewayId
- in: query
- required: false
- description: The ID of an internet gateway or virtual private gateway.
- schema:
- type: string
- - name: InstanceId
- in: query
- required: false
- description: The ID of a NAT instance in your VPC.
- schema:
- type: string
- - name: LocalTarget
- in: query
- required: false
- description: Specifies whether to reset the local route to its default target (local).
- schema:
- type: boolean
- - name: NatGatewayId
- in: query
- required: false
- description: '[IPv4 traffic only] The ID of a NAT gateway.'
- schema:
- type: string
- - name: TransitGatewayId
- in: query
- required: false
- description: The ID of a transit gateway.
- schema:
- type: string
- - name: LocalGatewayId
- in: query
- required: false
- description: The ID of the local gateway.
- schema:
- type: string
- - name: CarrierGatewayId
- in: query
- required: false
- description: '[IPv4 traffic only] The ID of a carrier gateway.'
- schema:
- type: string
- - name: NetworkInterfaceId
- in: query
- required: false
- description: The ID of a network interface.
- schema:
- type: string
- - name: RouteTableId
- in: query
- required: true
- description: The ID of the route table.
- schema:
- type: string
- - name: VpcPeeringConnectionId
- in: query
- required: false
- description: The ID of a VPC peering connection.
- schema:
- type: string
- - name: CoreNetworkArn
- in: query
- required: false
- description: The Amazon Resource Name (ARN) of the core network.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ReplaceRoute
- operationId: POST_ReplaceRoute
- description: 'Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceRouteRequest' - parameters: [] - /?Action=ReplaceRouteTableAssociation&Version=2016-11-15: - get: - x-aws-operation-name: ReplaceRouteTableAssociation - operationId: GET_ReplaceRouteTableAssociation - description: 'Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
You can also use this operation to change which table is the main route table in the VPC. Specify the main route table''s association ID and the route table ID of the new main route table.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceRouteTableAssociationResult' - parameters: - - name: AssociationId - in: query - required: true - description: The association ID. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: RouteTableId
- in: query
- required: true
- description: The ID of the new route table to associate with the subnet.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ReplaceRouteTableAssociation
- operationId: POST_ReplaceRouteTableAssociation
- description: 'Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
You can also use this operation to change which table is the main route table in the VPC. Specify the main route table''s association ID and the route table ID of the new main route table.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceRouteTableAssociationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceRouteTableAssociationRequest' - parameters: [] - /?Action=ReplaceTransitGatewayRoute&Version=2016-11-15: - get: - x-aws-operation-name: ReplaceTransitGatewayRoute - operationId: GET_ReplaceTransitGatewayRoute - description: Replaces the specified route in the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceTransitGatewayRouteResult' - parameters: - - name: DestinationCidrBlock - in: query - required: true - description: The CIDR range used for the destination match. Routing decisions are based on the most specific match. - schema: - type: string - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the route table. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the attachment. - schema: - type: string - - name: Blackhole - in: query - required: false - description: Indicates whether traffic matching this route is to be dropped. - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ReplaceTransitGatewayRoute
- operationId: POST_ReplaceTransitGatewayRoute
- description: Replaces the specified route in the specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ReplaceTransitGatewayRouteResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ReplaceTransitGatewayRouteRequest'
- parameters: []
- /?Action=ReportInstanceStatus&Version=2016-11-15:
- get:
- x-aws-operation-name: ReportInstanceStatus
- operationId: GET_ReportInstanceStatus
- description: 'Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
' - responses: - '200': - description: Success - parameters: - - name: Description - in: query - required: false - description: Descriptive text about the health state of your instance. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: EndTime
- in: query
- required: false
- description: The time at which the reported instance health state ended.
- schema:
- type: string
- format: date-time
- - name: InstanceId
- in: query
- required: true
- description: The instances.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - xml:
- name: InstanceId
- - name: ReasonCode
- in: query
- required: true
- description: 'The reason codes that describe the health state of your instance.
instance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems that I believe are network related.
performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReportInstanceStatusRequest' - parameters: [] - /?Action=RequestSpotFleet&Version=2016-11-15: - get: - x-aws-operation-name: RequestSpotFleet - operationId: GET_RequestSpotFleet - description: 'Creates a Spot Fleet request.
The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.
You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.
Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.
You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported.
For more information, see Spot Fleet requests in the Amazon EC2 User Guide for Linux Instances.
We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: SpotFleetRequestConfig
- in: query
- required: true
- description: The configuration for the Spot Fleet request.
- schema:
- type: object
- required:
- - IamFleetRole
- - TargetCapacity
- properties:
- allocationStrategy:
- allOf:
- - $ref: '#/components/schemas/AllocationStrategy'
- - description: 'Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.
If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.'
- spotMaintenanceStrategies:
- allOf:
- - $ref: '#/components/schemas/SpotMaintenanceStrategies'
- - description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.'
- excessCapacityTerminationPolicy:
- allOf:
- - $ref: '#/components/schemas/ExcessCapacityTerminationPolicy'
- - description: Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
- fulfilledCapacity:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
- onDemandFulfilledCapacity:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
- iamFleetRole:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.'
- launchSpecifications:
- allOf:
- - $ref: '#/components/schemas/LaunchSpecsList'
- - description: 'The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can''t specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.'
- launchTemplateConfigs:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateConfigList'
- - description: 'The launch template and overrides. If you specify LaunchTemplateConfigs, you can''t specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.'
- spotPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
- targetCapacity:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.'
- onDemandTargetCapacity:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.'
- onDemandMaxTotalPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The maximum amount per hour for On-Demand Instances that you''re willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.'
- spotMaxTotalPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The maximum amount per hour for Spot Instances that you''re willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.'
- terminateInstancesWithExpiration:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
- type:
- allOf:
- - $ref: '#/components/schemas/FleetType'
- - description: 'The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.'
- validFrom:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.'
- validUntil:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.'
- replaceUnhealthyInstances:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether Spot Fleet should replace unhealthy instances.
- instanceInterruptionBehavior:
- allOf:
- - $ref: '#/components/schemas/InstanceInterruptionBehavior'
- - description: The behavior when a Spot Instance is interrupted. The default is terminate.
- loadBalancersConfig:
- allOf:
- - $ref: '#/components/schemas/LoadBalancersConfig'
- - description: 'One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
' - instancePoolsToUseCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
' - context: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - targetCapacityUnitType: - allOf: - - $ref: '#/components/schemas/TargetCapacityUnitType' - - description: 'The unit for the target capacity.
Default: units (translates to number of instances)
ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.'
- description: Describes the configuration of a Spot Fleet request.
- 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'
- post:
- x-aws-operation-name: RequestSpotFleet
- operationId: POST_RequestSpotFleet
- description: 'Creates a Spot Fleet request.
The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.
You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.
Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.
You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported.
For more information, see Spot Fleet requests in the Amazon EC2 User Guide for Linux Instances.
We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.
Creates a Spot Instance request.
For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.
We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.
The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
' - schema: - type: string - - name: BlockDurationMinutes - in: query - required: false - description: Deprecated. - schema: - type: integer - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceCount
- in: query
- required: false
- description: 'The maximum number of Spot Instances to launch.
Default: 1
' - schema: - type: integer - - name: LaunchGroup - in: query - required: false - description: 'The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
' - schema: - type: string - - name: LaunchSpecification - in: query - required: false - description: The launch specification. - schema: - type: object - properties: - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupIdList' - - description: One or more security group IDs. - SecurityGroup: - allOf: - - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupList' - - description: 'One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.' - addressingType: - allOf: - - $ref: '#/components/schemas/String' - - description: Deprecated. - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/BlockDeviceMappingList' - - description: 'One or more block device mapping entries. You can''t specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.' - ebsOptimized: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Indicates whether basic or detailed monitoring is enabled for the instance.
Default: Disabled
' - NetworkInterface: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecificationList' - - description: 'One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.' - placement: - allOf: - - $ref: '#/components/schemas/SpotPlacement' - - description: The placement information for the instance. - ramdiskId: - allOf: - - $ref: '#/components/schemas/RamdiskId' - - description: The ID of the RAM disk. - subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The ID of the subnet in which to launch the instance. - userData: - allOf: - - $ref: '#/components/schemas/String' - - description: The Base64-encoded user data for the instance. User data is limited to 16 KB. - description: Describes the launch specification for an instance. - - name: SpotPrice - in: query - required: false - description: The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. - schema: - type: string - - name: Type - in: query - required: false - description: 'The Spot Instance request type.
Default: one-time
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.
' - schema: - type: string - format: date-time - - name: ValidUntil - in: query - required: false - description: 'The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags. '
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: InstanceInterruptionBehavior
- in: query
- required: false
- description: The behavior when a Spot Instance is interrupted. The default is terminate.
- schema:
- type: string
- enum:
- - hibernate
- - stop
- - terminate
- 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'
- post:
- x-aws-operation-name: RequestSpotInstances
- operationId: POST_RequestSpotInstances
- description: 'Creates a Spot Instance request.
For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.
We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ResetAddressAttribute
- operationId: POST_ResetAddressAttribute
- description: 'Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ResetAddressAttributeResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ResetAddressAttributeRequest'
- parameters: []
- /?Action=ResetEbsDefaultKmsKeyId&Version=2016-11-15:
- get:
- x-aws-operation-name: ResetEbsDefaultKmsKeyId
- operationId: GET_ResetEbsDefaultKmsKeyId
- description: 'Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.
After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetEbsDefaultKmsKeyIdResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ResetEbsDefaultKmsKeyId
- operationId: POST_ResetEbsDefaultKmsKeyId
- description: 'Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.
After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetEbsDefaultKmsKeyIdResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetEbsDefaultKmsKeyIdRequest' - parameters: [] - /?Action=ResetFpgaImageAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ResetFpgaImageAttribute - operationId: GET_ResetFpgaImageAttribute - description: Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetFpgaImageAttributeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: FpgaImageId
- in: query
- required: true
- description: The ID of the AFI.
- schema:
- type: string
- - name: Attribute
- in: query
- required: false
- description: The attribute.
- schema:
- type: string
- enum:
- - loadPermission
- 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'
- post:
- x-aws-operation-name: ResetFpgaImageAttribute
- operationId: POST_ResetFpgaImageAttribute
- description: Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ResetFpgaImageAttributeResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ResetFpgaImageAttributeRequest'
- parameters: []
- /?Action=ResetImageAttribute&Version=2016-11-15:
- get:
- x-aws-operation-name: ResetImageAttribute
- operationId: GET_ResetImageAttribute
- description: Resets an attribute of an AMI to its default value.
- responses:
- '200':
- description: Success
- parameters:
- - name: Attribute
- in: query
- required: true
- description: The attribute to reset (currently you can only reset the launch permission attribute).
- schema:
- type: string
- enum:
- - launchPermission
- - name: ImageId
- in: query
- required: true
- description: The ID of the AMI.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ResetImageAttribute
- operationId: POST_ResetImageAttribute
- description: Resets an attribute of an AMI to its default value.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ResetImageAttributeRequest'
- parameters: []
- /?Action=ResetInstanceAttribute&Version=2016-11-15:
- get:
- x-aws-operation-name: ResetInstanceAttribute
- operationId: GET_ResetInstanceAttribute
- description: 'Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.
The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide.
The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceId
- in: query
- required: true
- description: The ID of the instance.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ResetInstanceAttribute
- operationId: POST_ResetInstanceAttribute
- description: 'Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.
The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: NetworkInterfaceId
- in: query
- required: true
- description: The ID of the network interface.
- schema:
- type: string
- - name: SourceDestCheck
- in: query
- required: false
- description: The source/destination checking attribute. Resets the value to true.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: ResetNetworkInterfaceAttribute
- operationId: POST_ResetNetworkInterfaceAttribute
- description: Resets a network interface attribute. You can specify only one attribute at a time.
- responses:
- '200':
- description: Success
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ResetNetworkInterfaceAttributeRequest'
- parameters: []
- /?Action=ResetSnapshotAttribute&Version=2016-11-15:
- get:
- x-aws-operation-name: ResetSnapshotAttribute
- operationId: GET_ResetSnapshotAttribute
- description: 'Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - parameters: - - name: Attribute - in: query - required: true - description: 'The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.' - schema: - type: string - enum: - - productCodes - - createVolumePermission - - name: SnapshotId - in: query - required: true - description: The ID of the snapshot. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: ResetSnapshotAttribute
- operationId: POST_ResetSnapshotAttribute
- description: 'Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetSnapshotAttributeRequest' - parameters: [] - /?Action=RestoreAddressToClassic&Version=2016-11-15: - get: - x-aws-operation-name: RestoreAddressToClassic - operationId: GET_RestoreAddressToClassic - description: Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreAddressToClassicResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PublicIp
- in: query
- required: true
- description: The Elastic IP address.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: RestoreAddressToClassic
- operationId: POST_RestoreAddressToClassic
- description: Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RestoreAddressToClassicResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RestoreAddressToClassicRequest'
- parameters: []
- /?Action=RestoreImageFromRecycleBin&Version=2016-11-15:
- get:
- x-aws-operation-name: RestoreImageFromRecycleBin
- operationId: GET_RestoreImageFromRecycleBin
- description: 'Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RestoreImageFromRecycleBinResult'
- parameters:
- - name: ImageId
- in: query
- required: true
- description: The ID of the AMI to restore.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: RestoreImageFromRecycleBin
- operationId: POST_RestoreImageFromRecycleBin
- description: 'Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RestoreImageFromRecycleBinResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RestoreImageFromRecycleBinRequest'
- parameters: []
- /?Action=RestoreManagedPrefixListVersion&Version=2016-11-15:
- get:
- x-aws-operation-name: RestoreManagedPrefixListVersion
- operationId: GET_RestoreManagedPrefixListVersion
- description: Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RestoreManagedPrefixListVersionResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: PrefixListId
- in: query
- required: true
- description: The ID of the prefix list.
- schema:
- type: string
- - name: PreviousVersion
- in: query
- required: true
- description: The version to restore.
- schema:
- type: integer
- - name: CurrentVersion
- in: query
- required: true
- description: The current version number for the prefix list.
- schema:
- type: integer
- 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'
- post:
- x-aws-operation-name: RestoreManagedPrefixListVersion
- operationId: POST_RestoreManagedPrefixListVersion
- description: Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RestoreManagedPrefixListVersionResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RestoreManagedPrefixListVersionRequest'
- parameters: []
- /?Action=RestoreSnapshotFromRecycleBin&Version=2016-11-15:
- get:
- x-aws-operation-name: RestoreSnapshotFromRecycleBin
- operationId: GET_RestoreSnapshotFromRecycleBin
- description: 'Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RestoreSnapshotFromRecycleBinResult'
- parameters:
- - name: SnapshotId
- in: query
- required: true
- description: The ID of the snapshot to restore.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: RestoreSnapshotFromRecycleBin
- operationId: POST_RestoreSnapshotFromRecycleBin
- description: 'Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RestoreSnapshotFromRecycleBinResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RestoreSnapshotFromRecycleBinRequest'
- parameters: []
- /?Action=RestoreSnapshotTier&Version=2016-11-15:
- get:
- x-aws-operation-name: RestoreSnapshotTier
- operationId: GET_RestoreSnapshotTier
- description: 'Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.
For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreSnapshotTierResult' - parameters: - - name: SnapshotId - in: query - required: true - description: The ID of the snapshot to restore. - schema: - type: string - - name: TemporaryRestoreDays - in: query - required: false - description: 'Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore parameter or set it to false.
true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.'
- schema:
- type: boolean
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: RestoreSnapshotTier
- operationId: POST_RestoreSnapshotTier
- description: 'Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.
For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreSnapshotTierResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreSnapshotTierRequest' - parameters: [] - /?Action=RevokeClientVpnIngress&Version=2016-11-15: - get: - x-aws-operation-name: RevokeClientVpnIngress - operationId: GET_RevokeClientVpnIngress - description: 'Removes an ingress authorization rule from a Client VPN endpoint. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeClientVpnIngressResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint with which the authorization rule is associated. - schema: - type: string - - name: TargetNetworkCidr - in: query - required: true - description: 'The IPv4 address range, in CIDR notation, of the network for which access is being removed.' - schema: - type: string - - name: AccessGroupId - in: query - required: false - description: 'The ID of the Active Directory group for which to revoke access. ' - schema: - type: string - - name: RevokeAllGroups - in: query - required: false - description: Indicates whether access should be revoked for all clients. - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: RevokeClientVpnIngress
- operationId: POST_RevokeClientVpnIngress
- description: 'Removes an ingress authorization rule from a Client VPN endpoint. '
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RevokeClientVpnIngressResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/RevokeClientVpnIngressRequest'
- parameters: []
- /?Action=RevokeSecurityGroupEgress&Version=2016-11-15:
- get:
- x-aws-operation-name: RevokeSecurityGroupEgress
- operationId: GET_RevokeSecurityGroupEgress
- description: '[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule''s values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
[Default VPC] If the values you specify do not match the existing rule''s values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeSecurityGroupEgressResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: GroupId
- in: query
- required: true
- description: The ID of the security group.
- schema:
- type: string
- - name: IpPermissions
- in: query
- required: false
- description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpPermission'
- - xml:
- name: item
- - name: SecurityGroupRuleId
- in: query
- required: false
- description: The IDs of the security group rules.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- - name: CidrIp
- in: query
- required: false
- description: Not supported. Use a set of IP permissions to specify the CIDR.
- schema:
- type: string
- - name: FromPort
- in: query
- required: false
- description: Not supported. Use a set of IP permissions to specify the port.
- schema:
- type: integer
- - name: IpProtocol
- in: query
- required: false
- description: Not supported. Use a set of IP permissions to specify the protocol name or number.
- schema:
- type: string
- - name: ToPort
- in: query
- required: false
- description: Not supported. Use a set of IP permissions to specify the port.
- schema:
- type: integer
- - name: SourceSecurityGroupName
- in: query
- required: false
- description: Not supported. Use a set of IP permissions to specify a destination security group.
- schema:
- type: string
- - name: SourceSecurityGroupOwnerId
- in: query
- required: false
- description: Not supported. Use a set of IP permissions to specify a destination security group.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: RevokeSecurityGroupEgress
- operationId: POST_RevokeSecurityGroupEgress
- description: '[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule''s values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
[Default VPC] If the values you specify do not match the existing rule''s values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeSecurityGroupEgressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeSecurityGroupEgressRequest' - parameters: [] - /?Action=RevokeSecurityGroupIngress&Version=2016-11-15: - get: - x-aws-operation-name: RevokeSecurityGroupIngress - operationId: GET_RevokeSecurityGroupIngress - description: 'Removes the specified inbound (ingress) rules from a security group.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule''s values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
[EC2-Classic, default VPC] If the values you specify do not match the existing rule''s values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeSecurityGroupIngressResult' - parameters: - - name: CidrIp - in: query - required: false - description: The CIDR IP address range. You can't specify this parameter when specifying a source security group. - schema: - type: string - - name: FromPort - in: query - required: false - description: 'The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use-1 to specify all ICMP types.'
- schema:
- type: integer
- - name: GroupId
- in: query
- required: false
- description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.'
- schema:
- type: string
- - name: GroupName
- in: query
- required: false
- description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.'
- schema:
- type: string
- - name: IpPermissions
- in: query
- required: false
- description: The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpPermission'
- - xml:
- name: item
- - name: IpProtocol
- in: query
- required: false
- description: 'The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.'
- schema:
- type: string
- - name: SourceSecurityGroupName
- in: query
- required: false
- description: '[EC2-Classic, default VPC] The name of the source security group. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.'
- schema:
- type: string
- - name: SourceSecurityGroupOwnerId
- in: query
- required: false
- description: '[EC2-Classic] The Amazon Web Services account ID of the source security group, if the source security group is in a different account. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.'
- schema:
- type: string
- - name: ToPort
- in: query
- required: false
- description: 'The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.'
- schema:
- type: integer
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: SecurityGroupRuleId
- in: query
- required: false
- description: The IDs of the security group rules.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: RevokeSecurityGroupIngress
- operationId: POST_RevokeSecurityGroupIngress
- description: 'Removes the specified inbound (ingress) rules from a security group.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule''s values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
[EC2-Classic, default VPC] If the values you specify do not match the existing rule''s values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeSecurityGroupIngressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeSecurityGroupIngressRequest' - parameters: [] - /?Action=RunInstances&Version=2016-11-15: - get: - x-aws-operation-name: RunInstances - operationId: GET_RunInstances - description: 'Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
[EC2-VPC] If you don''t specify a subnet ID, we choose a default subnet from your default VPC for you. If you don''t have a default VPC, you must specify a subnet ID in the request.
[EC2-Classic] If don''t specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC.
[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don''t specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance types.
If you don''t specify a security group ID, we use the default security group. For more information, see Security groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it''s in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.
For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/Reservation' - parameters: - - name: BlockDeviceMapping - in: query - required: false - description: 'The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/BlockDeviceMapping' - - xml: - name: BlockDeviceMapping - - name: ImageId - in: query - required: false - description: The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template. - schema: - type: string - - name: InstanceType - in: query - required: false - description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
Default: m1.small
[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you''ve specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
' - schema: - type: integer - - name: Ipv6Address - in: query - required: false - description: '[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you''ve specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceIpv6Address' - - xml: - name: item - - name: KernelId - in: query - required: false - description: 'The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can''t connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.
Constraints: Between 1 and the maximum number you''re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.
' - schema: - type: integer - - name: MinCount - in: query - required: true - description: 'The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you''re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
' - schema: - type: integer - - name: Monitoring - in: query - required: false - description: Specifies whether detailed monitoring is enabled for the instance. - schema: - type: object - required: - - Enabled - properties: - enabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.' - description: Describes the monitoring of an instance. - - name: Placement - in: query - required: false - description: The placement for the instance. - schema: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet.
' - affinity: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
' - groupName: - allOf: - - $ref: '#/components/schemas/PlacementGroupName' - - description: The name of the placement group the instance is in. - partitionNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.
This parameter is not supported by CreateFleet.
' - hostId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
' - tenancy: - allOf: - - $ref: '#/components/schemas/Tenancy' - - description: 'The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
T3 instances that use the unlimited CPU credit option do not support host tenancy.
Reserved for future use.
This parameter is not supported by CreateFleet.
' - hostResourceGroupArn: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
This parameter is not supported by CreateFleet.
' - description: Describes the placement of an instance. - - name: RamdiskId - in: query - required: false - description: 'The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: SecurityGroupId - - name: SecurityGroup - in: query - required: false - description: '[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupName' - - xml: - name: SecurityGroup - - name: SubnetId - in: query - required: false - description: '[EC2-VPC] The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
' - schema: - type: string - - name: UserData - in: query - required: false - description: 'The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.' - schema: - type: string - format: password - - name: AdditionalInfo - in: query - required: false - description: Reserved. - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
' - schema: - type: string - - name: DisableApiTermination - in: query - required: false - description: 'If you set this parameter to true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: EbsOptimized
- in: query
- required: false
- description: 'Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can''t specify this option if you''ve specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you''re launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
' - schema: - type: string - - name: ElasticGpuSpecification - in: query - required: false - description: 'An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecification' - - xml: - name: item - - name: ElasticInferenceAccelerator - in: query - required: false - description:An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticInferenceAccelerator' - - xml: - name: item - - name: TagSpecification - in: query - required: false - description: 'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: LaunchTemplate - in: query - required: false - description: 'The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The version number of the launch template.
Default: The default version for the launch template.
' - description: 'The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.' - - name: InstanceMarketOptions - in: query - required: false - description: 'The market (purchasing) option for the instances.
For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.
The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.
Default: standard (T2 instances) or unlimited (T3/T3a instances)
For T3 instances with host tenancy, only standard is supported.
standard and unlimited.'
- description: 'The credit option for CPU usage of a T2, T3, or T3a instance.'
- - name: CpuOptions
- in: query
- required: false
- description: 'The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.'
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.'
- description: The CPU options for the instance. Both the core count and threads per core must be specified in the request.
- - name: CapacityReservationSpecification
- in: query
- required: false
- description: 'Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationTarget'
- - description: Information about the target Capacity Reservation or Capacity Reservation group.
- description: 'Describes an instance''s Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.
Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
You can''t enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If you set this parameter to true, your instance is enabled for hibernation.
Default: false
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
You can''t enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter totrue.'
- description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.'
- - name: PrivateDnsNameOptions
- in: query
- required: false
- description: The options for the instance hostname. The default values are inherited from the subnet.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
- description: Describes the options for instance hostnames.
- - name: MaintenanceOptions
- in: query
- required: false
- description: The maintenance and recovery options for the instance.
- schema:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/InstanceAutoRecoveryState'
- - description: 'Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.'
- description: The maintenance options for the instance.
- 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'
- post:
- x-aws-operation-name: RunInstances
- operationId: POST_RunInstances
- description: 'Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
[EC2-VPC] If you don''t specify a subnet ID, we choose a default subnet from your default VPC for you. If you don''t have a default VPC, you must specify a subnet ID in the request.
[EC2-Classic] If don''t specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC.
[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don''t specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance types.
If you don''t specify a security group ID, we use the default security group. For more information, see Security groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it''s in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.
For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/Reservation' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RunInstancesRequest' - parameters: [] - /?Action=RunScheduledInstances&Version=2016-11-15: - get: - x-aws-operation-name: RunScheduledInstances - operationId: GET_RunScheduledInstances - description: 'Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can''t stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RunScheduledInstancesResult' - parameters: - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: InstanceCount
- in: query
- required: false
- description: 'The number of instances.
Default: 1
' - schema: - type: integer - - name: LaunchSpecification - in: query - required: true - description: 'The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.' - schema: - type: object - required: - - ImageId - properties: - BlockDeviceMapping: - allOf: - - $ref: '#/components/schemas/ScheduledInstancesMonitoring' - - description: Enable or disable monitoring for the instances. - NetworkInterface: - allOf: - - $ref: '#/components/schemas/RamdiskId' - - description: The ID of the RAM disk. - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The base64-encoded MIME user data. - description: 'Describes the launch specification for a Scheduled Instance.
If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.
Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can''t stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RunScheduledInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RunScheduledInstancesRequest' - parameters: [] - /?Action=SearchLocalGatewayRoutes&Version=2016-11-15: - get: - x-aws-operation-name: SearchLocalGatewayRoutes - operationId: GET_SearchLocalGatewayRoutes - description: Searches for routes in the specified local gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/SearchLocalGatewayRoutesResult' - parameters: - - name: LocalGatewayRouteTableId - in: query - required: true - description: The ID of the local gateway route table. - schema: - type: string - - name: Filter - in: query - required: false - description: 'One or more filters.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route.
type - The route type.
nextToken value.'
- schema:
- type: integer
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: SearchLocalGatewayRoutes
- operationId: POST_SearchLocalGatewayRoutes
- description: Searches for routes in the specified local gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/SearchLocalGatewayRoutesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/SearchLocalGatewayRoutesRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=SearchTransitGatewayMulticastGroups&Version=2016-11-15:
- get:
- x-aws-operation-name: SearchTransitGatewayMulticastGroups
- operationId: GET_SearchTransitGatewayMulticastGroups
- description: Searches one or more transit gateway multicast groups and returns the group membership information.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/SearchTransitGatewayMulticastGroupsResult'
- parameters:
- - name: TransitGatewayMulticastDomainId
- in: query
- required: false
- description: The ID of the transit gateway multicast domain.
- schema:
- type: string
- - name: Filter
- in: query
- required: false
- description: 'One or more filters. The possible values are:
group-ip-address - The IP address of the transit gateway multicast group.
is-group-member - The resource is a group member. Valid values are true | false.
is-group-source - The resource is a group source. Valid values are true | false.
member-type - The member type. Valid values are igmp | static.
resource-id - The ID of the resource.
resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.
source-type - The source type. Valid values are igmp | static.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
nextToken value.'
- schema:
- type: integer
- minimum: 5
- maximum: 1000
- - name: NextToken
- in: query
- required: false
- description: The token for the next page of results.
- schema:
- type: string
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: SearchTransitGatewayMulticastGroups
- operationId: POST_SearchTransitGatewayMulticastGroups
- description: Searches one or more transit gateway multicast groups and returns the group membership information.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/SearchTransitGatewayMulticastGroupsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/SearchTransitGatewayMulticastGroupsRequest'
- parameters:
- - name: MaxResults
- in: query
- schema:
- type: string
- description: Pagination limit
- required: false
- - name: NextToken
- in: query
- schema:
- type: string
- description: Pagination token
- required: false
- /?Action=SearchTransitGatewayRoutes&Version=2016-11-15:
- get:
- x-aws-operation-name: SearchTransitGatewayRoutes
- operationId: GET_SearchTransitGatewayRoutes
- description: Searches for routes in the specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/SearchTransitGatewayRoutesResult'
- parameters:
- - name: TransitGatewayRouteTableId
- in: query
- required: true
- description: The ID of the transit gateway route table.
- schema:
- type: string
- - name: Filter
- in: query
- required: true
- description: 'One or more filters. The possible values are:
attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
type - The type of route (propagated | static).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: SearchTransitGatewayRoutes
- operationId: POST_SearchTransitGatewayRoutes
- description: Searches for routes in the specified transit gateway route table.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/SearchTransitGatewayRoutesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/SearchTransitGatewayRoutesRequest'
- parameters: []
- /?Action=SendDiagnosticInterrupt&Version=2016-11-15:
- get:
- x-aws-operation-name: SendDiagnosticInterrupt
- operationId: GET_SendDiagnosticInterrupt
- description: 'Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).
In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.
Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.
For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) (Linux instances) or Send a diagnostic interrupt (for advanced users) (Windows instances).
' - responses: - '200': - description: Success - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: SendDiagnosticInterrupt
- operationId: POST_SendDiagnosticInterrupt
- description: 'Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).
In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.
Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.
For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) (Linux instances) or Send a diagnostic interrupt (for advanced users) (Windows instances).
' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/SendDiagnosticInterruptRequest' - parameters: [] - /?Action=StartInstances&Version=2016-11-15: - get: - x-aws-operation-name: StartInstances - operationId: GET_StartInstances - description: 'Starts an Amazon EBS-backed instance that you''ve previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
If you attempt to start a T3 instance with host tenancy and the unlimted CPU credit option, the request fails. The unlimited CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to standard, or change its tenancy to default or dedicated.
For more information, see Stop and start your instance in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartInstancesResult' - parameters: - - name: InstanceId - in: query - required: true - description: The IDs of the instances. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: AdditionalInfo - in: query - required: false - description: Reserved. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: StartInstances
- operationId: POST_StartInstances
- description: 'Starts an Amazon EBS-backed instance that you''ve previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
If you attempt to start a T3 instance with host tenancy and the unlimted CPU credit option, the request fails. The unlimited CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to standard, or change its tenancy to default or dedicated.
For more information, see Stop and start your instance in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/StartInstancesRequest' - parameters: [] - /?Action=StartNetworkInsightsAccessScopeAnalysis&Version=2016-11-15: - get: - x-aws-operation-name: StartNetworkInsightsAccessScopeAnalysis - operationId: GET_StartNetworkInsightsAccessScopeAnalysis - description: Starts analyzing the specified Network Access Scope. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartNetworkInsightsAccessScopeAnalysisResult' - parameters: - - name: NetworkInsightsAccessScopeId - in: query - required: true - description: The ID of the Network Access Scope. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: ClientToken
- in: query
- required: true
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: StartNetworkInsightsAccessScopeAnalysis
- operationId: POST_StartNetworkInsightsAccessScopeAnalysis
- description: Starts analyzing the specified Network Access Scope.
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/StartNetworkInsightsAccessScopeAnalysisResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/StartNetworkInsightsAccessScopeAnalysisRequest'
- parameters: []
- /?Action=StartNetworkInsightsAnalysis&Version=2016-11-15:
- get:
- x-aws-operation-name: StartNetworkInsightsAnalysis
- operationId: GET_StartNetworkInsightsAnalysis
- description: 'Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/StartNetworkInsightsAnalysisResult'
- parameters:
- - name: NetworkInsightsPathId
- in: query
- required: true
- description: The ID of the path.
- schema:
- type: string
- - name: FilterInArn
- in: query
- required: false
- description: The Amazon Resource Names (ARN) of the resources that the path must traverse.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - xml:
- name: item
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: TagSpecification
- in: query
- required: false
- description: The tags to apply.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- - name: ClientToken
- in: query
- required: true
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: StartNetworkInsightsAnalysis
- operationId: POST_StartNetworkInsightsAnalysis
- description: 'Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/StartNetworkInsightsAnalysisResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/StartNetworkInsightsAnalysisRequest'
- parameters: []
- /?Action=StartVpcEndpointServicePrivateDnsVerification&Version=2016-11-15:
- get:
- x-aws-operation-name: StartVpcEndpointServicePrivateDnsVerification
- operationId: GET_StartVpcEndpointServicePrivateDnsVerification
- description: 'Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.
The service provider must successfully perform the verification before the consumer can use the name to access the service.
Before the service provider runs this command, they must add a record to the DNS server.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartVpcEndpointServicePrivateDnsVerificationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: ServiceId
- in: query
- required: true
- description: The ID of the endpoint service.
- schema:
- type: string
- 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'
- post:
- x-aws-operation-name: StartVpcEndpointServicePrivateDnsVerification
- operationId: POST_StartVpcEndpointServicePrivateDnsVerification
- description: 'Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.
The service provider must successfully perform the verification before the consumer can use the name to access the service.
Before the service provider runs this command, they must add a record to the DNS server.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartVpcEndpointServicePrivateDnsVerificationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/StartVpcEndpointServicePrivateDnsVerificationRequest' - parameters: [] - /?Action=StopInstances&Version=2016-11-15: - get: - x-aws-operation-name: StopInstances - operationId: GET_StopInstances - description: 'Stops an Amazon EBS-backed instance. For more information, see Stop and start your instance in the Amazon EC2 User Guide.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
We don''t charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can''t stop or hibernate instance store-backed instances. You can''t use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StopInstancesResult' - parameters: - - name: InstanceId - in: query - required: true - description: The IDs of the instances. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: Hibernate - in: query - required: false - description: 'Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: Force
- in: query
- required: false
- description: 'Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
Stops an Amazon EBS-backed instance. For more information, see Stop and start your instance in the Amazon EC2 User Guide.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
We don''t charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can''t stop or hibernate instance store-backed instances. You can''t use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StopInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/StopInstancesRequest' - parameters: [] - /?Action=TerminateClientVpnConnections&Version=2016-11-15: - get: - x-aws-operation-name: TerminateClientVpnConnections - operationId: GET_TerminateClientVpnConnections - description: 'Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/TerminateClientVpnConnectionsResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint to which the client is connected. - schema: - type: string - - name: ConnectionId - in: query - required: false - description: The ID of the client connection to be terminated. - schema: - type: string - - name: Username - in: query - required: false - description: The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: TerminateClientVpnConnections
- operationId: POST_TerminateClientVpnConnections
- description: 'Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/TerminateClientVpnConnectionsResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/TerminateClientVpnConnectionsRequest'
- parameters: []
- /?Action=TerminateInstances&Version=2016-11-15:
- get:
- x-aws-operation-name: TerminateInstances
- operationId: GET_TerminateInstances
- description: 'Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.
For example, say you have the following instances:
Instance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection.
Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/TerminateInstancesResult' - parameters: - - name: InstanceId - in: query - required: true - description: 'The IDs of the instances.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: TerminateInstances
- operationId: POST_TerminateInstances
- description: 'Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.
For example, say you have the following instances:
Instance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection.
Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/TerminateInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TerminateInstancesRequest' - parameters: [] - /?Action=UnassignIpv6Addresses&Version=2016-11-15: - get: - x-aws-operation-name: UnassignIpv6Addresses - operationId: GET_UnassignIpv6Addresses - description: Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UnassignIpv6AddressesResult' - parameters: - - name: Ipv6Addresses - in: query - required: false - description: The IPv6 addresses to unassign from the network interface. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: Ipv6Prefix - in: query - required: false - description: One or more IPv6 prefixes to unassign from the network interface. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - 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' - post: - x-aws-operation-name: UnassignIpv6Addresses - operationId: POST_UnassignIpv6Addresses - description: Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UnassignIpv6AddressesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UnassignIpv6AddressesRequest' - parameters: [] - /?Action=UnassignPrivateIpAddresses&Version=2016-11-15: - get: - x-aws-operation-name: UnassignPrivateIpAddresses - operationId: GET_UnassignPrivateIpAddresses - description: 'Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.' - responses: - '200': - description: Success - parameters: - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - - name: PrivateIpAddress - in: query - required: false - description: The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: PrivateIpAddress - - name: Ipv4Prefix - in: query - required: false - description: The IPv4 prefixes to unassign from the network interface. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - 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' - post: - x-aws-operation-name: UnassignPrivateIpAddresses - operationId: POST_UnassignPrivateIpAddresses - description: 'Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UnassignPrivateIpAddressesRequest' - parameters: [] - /?Action=UnmonitorInstances&Version=2016-11-15: - get: - x-aws-operation-name: UnmonitorInstances - operationId: GET_UnmonitorInstances - description: 'Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmonitorInstancesResult' - parameters: - - name: InstanceId - in: query - required: true - description: The IDs of the instances. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: UnmonitorInstances
- operationId: POST_UnmonitorInstances
- description: 'Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/UnmonitorInstancesResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/UnmonitorInstancesRequest'
- parameters: []
- /?Action=UpdateSecurityGroupRuleDescriptionsEgress&Version=2016-11-15:
- get:
- x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsEgress
- operationId: GET_UpdateSecurityGroupRuleDescriptionsEgress
- description: '[VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: GroupId
- in: query
- required: false
- description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.'
- schema:
- type: string
- - name: GroupName
- in: query
- required: false
- description: '[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.'
- schema:
- type: string
- - name: IpPermissions
- in: query
- required: false
- description: The IP permissions for the security group rule. You must specify either the IP permissions or the description.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpPermission'
- - xml:
- name: item
- - name: SecurityGroupRuleDescription
- in: query
- required: false
- description: The description for the egress security group rules. You must specify either the description or the IP permissions.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRuleDescription'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsEgress
- operationId: POST_UpdateSecurityGroupRuleDescriptionsEgress
- description: '[VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressRequest'
- parameters: []
- /?Action=UpdateSecurityGroupRuleDescriptionsIngress&Version=2016-11-15:
- get:
- x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsIngress
- operationId: GET_UpdateSecurityGroupRuleDescriptionsIngress
- description: 'Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressResult'
- parameters:
- - name: DryRun
- in: query
- required: false
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- - name: GroupId
- in: query
- required: false
- description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.'
- schema:
- type: string
- - name: GroupName
- in: query
- required: false
- description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.'
- schema:
- type: string
- - name: IpPermissions
- in: query
- required: false
- description: The IP permissions for the security group rule. You must specify either IP permissions or a description.
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpPermission'
- - xml:
- name: item
- - name: SecurityGroupRuleDescription
- in: query
- required: false
- description: '[VPC only] The description for the ingress security group rules. You must specify either a description or IP permissions.'
- schema:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRuleDescription'
- - xml:
- name: item
- 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'
- post:
- x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsIngress
- operationId: POST_UpdateSecurityGroupRuleDescriptionsIngress
- description: 'Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.'
- responses:
- '200':
- description: Success
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressResult'
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressRequest'
- parameters: []
- /?Action=WithdrawByoipCidr&Version=2016-11-15:
- get:
- x-aws-operation-name: WithdrawByoipCidr
- operationId: GET_WithdrawByoipCidr
- description: 'Stops advertising an address range that is provisioned as an address pool.
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/WithdrawByoipCidrResult' - parameters: - - name: Cidr - in: query - required: true - description: 'The address range, in CIDR notation.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- schema:
- type: boolean
- 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'
- post:
- x-aws-operation-name: WithdrawByoipCidr
- operationId: POST_WithdrawByoipCidr
- description: 'Stops advertising an address range that is provisioned as an address pool.
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.
' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/WithdrawByoipCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/WithdrawByoipCidrRequest' - parameters: [] -components: - x-stackQL-resources: - account_attributes: - name: account_attributes - methods: - account_attributes_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeAccountAttributes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/accountAttributeSet/item - openAPIDocKey: '200' - id: aws.ec2.account_attributes - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/account_attributes/methods/account_attributes_Describe' - update: [] - title: account_attributes - address: - name: address - methods: - address_Allocate: - operation: - $ref: '#/paths/~1?Action=AllocateAddress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - address_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateAddress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - address_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateAddress&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - address_Release: - operation: - $ref: '#/paths/~1?Action=ReleaseAddress&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.address - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: address - address_attribute: - name: address_attribute - methods: - address_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyAddressAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - address_attribute_Reset: - operation: - $ref: '#/paths/~1?Action=ResetAddressAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.address_attribute - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: address_attribute - address_to_classic: - name: address_to_classic - methods: - address_to_classic_Restore: - operation: - $ref: '#/paths/~1?Action=RestoreAddressToClassic&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.address_to_classic - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: address_to_classic - address_to_vpc: - name: address_to_vpc - methods: - address_to_vpc_Move: - operation: - $ref: '#/paths/~1?Action=MoveAddressToVpc&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.address_to_vpc - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: address_to_vpc - addresses: - name: addresses - methods: - addresses_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeAddresses&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/addressesSet/item - openAPIDocKey: '200' - id: aws.ec2.addresses - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/addresses/methods/addresses_Describe' - update: [] - title: addresses - addresses_attribute: - name: addresses_attribute - methods: - addresses_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeAddressesAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/addressSet/item - openAPIDocKey: '200' - id: aws.ec2.addresses_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/addresses_attribute/methods/addresses_attribute_Describe' - update: [] - title: addresses_attribute - aggregate_id_format: - name: aggregate_id_format - methods: - aggregate_id_format_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeAggregateIdFormat&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/statusSet/item - openAPIDocKey: '200' - id: aws.ec2.aggregate_id_format - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/aggregate_id_format/methods/aggregate_id_format_Describe' - update: [] - title: aggregate_id_format - associated_enclave_certificate_iam_roles: - name: associated_enclave_certificate_iam_roles - methods: - associated_enclave_certificate_iam_roles_Get: - operation: - $ref: '#/paths/~1?Action=GetAssociatedEnclaveCertificateIamRoles&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/associatedRoleSet/item - openAPIDocKey: '200' - id: aws.ec2.associated_enclave_certificate_iam_roles - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/associated_enclave_certificate_iam_roles/methods/associated_enclave_certificate_iam_roles_Get' - update: [] - title: associated_enclave_certificate_iam_roles - associated_ipv6_pool_cidrs: - name: associated_ipv6_pool_cidrs - methods: - associated_ipv6_pool_cidrs_Get: - operation: - $ref: '#/paths/~1?Action=GetAssociatedIpv6PoolCidrs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipv6CidrAssociationSet/item - openAPIDocKey: '200' - id: aws.ec2.associated_ipv6_pool_cidrs - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/associated_ipv6_pool_cidrs/methods/associated_ipv6_pool_cidrs_Get' - update: [] - title: associated_ipv6_pool_cidrs - availability_zone_group: - name: availability_zone_group - methods: - availability_zone_group_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyAvailabilityZoneGroup&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.availability_zone_group - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: availability_zone_group - availability_zones: - name: availability_zones - methods: - availability_zones_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeAvailabilityZones&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/availabilityZoneInfo/item - openAPIDocKey: '200' - id: aws.ec2.availability_zones - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/availability_zones/methods/availability_zones_Describe' - update: [] - title: availability_zones - bundle_tasks: - name: bundle_tasks - methods: - bundle_task_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelBundleTask&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - bundle_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeBundleTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/bundleInstanceTasksSet/item - openAPIDocKey: '200' - id: aws.ec2.bundle_tasks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bundle_tasks/methods/bundle_tasks_Describe' - update: [] - title: bundle_tasks - byoip_cidr_to_ipam: - name: byoip_cidr_to_ipam - methods: - byoip_cidr_to_ipam_Move: - operation: - $ref: '#/paths/~1?Action=MoveByoipCidrToIpam&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.byoip_cidr_to_ipam - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: byoip_cidr_to_ipam - byoip_cidrs: - name: byoip_cidrs - methods: - byoip_cidr_Advertise: - operation: - $ref: '#/paths/~1?Action=AdvertiseByoipCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - byoip_cidr_Deprovision: - operation: - $ref: '#/paths/~1?Action=DeprovisionByoipCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - byoip_cidr_Provision: - operation: - $ref: '#/paths/~1?Action=ProvisionByoipCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - byoip_cidr_Withdraw: - operation: - $ref: '#/paths/~1?Action=WithdrawByoipCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - byoip_cidrs_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeByoipCidrs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/byoipCidrSet/item - openAPIDocKey: '200' - id: aws.ec2.byoip_cidrs - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/byoip_cidrs/methods/byoip_cidrs_Describe' - update: [] - title: byoip_cidrs - capacity_reservation_fleets: - name: capacity_reservation_fleets - methods: - capacity_reservation_fleet_Create: - operation: - $ref: '#/paths/~1?Action=CreateCapacityReservationFleet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - capacity_reservation_fleet_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyCapacityReservationFleet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - capacity_reservation_fleets_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelCapacityReservationFleets&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - capacity_reservation_fleets_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeCapacityReservationFleets&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/capacityReservationFleetSet/item - openAPIDocKey: '200' - id: aws.ec2.capacity_reservation_fleets - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/capacity_reservation_fleets_Describe' - update: [] - title: capacity_reservation_fleets - capacity_reservation_usage: - name: capacity_reservation_usage - methods: - capacity_reservation_usage_Get: - operation: - $ref: '#/paths/~1?Action=GetCapacityReservationUsage&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.capacity_reservation_usage - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/capacity_reservation_usage/methods/capacity_reservation_usage_Get' - update: [] - title: capacity_reservation_usage - capacity_reservations: - name: capacity_reservations - methods: - capacity_reservation_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelCapacityReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - capacity_reservation_Create: - operation: - $ref: '#/paths/~1?Action=CreateCapacityReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - capacity_reservation_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyCapacityReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - capacity_reservations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeCapacityReservations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/capacityReservationSet/item - openAPIDocKey: '200' - id: aws.ec2.capacity_reservations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/capacity_reservations_Describe' - update: [] - title: capacity_reservations - carrier_gateways: - name: carrier_gateways - methods: - carrier_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateCarrierGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - carrier_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteCarrierGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - carrier_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeCarrierGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/carrierGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2.carrier_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/carrier_gateway_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/carrier_gateways_Describe' - update: [] - title: carrier_gateways - classic_link_instances: - name: classic_link_instances - methods: - classic_link_instances_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeClassicLinkInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instancesSet/item - openAPIDocKey: '200' - id: aws.ec2.classic_link_instances - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/classic_link_instances/methods/classic_link_instances_Describe' - update: [] - title: classic_link_instances - classic_link_vpc: - name: classic_link_vpc - methods: - classic_link_vpc_Attach: - operation: - $ref: '#/paths/~1?Action=AttachClassicLinkVpc&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - classic_link_vpc_Detach: - operation: - $ref: '#/paths/~1?Action=DetachClassicLinkVpc&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.classic_link_vpc - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: classic_link_vpc - client_vpn_authorization_rules: - name: client_vpn_authorization_rules - methods: - client_vpn_authorization_rules_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeClientVpnAuthorizationRules&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/authorizationRule/item - openAPIDocKey: '200' - id: aws.ec2.client_vpn_authorization_rules - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/client_vpn_authorization_rules/methods/client_vpn_authorization_rules_Describe' - update: [] - title: client_vpn_authorization_rules - client_vpn_client_certificate_revocation_list: - name: client_vpn_client_certificate_revocation_list - methods: - client_vpn_client_certificate_revocation_list_Export: - operation: - $ref: '#/paths/~1?Action=ExportClientVpnClientCertificateRevocationList&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_client_certificate_revocation_list_Import: - operation: - $ref: '#/paths/~1?Action=ImportClientVpnClientCertificateRevocationList&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.client_vpn_client_certificate_revocation_list - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: client_vpn_client_certificate_revocation_list - client_vpn_client_configuration: - name: client_vpn_client_configuration - methods: - client_vpn_client_configuration_Export: - operation: - $ref: '#/paths/~1?Action=ExportClientVpnClientConfiguration&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.client_vpn_client_configuration - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: client_vpn_client_configuration - client_vpn_connections: - name: client_vpn_connections - methods: - client_vpn_connections_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeClientVpnConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/connections/item - openAPIDocKey: '200' - client_vpn_connections_Terminate: - operation: - $ref: '#/paths/~1?Action=TerminateClientVpnConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.client_vpn_connections - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/client_vpn_connections/methods/client_vpn_connections_Describe' - update: [] - title: client_vpn_connections - client_vpn_endpoints: - name: client_vpn_endpoints - methods: - client_vpn_endpoint_Create: - operation: - $ref: '#/paths/~1?Action=CreateClientVpnEndpoint&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_endpoint_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteClientVpnEndpoint&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_endpoint_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyClientVpnEndpoint&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_endpoints_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeClientVpnEndpoints&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/clientVpnEndpoint/item - openAPIDocKey: '200' - id: aws.ec2.client_vpn_endpoints - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/client_vpn_endpoints/methods/client_vpn_endpoint_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/client_vpn_endpoints/methods/client_vpn_endpoint_Create' - select: - - $ref: '#/components/x-stackQL-resources/client_vpn_endpoints/methods/client_vpn_endpoints_Describe' - update: [] - title: client_vpn_endpoints - client_vpn_ingress: - name: client_vpn_ingress - methods: - client_vpn_ingress_Authorize: - operation: - $ref: '#/paths/~1?Action=AuthorizeClientVpnIngress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_ingress_Revoke: - operation: - $ref: '#/paths/~1?Action=RevokeClientVpnIngress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.client_vpn_ingress - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: client_vpn_ingress - client_vpn_routes: - name: client_vpn_routes - methods: - client_vpn_route_Create: - operation: - $ref: '#/paths/~1?Action=CreateClientVpnRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_route_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteClientVpnRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_routes_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeClientVpnRoutes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/routes/item - openAPIDocKey: '200' - id: aws.ec2.client_vpn_routes - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/client_vpn_routes/methods/client_vpn_route_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/client_vpn_routes/methods/client_vpn_route_Create' - select: - - $ref: '#/components/x-stackQL-resources/client_vpn_routes/methods/client_vpn_routes_Describe' - update: [] - title: client_vpn_routes - client_vpn_target_networks: - name: client_vpn_target_networks - methods: - client_vpn_target_network_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateClientVpnTargetNetwork&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_target_network_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateClientVpnTargetNetwork&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_target_networks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeClientVpnTargetNetworks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/clientVpnTargetNetworks/item - openAPIDocKey: '200' - id: aws.ec2.client_vpn_target_networks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/client_vpn_target_networks/methods/client_vpn_target_networks_Describe' - update: [] - title: client_vpn_target_networks - coip_pool_usage: - name: coip_pool_usage - methods: - coip_pool_usage_Get: - operation: - $ref: '#/paths/~1?Action=GetCoipPoolUsage&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/coipAddressUsageSet/item - openAPIDocKey: '200' - id: aws.ec2.coip_pool_usage - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/coip_pool_usage/methods/coip_pool_usage_Get' - update: [] - title: coip_pool_usage - coip_pools: - name: coip_pools - methods: - coip_pools_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeCoipPools&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/coipPoolSet/item - openAPIDocKey: '200' - id: aws.ec2.coip_pools - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/coip_pools/methods/coip_pools_Describe' - update: [] - title: coip_pools - console_output: - name: console_output - methods: - console_output_Get: - operation: - $ref: '#/paths/~1?Action=GetConsoleOutput&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.console_output - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/console_output/methods/console_output_Get' - update: [] - title: console_output - console_screenshot: - name: console_screenshot - methods: - console_screenshot_Get: - operation: - $ref: '#/paths/~1?Action=GetConsoleScreenshot&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.console_screenshot - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/console_screenshot/methods/console_screenshot_Get' - update: [] - title: console_screenshot - conversion_tasks: - name: conversion_tasks - methods: - conversion_task_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelConversionTask&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - conversion_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeConversionTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/conversionTasks/item - openAPIDocKey: '200' - id: aws.ec2.conversion_tasks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/conversion_tasks/methods/conversion_tasks_Describe' - update: [] - title: conversion_tasks - customer_gateways: - name: customer_gateways - methods: - customer_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateCustomerGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - customer_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteCustomerGateway&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - customer_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeCustomerGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/customerGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2.customer_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/customer_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/customer_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/customer_gateways_Describe' - update: [] - title: customer_gateways - default_credit_specification: - name: default_credit_specification - methods: - default_credit_specification_Get: - operation: - $ref: '#/paths/~1?Action=GetDefaultCreditSpecification&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceFamilyCreditSpecification - openAPIDocKey: '200' - default_credit_specification_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyDefaultCreditSpecification&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.default_credit_specification - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/default_credit_specification/methods/default_credit_specification_Get' - update: [] - title: default_credit_specification - default_subnet: - name: default_subnet - methods: - default_subnet_Create: - operation: - $ref: '#/paths/~1?Action=CreateDefaultSubnet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.default_subnet - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/default_subnet/methods/default_subnet_Create' - select: [] - update: [] - title: default_subnet - default_vpc: - name: default_vpc - methods: - default_vpc_Create: - operation: - $ref: '#/paths/~1?Action=CreateDefaultVpc&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.default_vpc - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/default_vpc/methods/default_vpc_Create' - select: [] - update: [] - title: default_vpc - dhcp_options: - name: dhcp_options - methods: - dhcp_options_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateDhcpOptions&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - dhcp_options_Create: - operation: - $ref: '#/paths/~1?Action=CreateDhcpOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - dhcp_options_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteDhcpOptions&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - dhcp_options_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeDhcpOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/dhcpOptionsSet/item - openAPIDocKey: '200' - id: aws.ec2.dhcp_options - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/dhcp_options_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/dhcp_options_Create' - select: - - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/dhcp_options_Describe' - update: [] - title: dhcp_options - diagnostic_interrupt: - name: diagnostic_interrupt - methods: - diagnostic_interrupt_Send: - operation: - $ref: '#/paths/~1?Action=SendDiagnosticInterrupt&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.diagnostic_interrupt - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: diagnostic_interrupt - ebs_default_kms_key_id: - name: ebs_default_kms_key_id - methods: - ebs_default_kms_key_id_Get: - operation: - $ref: '#/paths/~1?Action=GetEbsDefaultKmsKeyId&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - ebs_default_kms_key_id_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyEbsDefaultKmsKeyId&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ebs_default_kms_key_id_Reset: - operation: - $ref: '#/paths/~1?Action=ResetEbsDefaultKmsKeyId&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.ebs_default_kms_key_id - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ebs_default_kms_key_id/methods/ebs_default_kms_key_id_Get' - update: [] - title: ebs_default_kms_key_id - ebs_encryption_by_default: - name: ebs_encryption_by_default - methods: - ebs_encryption_by_default_Disable: - operation: - $ref: '#/paths/~1?Action=DisableEbsEncryptionByDefault&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ebs_encryption_by_default_Enable: - operation: - $ref: '#/paths/~1?Action=EnableEbsEncryptionByDefault&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ebs_encryption_by_default_Get: - operation: - $ref: '#/paths/~1?Action=GetEbsEncryptionByDefault&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.ebs_encryption_by_default - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ebs_encryption_by_default/methods/ebs_encryption_by_default_Get' - update: [] - title: ebs_encryption_by_default - egress_only_internet_gateways: - name: egress_only_internet_gateways - methods: - egress_only_internet_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateEgressOnlyInternetGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - egress_only_internet_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteEgressOnlyInternetGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - egress_only_internet_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeEgressOnlyInternetGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/egressOnlyInternetGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2.egress_only_internet_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/egress_only_internet_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/egress_only_internet_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/egress_only_internet_gateways_Describe' - update: [] - title: egress_only_internet_gateways - elastic_gpus: - name: elastic_gpus - methods: - elastic_gpus_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeElasticGpus&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/elasticGpuSet/item - openAPIDocKey: '200' - id: aws.ec2.elastic_gpus - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/elastic_gpus/methods/elastic_gpus_Describe' - update: [] - title: elastic_gpus - enclave_certificate_iam_role: - name: enclave_certificate_iam_role - methods: - enclave_certificate_iam_role_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateEnclaveCertificateIamRole&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - enclave_certificate_iam_role_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateEnclaveCertificateIamRole&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.enclave_certificate_iam_role - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: enclave_certificate_iam_role - export_image_tasks: - name: export_image_tasks - methods: - export_image_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeExportImageTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/exportImageTaskSet/item - openAPIDocKey: '200' - id: aws.ec2.export_image_tasks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/export_image_tasks/methods/export_image_tasks_Describe' - update: [] - title: export_image_tasks - export_tasks: - name: export_tasks - methods: - export_task_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelExportTask&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - export_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeExportTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/exportTaskSet/item - openAPIDocKey: '200' - id: aws.ec2.export_tasks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/export_tasks/methods/export_tasks_Describe' - update: [] - title: export_tasks - fast_launch: - name: fast_launch - methods: - fast_launch_Disable: - operation: - $ref: '#/paths/~1?Action=DisableFastLaunch&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fast_launch_Enable: - operation: - $ref: '#/paths/~1?Action=EnableFastLaunch&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.fast_launch - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: fast_launch - fast_launch_images: - name: fast_launch_images - methods: - fast_launch_images_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFastLaunchImages&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/fastLaunchImageSet/item - openAPIDocKey: '200' - id: aws.ec2.fast_launch_images - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/fast_launch_images/methods/fast_launch_images_Describe' - update: [] - title: fast_launch_images - fast_snapshot_restores: - name: fast_snapshot_restores - methods: - fast_snapshot_restores_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFastSnapshotRestores&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/fastSnapshotRestoreSet/item - openAPIDocKey: '200' - fast_snapshot_restores_Disable: - operation: - $ref: '#/paths/~1?Action=DisableFastSnapshotRestores&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fast_snapshot_restores_Enable: - operation: - $ref: '#/paths/~1?Action=EnableFastSnapshotRestores&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.fast_snapshot_restores - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/fast_snapshot_restores/methods/fast_snapshot_restores_Describe' - update: [] - title: fast_snapshot_restores - fleet_history: - name: fleet_history - methods: - fleet_history_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFleetHistory&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.fleet_history - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/fleet_history/methods/fleet_history_Describe' - update: [] - title: fleet_history - fleet_instances: - name: fleet_instances - methods: - fleet_instances_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFleetInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/activeInstanceSet/item - openAPIDocKey: '200' - id: aws.ec2.fleet_instances - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/fleet_instances/methods/fleet_instances_Describe' - update: [] - title: fleet_instances - fleets: - name: fleets - methods: - fleet_Create: - operation: - $ref: '#/paths/~1?Action=CreateFleet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fleet_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyFleet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fleets_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteFleets&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fleets_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFleets&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/fleetSet/item - openAPIDocKey: '200' - id: aws.ec2.fleets - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/fleets/methods/fleets_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/fleets/methods/fleet_Create' - select: - - $ref: '#/components/x-stackQL-resources/fleets/methods/fleets_Describe' - update: [] - title: fleets - flow_logs: - name: flow_logs - methods: - flow_logs_Create: - operation: - $ref: '#/paths/~1?Action=CreateFlowLogs&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - flow_logs_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteFlowLogs&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - flow_logs_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFlowLogs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/flowLogSet/item - openAPIDocKey: '200' - id: aws.ec2.flow_logs - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/flow_logs/methods/flow_logs_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/flow_logs/methods/flow_logs_Create' - select: - - $ref: '#/components/x-stackQL-resources/flow_logs/methods/flow_logs_Describe' - update: [] - title: flow_logs - flow_logs_integration_template: - name: flow_logs_integration_template - methods: - flow_logs_integration_template_Get: - operation: - $ref: '#/paths/~1?Action=GetFlowLogsIntegrationTemplate&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.flow_logs_integration_template - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/flow_logs_integration_template/methods/flow_logs_integration_template_Get' - update: [] - title: flow_logs_integration_template - fpga_image_attribute: - name: fpga_image_attribute - methods: - fpga_image_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFpgaImageAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - fpga_image_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyFpgaImageAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fpga_image_attribute_Reset: - operation: - $ref: '#/paths/~1?Action=ResetFpgaImageAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.fpga_image_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/fpga_image_attribute/methods/fpga_image_attribute_Describe' - update: [] - title: fpga_image_attribute - fpga_images: - name: fpga_images - methods: - fpga_image_Copy: - operation: - $ref: '#/paths/~1?Action=CopyFpgaImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fpga_image_Create: - operation: - $ref: '#/paths/~1?Action=CreateFpgaImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fpga_image_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteFpgaImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fpga_images_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFpgaImages&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/fpgaImageSet/item - openAPIDocKey: '200' - id: aws.ec2.fpga_images - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/fpga_images/methods/fpga_image_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/fpga_images/methods/fpga_image_Create' - select: - - $ref: '#/components/x-stackQL-resources/fpga_images/methods/fpga_images_Describe' - update: [] - title: fpga_images - groups_for_capacity_reservation: - name: groups_for_capacity_reservation - methods: - groups_for_capacity_reservation_Get: - operation: - $ref: '#/paths/~1?Action=GetGroupsForCapacityReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/capacityReservationGroupSet/item - openAPIDocKey: '200' - id: aws.ec2.groups_for_capacity_reservation - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/groups_for_capacity_reservation/methods/groups_for_capacity_reservation_Get' - update: [] - title: groups_for_capacity_reservation - host_reservation_offerings: - name: host_reservation_offerings - methods: - host_reservation_offerings_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeHostReservationOfferings&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/offeringSet/item - openAPIDocKey: '200' - id: aws.ec2.host_reservation_offerings - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/host_reservation_offerings/methods/host_reservation_offerings_Describe' - update: [] - title: host_reservation_offerings - host_reservation_purchase_preview: - name: host_reservation_purchase_preview - methods: - host_reservation_purchase_preview_Get: - operation: - $ref: '#/paths/~1?Action=GetHostReservationPurchasePreview&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.host_reservation_purchase_preview - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/host_reservation_purchase_preview/methods/host_reservation_purchase_preview_Get' - update: [] - title: host_reservation_purchase_preview - host_reservations: - name: host_reservations - methods: - host_reservation_Purchase: - operation: - $ref: '#/paths/~1?Action=PurchaseHostReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - host_reservations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeHostReservations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/hostReservationSet/item - openAPIDocKey: '200' - id: aws.ec2.host_reservations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/host_reservations/methods/host_reservations_Describe' - update: [] - title: host_reservations - hosts: - name: hosts - methods: - hosts_Allocate: - operation: - $ref: '#/paths/~1?Action=AllocateHosts&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - hosts_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeHosts&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/hostSet/item - openAPIDocKey: '200' - hosts_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyHosts&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - hosts_Release: - operation: - $ref: '#/paths/~1?Action=ReleaseHosts&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.hosts - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/hosts/methods/hosts_Describe' - update: [] - title: hosts - iam_instance_profile: - name: iam_instance_profile - methods: - iam_instance_profile_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateIamInstanceProfile&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - iam_instance_profile_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateIamInstanceProfile&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.iam_instance_profile - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: iam_instance_profile - iam_instance_profile_associations: - name: iam_instance_profile_associations - methods: - iam_instance_profile_association_Replace: - operation: - $ref: '#/paths/~1?Action=ReplaceIamInstanceProfileAssociation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - iam_instance_profile_associations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIamInstanceProfileAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/iamInstanceProfileAssociationSet/item - openAPIDocKey: '200' - id: aws.ec2.iam_instance_profile_associations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/iam_instance_profile_associations/methods/iam_instance_profile_associations_Describe' - update: [] - title: iam_instance_profile_associations - id_format: - name: id_format - methods: - id_format_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIdFormat&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/statusSet/item - openAPIDocKey: '200' - id_format_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyIdFormat&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.id_format - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/id_format/methods/id_format_Describe' - update: [] - title: id_format - identity_id_format: - name: identity_id_format - methods: - identity_id_format_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIdentityIdFormat&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/statusSet/item - openAPIDocKey: '200' - identity_id_format_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyIdentityIdFormat&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.identity_id_format - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/identity_id_format/methods/identity_id_format_Describe' - update: [] - title: identity_id_format - image_attribute: - name: image_attribute - methods: - image_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeImageAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - image_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyImageAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - image_attribute_Reset: - operation: - $ref: '#/paths/~1?Action=ResetImageAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.image_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/image_attribute/methods/image_attribute_Describe' - update: [] - title: image_attribute - image_deprecation: - name: image_deprecation - methods: - image_deprecation_Disable: - operation: - $ref: '#/paths/~1?Action=DisableImageDeprecation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - image_deprecation_Enable: - operation: - $ref: '#/paths/~1?Action=EnableImageDeprecation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.image_deprecation - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: image_deprecation - image_from_recycle_bin: - name: image_from_recycle_bin - methods: - image_from_recycle_bin_Restore: - operation: - $ref: '#/paths/~1?Action=RestoreImageFromRecycleBin&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.image_from_recycle_bin - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: image_from_recycle_bin - images: - name: images - methods: - image_Copy: - operation: - $ref: '#/paths/~1?Action=CopyImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - image_Create: - operation: - $ref: '#/paths/~1?Action=CreateImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - image_Deregister: - operation: - $ref: '#/paths/~1?Action=DeregisterImage&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - image_Export: - operation: - $ref: '#/paths/~1?Action=ExportImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - image_Import: - operation: - $ref: '#/paths/~1?Action=ImportImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - image_Register: - operation: - $ref: '#/paths/~1?Action=RegisterImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - images_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeImages&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.images - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/images/methods/image_Create' - select: - - $ref: '#/components/x-stackQL-resources/images/methods/images_Describe' - update: [] - title: images - images_in_recycle_bin: - name: images_in_recycle_bin - methods: - images_in_recycle_bin_List: - operation: - $ref: '#/paths/~1?Action=ListImagesInRecycleBin&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/imageSet/item - openAPIDocKey: '200' - id: aws.ec2.images_in_recycle_bin - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/images_in_recycle_bin/methods/images_in_recycle_bin_List' - update: [] - title: images_in_recycle_bin - import_image_tasks: - name: import_image_tasks - methods: - import_image_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeImportImageTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/importImageTaskSet/item - openAPIDocKey: '200' - id: aws.ec2.import_image_tasks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/import_image_tasks/methods/import_image_tasks_Describe' - update: [] - title: import_image_tasks - import_snapshot_tasks: - name: import_snapshot_tasks - methods: - import_snapshot_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeImportSnapshotTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/importSnapshotTaskSet/item - openAPIDocKey: '200' - id: aws.ec2.import_snapshot_tasks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/import_snapshot_tasks/methods/import_snapshot_tasks_Describe' - update: [] - title: import_snapshot_tasks - import_task: - name: import_task - methods: - import_task_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelImportTask&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.import_task - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: import_task - instance_attribute: - name: instance_attribute - methods: - instance_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - instance_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - instance_attribute_Reset: - operation: - $ref: '#/paths/~1?Action=ResetInstanceAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.instance_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_attribute/methods/instance_attribute_Describe' - update: [] - title: instance_attribute - instance_capacity_reservation_attributes: - name: instance_capacity_reservation_attributes - methods: - instance_capacity_reservation_attributes_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceCapacityReservationAttributes&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.instance_capacity_reservation_attributes - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: instance_capacity_reservation_attributes - instance_credit_specifications: - name: instance_credit_specifications - methods: - instance_credit_specification_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceCreditSpecification&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_credit_specifications_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceCreditSpecifications&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceCreditSpecificationSet/item - openAPIDocKey: '200' - id: aws.ec2.instance_credit_specifications - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_credit_specifications/methods/instance_credit_specifications_Describe' - update: [] - title: instance_credit_specifications - instance_event_notification_attributes: - name: instance_event_notification_attributes - methods: - instance_event_notification_attributes_Deregister: - operation: - $ref: '#/paths/~1?Action=DeregisterInstanceEventNotificationAttributes&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_event_notification_attributes_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceEventNotificationAttributes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - instance_event_notification_attributes_Register: - operation: - $ref: '#/paths/~1?Action=RegisterInstanceEventNotificationAttributes&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.instance_event_notification_attributes - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_event_notification_attributes/methods/instance_event_notification_attributes_Describe' - update: [] - title: instance_event_notification_attributes - instance_event_start_time: - name: instance_event_start_time - methods: - instance_event_start_time_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceEventStartTime&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.instance_event_start_time - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: instance_event_start_time - instance_event_windows: - name: instance_event_windows - methods: - instance_event_window_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateInstanceEventWindow&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_event_window_Create: - operation: - $ref: '#/paths/~1?Action=CreateInstanceEventWindow&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_event_window_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteInstanceEventWindow&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_event_window_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateInstanceEventWindow&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_event_window_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceEventWindow&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_event_windows_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceEventWindows&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceEventWindowSet/item - openAPIDocKey: '200' - id: aws.ec2.instance_event_windows - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/instance_event_windows/methods/instance_event_window_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/instance_event_windows/methods/instance_event_window_Create' - select: - - $ref: '#/components/x-stackQL-resources/instance_event_windows/methods/instance_event_windows_Describe' - update: [] - title: instance_event_windows - instance_export_task: - name: instance_export_task - methods: - instance_export_task_Create: - operation: - $ref: '#/paths/~1?Action=CreateInstanceExportTask&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.instance_export_task - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/instance_export_task/methods/instance_export_task_Create' - select: [] - update: [] - title: instance_export_task - instance_maintenance_options: - name: instance_maintenance_options - methods: - instance_maintenance_options_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceMaintenanceOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.instance_maintenance_options - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: instance_maintenance_options - instance_metadata_options: - name: instance_metadata_options - methods: - instance_metadata_options_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceMetadataOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.instance_metadata_options - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: instance_metadata_options - instance_placement: - name: instance_placement - methods: - instance_placement_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstancePlacement&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.instance_placement - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: instance_placement - instance_status: - name: instance_status - methods: - instance_status_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceStatus&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceStatusSet/item - openAPIDocKey: '200' - instance_status_Report: - operation: - $ref: '#/paths/~1?Action=ReportInstanceStatus&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.instance_status - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_status/methods/instance_status_Describe' - update: [] - title: instance_status - instance_type_offerings: - name: instance_type_offerings - methods: - instance_type_offerings_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceTypeOfferings&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceTypeOfferingSet/item - openAPIDocKey: '200' - id: aws.ec2.instance_type_offerings - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_type_offerings/methods/instance_type_offerings_Describe' - update: [] - title: instance_type_offerings - instance_types: - name: instance_types - methods: - instance_types_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceTypes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceTypeSet/item - openAPIDocKey: '200' - id: aws.ec2.instance_types - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_types/methods/instance_types_Describe' - update: [] - title: instance_types - instance_types_from_instance_requirements: - name: instance_types_from_instance_requirements - methods: - instance_types_from_instance_requirements_Get: - operation: - $ref: '#/paths/~1?Action=GetInstanceTypesFromInstanceRequirements&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceTypeSet/item - openAPIDocKey: '200' - id: aws.ec2.instance_types_from_instance_requirements - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_types_from_instance_requirements/methods/instance_types_from_instance_requirements_Get' - update: [] - title: instance_types_from_instance_requirements - instance_uefi_data: - name: instance_uefi_data - methods: - instance_uefi_data_Get: - operation: - $ref: '#/paths/~1?Action=GetInstanceUefiData&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.instance_uefi_data - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_uefi_data/methods/instance_uefi_data_Get' - update: [] - title: instance_uefi_data - instances: - name: instances - methods: - instance_Bundle: - operation: - $ref: '#/paths/~1?Action=BundleInstance&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_Import: - operation: - $ref: '#/paths/~1?Action=ImportInstance&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instances_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/reservationSet/item/instancesSet/item - openAPIDocKey: '200' - instances_Monitor: - operation: - $ref: '#/paths/~1?Action=MonitorInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instances_Reboot: - operation: - $ref: '#/paths/~1?Action=RebootInstances&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - instances_Run: - operation: - $ref: '#/paths/~1?Action=RunInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instances_Start: - operation: - $ref: '#/paths/~1?Action=StartInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instances_Stop: - operation: - $ref: '#/paths/~1?Action=StopInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instances_Terminate: - operation: - $ref: '#/paths/~1?Action=TerminateInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instances_Unmonitor: - operation: - $ref: '#/paths/~1?Action=UnmonitorInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.instances - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instances/methods/instances_Describe' - update: [] - title: instances - internet_gateways: - name: internet_gateways - methods: - internet_gateway_Attach: - operation: - $ref: '#/paths/~1?Action=AttachInternetGateway&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - internet_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateInternetGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - internet_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteInternetGateway&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - internet_gateway_Detach: - operation: - $ref: '#/paths/~1?Action=DetachInternetGateway&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - internet_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInternetGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/internetGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2.internet_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/internet_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/internet_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/internet_gateways_Describe' - update: [] - title: internet_gateways - ipam_address_history: - name: ipam_address_history - methods: - ipam_address_history_Get: - operation: - $ref: '#/paths/~1?Action=GetIpamAddressHistory&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/historyRecordSet/item - openAPIDocKey: '200' - id: aws.ec2.ipam_address_history - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ipam_address_history/methods/ipam_address_history_Get' - update: [] - title: ipam_address_history - ipam_organization_admin_account: - name: ipam_organization_admin_account - methods: - ipam_organization_admin_account_Disable: - operation: - $ref: '#/paths/~1?Action=DisableIpamOrganizationAdminAccount&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_organization_admin_account_Enable: - operation: - $ref: '#/paths/~1?Action=EnableIpamOrganizationAdminAccount&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.ipam_organization_admin_account - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: ipam_organization_admin_account - ipam_pool_allocations: - name: ipam_pool_allocations - methods: - ipam_pool_allocation_Release: - operation: - $ref: '#/paths/~1?Action=ReleaseIpamPoolAllocation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pool_allocations_Get: - operation: - $ref: '#/paths/~1?Action=GetIpamPoolAllocations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipamPoolAllocationSet/item - openAPIDocKey: '200' - id: aws.ec2.ipam_pool_allocations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ipam_pool_allocations/methods/ipam_pool_allocations_Get' - update: [] - title: ipam_pool_allocations - ipam_pool_cidrs: - name: ipam_pool_cidrs - methods: - ipam_pool_cidr_Allocate: - operation: - $ref: '#/paths/~1?Action=AllocateIpamPoolCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pool_cidr_Deprovision: - operation: - $ref: '#/paths/~1?Action=DeprovisionIpamPoolCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pool_cidr_Provision: - operation: - $ref: '#/paths/~1?Action=ProvisionIpamPoolCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pool_cidrs_Get: - operation: - $ref: '#/paths/~1?Action=GetIpamPoolCidrs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipamPoolCidrSet/item - openAPIDocKey: '200' - id: aws.ec2.ipam_pool_cidrs - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ipam_pool_cidrs/methods/ipam_pool_cidrs_Get' - update: [] - title: ipam_pool_cidrs - ipam_pools: - name: ipam_pools - methods: - ipam_pool_Create: - operation: - $ref: '#/paths/~1?Action=CreateIpamPool&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pool_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteIpamPool&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pool_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyIpamPool&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pools_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIpamPools&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipamPoolSet/item - openAPIDocKey: '200' - id: aws.ec2.ipam_pools - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/ipam_pool_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/ipam_pool_Create' - select: - - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/ipam_pools_Describe' - update: [] - title: ipam_pools - ipam_resource_cidrs: - name: ipam_resource_cidrs - methods: - ipam_resource_cidr_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyIpamResourceCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_resource_cidrs_Get: - operation: - $ref: '#/paths/~1?Action=GetIpamResourceCidrs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipamResourceCidrSet/item - openAPIDocKey: '200' - id: aws.ec2.ipam_resource_cidrs - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ipam_resource_cidrs/methods/ipam_resource_cidrs_Get' - update: [] - title: ipam_resource_cidrs - ipam_scopes: - name: ipam_scopes - methods: - ipam_scope_Create: - operation: - $ref: '#/paths/~1?Action=CreateIpamScope&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_scope_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteIpamScope&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_scope_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyIpamScope&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_scopes_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIpamScopes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipamScopeSet/item - openAPIDocKey: '200' - id: aws.ec2.ipam_scopes - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/ipam_scope_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/ipam_scope_Create' - select: - - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/ipam_scopes_Describe' - update: [] - title: ipam_scopes - ipams: - name: ipams - methods: - ipam_Create: - operation: - $ref: '#/paths/~1?Action=CreateIpam&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteIpam&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyIpam&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipams_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIpams&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipamSet/item - openAPIDocKey: '200' - id: aws.ec2.ipams - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/ipams/methods/ipam_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/ipams/methods/ipam_Create' - select: - - $ref: '#/components/x-stackQL-resources/ipams/methods/ipams_Describe' - update: [] - title: ipams - ipv6_addresses: - name: ipv6_addresses - methods: - ipv6_addresses_Assign: - operation: - $ref: '#/paths/~1?Action=AssignIpv6Addresses&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipv6_addresses_Unassign: - operation: - $ref: '#/paths/~1?Action=UnassignIpv6Addresses&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.ipv6_addresses - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: ipv6_addresses - ipv6_pools: - name: ipv6_pools - methods: - ipv6_pools_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIpv6Pools&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipv6PoolSet/item - openAPIDocKey: '200' - id: aws.ec2.ipv6_pools - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ipv6_pools/methods/ipv6_pools_Describe' - update: [] - title: ipv6_pools - key_pairs: - name: key_pairs - methods: - key_pair_Create: - operation: - $ref: '#/paths/~1?Action=CreateKeyPair&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - key_pair_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteKeyPair&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - key_pair_Import: - operation: - $ref: '#/paths/~1?Action=ImportKeyPair&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - key_pairs_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeKeyPairs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.key_pairs - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/key_pairs/methods/key_pair_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/key_pairs/methods/key_pair_Create' - select: - - $ref: '#/components/x-stackQL-resources/key_pairs/methods/key_pairs_Describe' - update: [] - title: key_pairs - launch_template_data: - name: launch_template_data - methods: - launch_template_data_Get: - operation: - $ref: '#/paths/~1?Action=GetLaunchTemplateData&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.launch_template_data - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/launch_template_data/methods/launch_template_data_Get' - update: [] - title: launch_template_data - launch_template_versions: - name: launch_template_versions - methods: - launch_template_version_Create: - operation: - $ref: '#/paths/~1?Action=CreateLaunchTemplateVersion&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - launch_template_versions_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteLaunchTemplateVersions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - launch_template_versions_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLaunchTemplateVersions&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/launchTemplateVersionSet/item - openAPIDocKey: '200' - id: aws.ec2.launch_template_versions - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/launch_template_versions/methods/launch_template_versions_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/launch_template_versions/methods/launch_template_version_Create' - select: - - $ref: '#/components/x-stackQL-resources/launch_template_versions/methods/launch_template_versions_Describe' - update: [] - title: launch_template_versions - launch_templates: - name: launch_templates - methods: - launch_template_Create: - operation: - $ref: '#/paths/~1?Action=CreateLaunchTemplate&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - launch_template_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteLaunchTemplate&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - launch_template_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyLaunchTemplate&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - launch_templates_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLaunchTemplates&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/launchTemplates/item - openAPIDocKey: '200' - id: aws.ec2.launch_templates - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/launch_templates/methods/launch_template_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/launch_templates/methods/launch_template_Create' - select: - - $ref: '#/components/x-stackQL-resources/launch_templates/methods/launch_templates_Describe' - update: [] - title: launch_templates - local_gateway_route_table_virtual_interface_group_associations: - name: local_gateway_route_table_virtual_interface_group_associations - methods: - local_gateway_route_table_virtual_interface_group_associations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/localGatewayRouteTableVirtualInterfaceGroupAssociationSet/item - openAPIDocKey: '200' - id: aws.ec2.local_gateway_route_table_virtual_interface_group_associations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_virtual_interface_group_associations/methods/local_gateway_route_table_virtual_interface_group_associations_Describe' - update: [] - title: local_gateway_route_table_virtual_interface_group_associations - local_gateway_route_table_vpc_associations: - name: local_gateway_route_table_vpc_associations - methods: - local_gateway_route_table_vpc_association_Create: - operation: - $ref: '#/paths/~1?Action=CreateLocalGatewayRouteTableVpcAssociation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - local_gateway_route_table_vpc_association_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteLocalGatewayRouteTableVpcAssociation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - local_gateway_route_table_vpc_associations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLocalGatewayRouteTableVpcAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/localGatewayRouteTableVpcAssociationSet/item - openAPIDocKey: '200' - id: aws.ec2.local_gateway_route_table_vpc_associations - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_vpc_associations/methods/local_gateway_route_table_vpc_association_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_vpc_associations/methods/local_gateway_route_table_vpc_association_Create' - select: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_vpc_associations/methods/local_gateway_route_table_vpc_associations_Describe' - update: [] - title: local_gateway_route_table_vpc_associations - local_gateway_route_tables: - name: local_gateway_route_tables - methods: - local_gateway_route_tables_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLocalGatewayRouteTables&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/localGatewayRouteTableSet/item - openAPIDocKey: '200' - id: aws.ec2.local_gateway_route_tables - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_tables/methods/local_gateway_route_tables_Describe' - update: [] - title: local_gateway_route_tables - local_gateway_routes: - name: local_gateway_routes - methods: - local_gateway_route_Create: - operation: - $ref: '#/paths/~1?Action=CreateLocalGatewayRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - local_gateway_route_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteLocalGatewayRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - local_gateway_routes_Search: - operation: - $ref: '#/paths/~1?Action=SearchLocalGatewayRoutes&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.local_gateway_routes - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/local_gateway_route_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/local_gateway_route_Create' - select: [] - update: [] - title: local_gateway_routes - local_gateway_virtual_interface_groups: - name: local_gateway_virtual_interface_groups - methods: - local_gateway_virtual_interface_groups_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLocalGatewayVirtualInterfaceGroups&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/localGatewayVirtualInterfaceGroupSet/item - openAPIDocKey: '200' - id: aws.ec2.local_gateway_virtual_interface_groups - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/local_gateway_virtual_interface_groups/methods/local_gateway_virtual_interface_groups_Describe' - update: [] - title: local_gateway_virtual_interface_groups - local_gateway_virtual_interfaces: - name: local_gateway_virtual_interfaces - methods: - local_gateway_virtual_interfaces_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLocalGatewayVirtualInterfaces&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/localGatewayVirtualInterfaceSet/item - openAPIDocKey: '200' - id: aws.ec2.local_gateway_virtual_interfaces - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/local_gateway_virtual_interfaces/methods/local_gateway_virtual_interfaces_Describe' - update: [] - title: local_gateway_virtual_interfaces - local_gateways: - name: local_gateways - methods: - local_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLocalGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/localGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2.local_gateways - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/local_gateways/methods/local_gateways_Describe' - update: [] - title: local_gateways - managed_prefix_list_associations: - name: managed_prefix_list_associations - methods: - managed_prefix_list_associations_Get: - operation: - $ref: '#/paths/~1?Action=GetManagedPrefixListAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/prefixListAssociationSet/item - openAPIDocKey: '200' - id: aws.ec2.managed_prefix_list_associations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/managed_prefix_list_associations/methods/managed_prefix_list_associations_Get' - update: [] - title: managed_prefix_list_associations - managed_prefix_list_entries: - name: managed_prefix_list_entries - methods: - managed_prefix_list_entries_Get: - operation: - $ref: '#/paths/~1?Action=GetManagedPrefixListEntries&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/entrySet/item - openAPIDocKey: '200' - id: aws.ec2.managed_prefix_list_entries - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/managed_prefix_list_entries/methods/managed_prefix_list_entries_Get' - update: [] - title: managed_prefix_list_entries - managed_prefix_list_version: - name: managed_prefix_list_version - methods: - managed_prefix_list_version_Restore: - operation: - $ref: '#/paths/~1?Action=RestoreManagedPrefixListVersion&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.managed_prefix_list_version - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: managed_prefix_list_version - managed_prefix_lists: - name: managed_prefix_lists - methods: - managed_prefix_list_Create: - operation: - $ref: '#/paths/~1?Action=CreateManagedPrefixList&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - managed_prefix_list_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteManagedPrefixList&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - managed_prefix_list_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyManagedPrefixList&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - managed_prefix_lists_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeManagedPrefixLists&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/prefixListSet/item - openAPIDocKey: '200' - id: aws.ec2.managed_prefix_lists - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/managed_prefix_lists/methods/managed_prefix_list_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/managed_prefix_lists/methods/managed_prefix_list_Create' - select: - - $ref: '#/components/x-stackQL-resources/managed_prefix_lists/methods/managed_prefix_lists_Describe' - update: [] - title: managed_prefix_lists - moving_addresses: - name: moving_addresses - methods: - moving_addresses_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeMovingAddresses&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/movingAddressStatusSet/item - openAPIDocKey: '200' - id: aws.ec2.moving_addresses - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/moving_addresses/methods/moving_addresses_Describe' - update: [] - title: moving_addresses - nat_gateways: - name: nat_gateways - methods: - nat_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateNatGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - nat_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNatGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - nat_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNatGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/natGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2.nat_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/nat_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/nat_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/nat_gateways_Describe' - update: [] - title: nat_gateways - network_acl_association: - name: network_acl_association - methods: - network_acl_association_Replace: - operation: - $ref: '#/paths/~1?Action=ReplaceNetworkAclAssociation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.network_acl_association - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: network_acl_association - network_acl_entry: - name: network_acl_entry - methods: - network_acl_entry_Create: - operation: - $ref: '#/paths/~1?Action=CreateNetworkAclEntry&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - network_acl_entry_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkAclEntry&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - network_acl_entry_Replace: - operation: - $ref: '#/paths/~1?Action=ReplaceNetworkAclEntry&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.network_acl_entry - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_acl_entry/methods/network_acl_entry_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/network_acl_entry/methods/network_acl_entry_Create' - select: [] - update: [] - title: network_acl_entry - network_acls: - name: network_acls - methods: - network_acl_Create: - operation: - $ref: '#/paths/~1?Action=CreateNetworkAcl&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_acl_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkAcl&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - network_acls_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkAcls&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkAclSet/item - openAPIDocKey: '200' - id: aws.ec2.network_acls - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_acls/methods/network_acl_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/network_acls/methods/network_acl_Create' - select: - - $ref: '#/components/x-stackQL-resources/network_acls/methods/network_acls_Describe' - update: [] - title: network_acls - network_insights_access_scope_analyses: - name: network_insights_access_scope_analyses - methods: - network_insights_access_scope_analyses_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInsightsAccessScopeAnalyses&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkInsightsAccessScopeAnalysisSet/item - openAPIDocKey: '200' - id: aws.ec2.network_insights_access_scope_analyses - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analyses/methods/network_insights_access_scope_analyses_Describe' - update: [] - title: network_insights_access_scope_analyses - network_insights_access_scope_analysis: - name: network_insights_access_scope_analysis - methods: - network_insights_access_scope_analysis_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkInsightsAccessScopeAnalysis&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_insights_access_scope_analysis_Start: - operation: - $ref: '#/paths/~1?Action=StartNetworkInsightsAccessScopeAnalysis&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.network_insights_access_scope_analysis - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analysis/methods/network_insights_access_scope_analysis_Delete' - insert: [] - select: [] - update: [] - title: network_insights_access_scope_analysis - network_insights_access_scope_analysis_findings: - name: network_insights_access_scope_analysis_findings - methods: - network_insights_access_scope_analysis_findings_Get: - operation: - $ref: '#/paths/~1?Action=GetNetworkInsightsAccessScopeAnalysisFindings&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/analysisFindingSet/item - openAPIDocKey: '200' - id: aws.ec2.network_insights_access_scope_analysis_findings - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analysis_findings/methods/network_insights_access_scope_analysis_findings_Get' - update: [] - title: network_insights_access_scope_analysis_findings - network_insights_access_scope_content: - name: network_insights_access_scope_content - methods: - network_insights_access_scope_content_Get: - operation: - $ref: '#/paths/~1?Action=GetNetworkInsightsAccessScopeContent&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.network_insights_access_scope_content - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_content/methods/network_insights_access_scope_content_Get' - update: [] - title: network_insights_access_scope_content - network_insights_access_scopes: - name: network_insights_access_scopes - methods: - network_insights_access_scope_Create: - operation: - $ref: '#/paths/~1?Action=CreateNetworkInsightsAccessScope&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_insights_access_scope_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkInsightsAccessScope&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_insights_access_scopes_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInsightsAccessScopes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkInsightsAccessScopeSet/item - openAPIDocKey: '200' - id: aws.ec2.network_insights_access_scopes - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/network_insights_access_scope_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/network_insights_access_scope_Create' - select: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/network_insights_access_scopes_Describe' - update: [] - title: network_insights_access_scopes - network_insights_analyses: - name: network_insights_analyses - methods: - network_insights_analyses_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInsightsAnalyses&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkInsightsAnalysisSet/item - openAPIDocKey: '200' - id: aws.ec2.network_insights_analyses - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/network_insights_analyses/methods/network_insights_analyses_Describe' - update: [] - title: network_insights_analyses - network_insights_analysis: - name: network_insights_analysis - methods: - network_insights_analysis_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkInsightsAnalysis&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_insights_analysis_Start: - operation: - $ref: '#/paths/~1?Action=StartNetworkInsightsAnalysis&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.network_insights_analysis - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_insights_analysis/methods/network_insights_analysis_Delete' - insert: [] - select: [] - update: [] - title: network_insights_analysis - network_insights_paths: - name: network_insights_paths - methods: - network_insights_path_Create: - operation: - $ref: '#/paths/~1?Action=CreateNetworkInsightsPath&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_insights_path_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkInsightsPath&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_insights_paths_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInsightsPaths&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkInsightsPathSet/item - openAPIDocKey: '200' - id: aws.ec2.network_insights_paths - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/network_insights_path_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/network_insights_path_Create' - select: - - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/network_insights_paths_Describe' - update: [] - title: network_insights_paths - network_interface_attribute: - name: network_interface_attribute - methods: - network_interface_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInterfaceAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - network_interface_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyNetworkInterfaceAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - network_interface_attribute_Reset: - operation: - $ref: '#/paths/~1?Action=ResetNetworkInterfaceAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.network_interface_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/network_interface_attribute/methods/network_interface_attribute_Describe' - update: [] - title: network_interface_attribute - network_interface_permissions: - name: network_interface_permissions - methods: - network_interface_permission_Create: - operation: - $ref: '#/paths/~1?Action=CreateNetworkInterfacePermission&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_interface_permission_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkInterfacePermission&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_interface_permissions_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInterfacePermissions&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkInterfacePermissions/item - openAPIDocKey: '200' - id: aws.ec2.network_interface_permissions - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_interface_permissions/methods/network_interface_permission_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/network_interface_permissions/methods/network_interface_permission_Create' - select: - - $ref: '#/components/x-stackQL-resources/network_interface_permissions/methods/network_interface_permissions_Describe' - update: [] - title: network_interface_permissions - network_interfaces: - name: network_interfaces - methods: - network_interface_Attach: - operation: - $ref: '#/paths/~1?Action=AttachNetworkInterface&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_interface_Create: - operation: - $ref: '#/paths/~1?Action=CreateNetworkInterface&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_interface_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkInterface&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - network_interface_Detach: - operation: - $ref: '#/paths/~1?Action=DetachNetworkInterface&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - network_interfaces_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInterfaces&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkInterfaceSet/item - openAPIDocKey: '200' - id: aws.ec2.network_interfaces - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/network_interface_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/network_interface_Create' - select: - - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/network_interfaces_Describe' - update: [] - title: network_interfaces - password_data: - name: password_data - methods: - password_data_Get: - operation: - $ref: '#/paths/~1?Action=GetPasswordData&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.password_data - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/password_data/methods/password_data_Get' - update: [] - title: password_data - placement_groups: - name: placement_groups - methods: - placement_group_Create: - operation: - $ref: '#/paths/~1?Action=CreatePlacementGroup&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - placement_group_Delete: - operation: - $ref: '#/paths/~1?Action=DeletePlacementGroup&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - placement_groups_Describe: - operation: - $ref: '#/paths/~1?Action=DescribePlacementGroups&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/placementGroupSet/item - openAPIDocKey: '200' - id: aws.ec2.placement_groups - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/placement_groups/methods/placement_group_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/placement_groups/methods/placement_group_Create' - select: - - $ref: '#/components/x-stackQL-resources/placement_groups/methods/placement_groups_Describe' - update: [] - title: placement_groups - prefix_lists: - name: prefix_lists - methods: - prefix_lists_Describe: - operation: - $ref: '#/paths/~1?Action=DescribePrefixLists&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/prefixListSet/item - openAPIDocKey: '200' - id: aws.ec2.prefix_lists - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/prefix_lists/methods/prefix_lists_Describe' - update: [] - title: prefix_lists - principal_id_format: - name: principal_id_format - methods: - principal_id_format_Describe: - operation: - $ref: '#/paths/~1?Action=DescribePrincipalIdFormat&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/principalSet/item - openAPIDocKey: '200' - id: aws.ec2.principal_id_format - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/principal_id_format/methods/principal_id_format_Describe' - update: [] - title: principal_id_format - private_dns_name_options: - name: private_dns_name_options - methods: - private_dns_name_options_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyPrivateDnsNameOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.private_dns_name_options - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: private_dns_name_options - private_ip_addresses: - name: private_ip_addresses - methods: - private_ip_addresses_Assign: - operation: - $ref: '#/paths/~1?Action=AssignPrivateIpAddresses&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - private_ip_addresses_Unassign: - operation: - $ref: '#/paths/~1?Action=UnassignPrivateIpAddresses&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.private_ip_addresses - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: private_ip_addresses - product_instance: - name: product_instance - methods: - product_instance_Confirm: - operation: - $ref: '#/paths/~1?Action=ConfirmProductInstance&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.product_instance - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: product_instance - public_ipv4_pool_cidr: - name: public_ipv4_pool_cidr - methods: - public_ipv4_pool_cidr_Deprovision: - operation: - $ref: '#/paths/~1?Action=DeprovisionPublicIpv4PoolCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - public_ipv4_pool_cidr_Provision: - operation: - $ref: '#/paths/~1?Action=ProvisionPublicIpv4PoolCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.public_ipv4_pool_cidr - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: public_ipv4_pool_cidr - public_ipv4_pools: - name: public_ipv4_pools - methods: - public_ipv4_pool_Create: - operation: - $ref: '#/paths/~1?Action=CreatePublicIpv4Pool&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - public_ipv4_pool_Delete: - operation: - $ref: '#/paths/~1?Action=DeletePublicIpv4Pool&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - public_ipv4_pools_Describe: - operation: - $ref: '#/paths/~1?Action=DescribePublicIpv4Pools&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/publicIpv4PoolSet/item - openAPIDocKey: '200' - id: aws.ec2.public_ipv4_pools - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/public_ipv4_pools/methods/public_ipv4_pool_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/public_ipv4_pools/methods/public_ipv4_pool_Create' - select: - - $ref: '#/components/x-stackQL-resources/public_ipv4_pools/methods/public_ipv4_pools_Describe' - update: [] - title: public_ipv4_pools - queued_reserved_instances: - name: queued_reserved_instances - methods: - queued_reserved_instances_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteQueuedReservedInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.queued_reserved_instances - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/queued_reserved_instances/methods/queued_reserved_instances_Delete' - insert: [] - select: [] - update: [] - title: queued_reserved_instances - regions: - name: regions - methods: - regions_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeRegions&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/regionInfo/item - openAPIDocKey: '200' - id: aws.ec2.regions - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/regions/methods/regions_Describe' - update: [] - title: regions - replace_root_volume_tasks: - name: replace_root_volume_tasks - methods: - replace_root_volume_task_Create: - operation: - $ref: '#/paths/~1?Action=CreateReplaceRootVolumeTask&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - replace_root_volume_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeReplaceRootVolumeTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/replaceRootVolumeTaskSet/item - openAPIDocKey: '200' - id: aws.ec2.replace_root_volume_tasks - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/replace_root_volume_tasks/methods/replace_root_volume_task_Create' - select: - - $ref: '#/components/x-stackQL-resources/replace_root_volume_tasks/methods/replace_root_volume_tasks_Describe' - update: [] - title: replace_root_volume_tasks - reserved_instances: - name: reserved_instances - methods: - reserved_instances_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeReservedInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/reservedInstancesSet/item - openAPIDocKey: '200' - reserved_instances_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyReservedInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.reserved_instances - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/reserved_instances/methods/reserved_instances_Describe' - update: [] - title: reserved_instances - reserved_instances_exchange_quote: - name: reserved_instances_exchange_quote - methods: - reserved_instances_exchange_quote_Accept: - operation: - $ref: '#/paths/~1?Action=AcceptReservedInstancesExchangeQuote&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - reserved_instances_exchange_quote_Get: - operation: - $ref: '#/paths/~1?Action=GetReservedInstancesExchangeQuote&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.reserved_instances_exchange_quote - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/reserved_instances_exchange_quote/methods/reserved_instances_exchange_quote_Get' - update: [] - title: reserved_instances_exchange_quote - reserved_instances_listings: - name: reserved_instances_listings - methods: - reserved_instances_listing_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelReservedInstancesListing&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - reserved_instances_listing_Create: - operation: - $ref: '#/paths/~1?Action=CreateReservedInstancesListing&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - reserved_instances_listings_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeReservedInstancesListings&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/reservedInstancesListingsSet/item - openAPIDocKey: '200' - id: aws.ec2.reserved_instances_listings - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/reserved_instances_listings/methods/reserved_instances_listing_Create' - select: - - $ref: '#/components/x-stackQL-resources/reserved_instances_listings/methods/reserved_instances_listings_Describe' - update: [] - title: reserved_instances_listings - reserved_instances_modifications: - name: reserved_instances_modifications - methods: - reserved_instances_modifications_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeReservedInstancesModifications&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/reservedInstancesModificationsSet/item - openAPIDocKey: '200' - id: aws.ec2.reserved_instances_modifications - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/reserved_instances_modifications/methods/reserved_instances_modifications_Describe' - update: [] - title: reserved_instances_modifications - reserved_instances_offerings: - name: reserved_instances_offerings - methods: - reserved_instances_offering_Purchase: - operation: - $ref: '#/paths/~1?Action=PurchaseReservedInstancesOffering&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - reserved_instances_offerings_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeReservedInstancesOfferings&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/reservedInstancesOfferingsSet/item - openAPIDocKey: '200' - id: aws.ec2.reserved_instances_offerings - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/reserved_instances_offerings/methods/reserved_instances_offerings_Describe' - update: [] - title: reserved_instances_offerings - restore_image_task: - name: restore_image_task - methods: - restore_image_task_Create: - operation: - $ref: '#/paths/~1?Action=CreateRestoreImageTask&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.restore_image_task - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/restore_image_task/methods/restore_image_task_Create' - select: [] - update: [] - title: restore_image_task - route: - name: route - methods: - route_Create: - operation: - $ref: '#/paths/~1?Action=CreateRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - route_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteRoute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - route_Replace: - operation: - $ref: '#/paths/~1?Action=ReplaceRoute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.route - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/route/methods/route_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/route/methods/route_Create' - select: [] - update: [] - title: route - route_table_association: - name: route_table_association - methods: - route_table_association_Replace: - operation: - $ref: '#/paths/~1?Action=ReplaceRouteTableAssociation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.route_table_association - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: route_table_association - route_tables: - name: route_tables - methods: - route_table_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateRouteTable&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - route_table_Create: - operation: - $ref: '#/paths/~1?Action=CreateRouteTable&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - route_table_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteRouteTable&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - route_table_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateRouteTable&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - route_tables_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeRouteTables&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/routeTableSet/item - openAPIDocKey: '200' - id: aws.ec2.route_tables - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/route_tables/methods/route_table_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/route_tables/methods/route_table_Create' - select: - - $ref: '#/components/x-stackQL-resources/route_tables/methods/route_tables_Describe' - update: [] - title: route_tables - scheduled_instance_availability: - name: scheduled_instance_availability - methods: - scheduled_instance_availability_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeScheduledInstanceAvailability&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/scheduledInstanceAvailabilitySet/item - openAPIDocKey: '200' - id: aws.ec2.scheduled_instance_availability - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/scheduled_instance_availability/methods/scheduled_instance_availability_Describe' - update: [] - title: scheduled_instance_availability - scheduled_instances: - name: scheduled_instances - methods: - scheduled_instances_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeScheduledInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/scheduledInstanceSet/item - openAPIDocKey: '200' - scheduled_instances_Purchase: - operation: - $ref: '#/paths/~1?Action=PurchaseScheduledInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - scheduled_instances_Run: - operation: - $ref: '#/paths/~1?Action=RunScheduledInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.scheduled_instances - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/scheduled_instances/methods/scheduled_instances_Describe' - update: [] - title: scheduled_instances - security_group_egress: - name: security_group_egress - methods: - security_group_egress_Authorize: - operation: - $ref: '#/paths/~1?Action=AuthorizeSecurityGroupEgress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - security_group_egress_Revoke: - operation: - $ref: '#/paths/~1?Action=RevokeSecurityGroupEgress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.security_group_egress - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: security_group_egress - security_group_ingress: - name: security_group_ingress - methods: - security_group_ingress_Authorize: - operation: - $ref: '#/paths/~1?Action=AuthorizeSecurityGroupIngress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - security_group_ingress_Revoke: - operation: - $ref: '#/paths/~1?Action=RevokeSecurityGroupIngress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.security_group_ingress - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: security_group_ingress - security_group_references: - name: security_group_references - methods: - security_group_references_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSecurityGroupReferences&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/securityGroupReferenceSet/item - openAPIDocKey: '200' - id: aws.ec2.security_group_references - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/security_group_references/methods/security_group_references_Describe' - update: [] - title: security_group_references - security_group_rule_descriptions_egress: - name: security_group_rule_descriptions_egress - methods: - security_group_rule_descriptions_egress_Update: - operation: - $ref: '#/paths/~1?Action=UpdateSecurityGroupRuleDescriptionsEgress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.security_group_rule_descriptions_egress - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: security_group_rule_descriptions_egress - security_group_rule_descriptions_ingress: - name: security_group_rule_descriptions_ingress - methods: - security_group_rule_descriptions_ingress_Update: - operation: - $ref: '#/paths/~1?Action=UpdateSecurityGroupRuleDescriptionsIngress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.security_group_rule_descriptions_ingress - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: security_group_rule_descriptions_ingress - security_group_rules: - name: security_group_rules - methods: - security_group_rules_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSecurityGroupRules&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/securityGroupRuleSet/item - openAPIDocKey: '200' - security_group_rules_Modify: - operation: - $ref: '#/paths/~1?Action=ModifySecurityGroupRules&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.security_group_rules - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/security_group_rules/methods/security_group_rules_Describe' - update: [] - title: security_group_rules - security_groups: - name: security_groups - methods: - security_group_Create: - operation: - $ref: '#/paths/~1?Action=CreateSecurityGroup&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - security_group_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSecurityGroup&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - security_groups_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSecurityGroups&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/securityGroupInfo/item - openAPIDocKey: '200' - id: aws.ec2.security_groups - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/security_groups/methods/security_group_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/security_groups/methods/security_group_Create' - select: - - $ref: '#/components/x-stackQL-resources/security_groups/methods/security_groups_Describe' - update: [] - title: security_groups - security_groups_to_client_vpn_target_network: - name: security_groups_to_client_vpn_target_network - methods: - security_groups_to_client_vpn_target_network_Apply: - operation: - $ref: '#/paths/~1?Action=ApplySecurityGroupsToClientVpnTargetNetwork&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.security_groups_to_client_vpn_target_network - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: security_groups_to_client_vpn_target_network - serial_console_access: - name: serial_console_access - methods: - serial_console_access_Disable: - operation: - $ref: '#/paths/~1?Action=DisableSerialConsoleAccess&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - serial_console_access_Enable: - operation: - $ref: '#/paths/~1?Action=EnableSerialConsoleAccess&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.serial_console_access - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: serial_console_access - serial_console_access_status: - name: serial_console_access_status - methods: - serial_console_access_status_Get: - operation: - $ref: '#/paths/~1?Action=GetSerialConsoleAccessStatus&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.serial_console_access_status - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/serial_console_access_status/methods/serial_console_access_status_Get' - update: [] - title: serial_console_access_status - snapshot_attribute: - name: snapshot_attribute - methods: - snapshot_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSnapshotAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - snapshot_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifySnapshotAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - snapshot_attribute_Reset: - operation: - $ref: '#/paths/~1?Action=ResetSnapshotAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.snapshot_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/snapshot_attribute/methods/snapshot_attribute_Describe' - update: [] - title: snapshot_attribute - snapshot_from_recycle_bin: - name: snapshot_from_recycle_bin - methods: - snapshot_from_recycle_bin_Restore: - operation: - $ref: '#/paths/~1?Action=RestoreSnapshotFromRecycleBin&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.snapshot_from_recycle_bin - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: snapshot_from_recycle_bin - snapshot_tier: - name: snapshot_tier - methods: - snapshot_tier_Modify: - operation: - $ref: '#/paths/~1?Action=ModifySnapshotTier&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - snapshot_tier_Restore: - operation: - $ref: '#/paths/~1?Action=RestoreSnapshotTier&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.snapshot_tier - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: snapshot_tier - snapshot_tier_status: - name: snapshot_tier_status - methods: - snapshot_tier_status_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSnapshotTierStatus&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/snapshotTierStatusSet/item - openAPIDocKey: '200' - id: aws.ec2.snapshot_tier_status - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/snapshot_tier_status/methods/snapshot_tier_status_Describe' - update: [] - title: snapshot_tier_status - snapshots: - name: snapshots - methods: - snapshot_Copy: - operation: - $ref: '#/paths/~1?Action=CopySnapshot&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - snapshot_Create: - operation: - $ref: '#/paths/~1?Action=CreateSnapshot&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - snapshot_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSnapshot&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - snapshot_Import: - operation: - $ref: '#/paths/~1?Action=ImportSnapshot&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - snapshots_Create: - operation: - $ref: '#/paths/~1?Action=CreateSnapshots&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - snapshots_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSnapshots&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/snapshotSet/item - openAPIDocKey: '200' - id: aws.ec2.snapshots - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/snapshots/methods/snapshot_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/snapshots/methods/snapshot_Create' - - $ref: '#/components/x-stackQL-resources/snapshots/methods/snapshots_Create' - select: - - $ref: '#/components/x-stackQL-resources/snapshots/methods/snapshots_Describe' - update: [] - title: snapshots - snapshots_in_recycle_bin: - name: snapshots_in_recycle_bin - methods: - snapshots_in_recycle_bin_List: - operation: - $ref: '#/paths/~1?Action=ListSnapshotsInRecycleBin&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/snapshotSet/item - openAPIDocKey: '200' - id: aws.ec2.snapshots_in_recycle_bin - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/snapshots_in_recycle_bin/methods/snapshots_in_recycle_bin_List' - update: [] - title: snapshots_in_recycle_bin - spot_datafeed_subscription: - name: spot_datafeed_subscription - methods: - spot_datafeed_subscription_Create: - operation: - $ref: '#/paths/~1?Action=CreateSpotDatafeedSubscription&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - spot_datafeed_subscription_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSpotDatafeedSubscription&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - spot_datafeed_subscription_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSpotDatafeedSubscription&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/spotDatafeedSubscription/* - openAPIDocKey: '200' - id: aws.ec2.spot_datafeed_subscription - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/spot_datafeed_subscription/methods/spot_datafeed_subscription_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/spot_datafeed_subscription/methods/spot_datafeed_subscription_Create' - select: - - $ref: '#/components/x-stackQL-resources/spot_datafeed_subscription/methods/spot_datafeed_subscription_Describe' - update: [] - title: spot_datafeed_subscription - spot_fleet: - name: spot_fleet - methods: - spot_fleet_Request: - operation: - $ref: '#/paths/~1?Action=RequestSpotFleet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.spot_fleet - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: spot_fleet - spot_fleet_instances: - name: spot_fleet_instances - methods: - spot_fleet_instances_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSpotFleetInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/activeInstanceSet/item - openAPIDocKey: '200' - id: aws.ec2.spot_fleet_instances - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/spot_fleet_instances/methods/spot_fleet_instances_Describe' - update: [] - title: spot_fleet_instances - spot_fleet_request_history: - name: spot_fleet_request_history - methods: - spot_fleet_request_history_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSpotFleetRequestHistory&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/historyRecordSet/item - openAPIDocKey: '200' - id: aws.ec2.spot_fleet_request_history - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/spot_fleet_request_history/methods/spot_fleet_request_history_Describe' - update: [] - title: spot_fleet_request_history - spot_fleet_requests: - name: spot_fleet_requests - methods: - spot_fleet_request_Modify: - operation: - $ref: '#/paths/~1?Action=ModifySpotFleetRequest&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - spot_fleet_requests_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelSpotFleetRequests&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - spot_fleet_requests_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSpotFleetRequests&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/spotFleetRequestConfigSet/item - openAPIDocKey: '200' - id: aws.ec2.spot_fleet_requests - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/spot_fleet_requests/methods/spot_fleet_requests_Describe' - update: [] - title: spot_fleet_requests - spot_instance_requests: - name: spot_instance_requests - methods: - spot_instance_requests_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelSpotInstanceRequests&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - spot_instance_requests_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSpotInstanceRequests&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/spotInstanceRequestSet/item - openAPIDocKey: '200' - id: aws.ec2.spot_instance_requests - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/spot_instance_requests/methods/spot_instance_requests_Describe' - update: [] - title: spot_instance_requests - spot_instances: - name: spot_instances - methods: - spot_instances_Request: - operation: - $ref: '#/paths/~1?Action=RequestSpotInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.spot_instances - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: spot_instances - spot_placement_scores: - name: spot_placement_scores - methods: - spot_placement_scores_Get: - operation: - $ref: '#/paths/~1?Action=GetSpotPlacementScores&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/spotPlacementScoreSet/item - openAPIDocKey: '200' - id: aws.ec2.spot_placement_scores - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/spot_placement_scores/methods/spot_placement_scores_Get' - update: [] - title: spot_placement_scores - spot_price_history: - name: spot_price_history - methods: - spot_price_history_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSpotPriceHistory&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/spotPriceHistorySet/item - openAPIDocKey: '200' - id: aws.ec2.spot_price_history - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/spot_price_history/methods/spot_price_history_Describe' - update: [] - title: spot_price_history - stale_security_groups: - name: stale_security_groups - methods: - stale_security_groups_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeStaleSecurityGroups&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/staleSecurityGroupSet/item - openAPIDocKey: '200' - id: aws.ec2.stale_security_groups - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/stale_security_groups/methods/stale_security_groups_Describe' - update: [] - title: stale_security_groups - store_image_tasks: - name: store_image_tasks - methods: - store_image_task_Create: - operation: - $ref: '#/paths/~1?Action=CreateStoreImageTask&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - store_image_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeStoreImageTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/storeImageTaskResultSet/item - openAPIDocKey: '200' - id: aws.ec2.store_image_tasks - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/store_image_tasks/methods/store_image_task_Create' - select: - - $ref: '#/components/x-stackQL-resources/store_image_tasks/methods/store_image_tasks_Describe' - update: [] - title: store_image_tasks - subnet_attribute: - name: subnet_attribute - methods: - subnet_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifySubnetAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.subnet_attribute - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: subnet_attribute - subnet_cidr_block: - name: subnet_cidr_block - methods: - subnet_cidr_block_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateSubnetCidrBlock&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - subnet_cidr_block_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateSubnetCidrBlock&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.subnet_cidr_block - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: subnet_cidr_block - subnet_cidr_reservations: - name: subnet_cidr_reservations - methods: - subnet_cidr_reservation_Create: - operation: - $ref: '#/paths/~1?Action=CreateSubnetCidrReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - subnet_cidr_reservation_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSubnetCidrReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - subnet_cidr_reservations_Get: - operation: - $ref: '#/paths/~1?Action=GetSubnetCidrReservations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.subnet_cidr_reservations - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/subnet_cidr_reservations/methods/subnet_cidr_reservation_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/subnet_cidr_reservations/methods/subnet_cidr_reservation_Create' - select: - - $ref: '#/components/x-stackQL-resources/subnet_cidr_reservations/methods/subnet_cidr_reservations_Get' - update: [] - title: subnet_cidr_reservations - subnets: - name: subnets - methods: - subnet_Create: - operation: - $ref: '#/paths/~1?Action=CreateSubnet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - subnet_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSubnet&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - subnets_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSubnets&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/subnetSet/item - openAPIDocKey: '200' - id: aws.ec2.subnets - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/subnets/methods/subnet_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/subnets/methods/subnet_Create' - select: - - $ref: '#/components/x-stackQL-resources/subnets/methods/subnets_Describe' - update: [] - title: subnets - tags: - name: tags - methods: - tags_Create: - operation: - $ref: '#/paths/~1?Action=CreateTags&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - tags_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTags&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - tags_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTags&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/tagSet/item - openAPIDocKey: '200' - id: aws.ec2.tags - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/tags/methods/tags_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/tags/methods/tags_Create' - select: - - $ref: '#/components/x-stackQL-resources/tags/methods/tags_Describe' - update: [] - title: tags - traffic_mirror_filter_network_services: - name: traffic_mirror_filter_network_services - methods: - traffic_mirror_filter_network_services_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyTrafficMirrorFilterNetworkServices&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.traffic_mirror_filter_network_services - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: traffic_mirror_filter_network_services - traffic_mirror_filter_rule: - name: traffic_mirror_filter_rule - methods: - traffic_mirror_filter_rule_Create: - operation: - $ref: '#/paths/~1?Action=CreateTrafficMirrorFilterRule&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_filter_rule_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTrafficMirrorFilterRule&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_filter_rule_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyTrafficMirrorFilterRule&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.traffic_mirror_filter_rule - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_filter_rule/methods/traffic_mirror_filter_rule_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_filter_rule/methods/traffic_mirror_filter_rule_Create' - select: [] - update: [] - title: traffic_mirror_filter_rule - traffic_mirror_filters: - name: traffic_mirror_filters - methods: - traffic_mirror_filter_Create: - operation: - $ref: '#/paths/~1?Action=CreateTrafficMirrorFilter&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_filter_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTrafficMirrorFilter&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_filters_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTrafficMirrorFilters&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/trafficMirrorFilterSet/item - openAPIDocKey: '200' - id: aws.ec2.traffic_mirror_filters - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_filters/methods/traffic_mirror_filter_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_filters/methods/traffic_mirror_filter_Create' - select: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_filters/methods/traffic_mirror_filters_Describe' - update: [] - title: traffic_mirror_filters - traffic_mirror_sessions: - name: traffic_mirror_sessions - methods: - traffic_mirror_session_Create: - operation: - $ref: '#/paths/~1?Action=CreateTrafficMirrorSession&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_session_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTrafficMirrorSession&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_session_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyTrafficMirrorSession&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_sessions_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTrafficMirrorSessions&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/trafficMirrorSessionSet/item - openAPIDocKey: '200' - id: aws.ec2.traffic_mirror_sessions - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_sessions/methods/traffic_mirror_session_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_sessions/methods/traffic_mirror_session_Create' - select: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_sessions/methods/traffic_mirror_sessions_Describe' - update: [] - title: traffic_mirror_sessions - traffic_mirror_targets: - name: traffic_mirror_targets - methods: - traffic_mirror_target_Create: - operation: - $ref: '#/paths/~1?Action=CreateTrafficMirrorTarget&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_target_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTrafficMirrorTarget&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_targets_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTrafficMirrorTargets&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/trafficMirrorTargetSet/item - openAPIDocKey: '200' - id: aws.ec2.traffic_mirror_targets - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_targets/methods/traffic_mirror_target_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_targets/methods/traffic_mirror_target_Create' - select: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_targets/methods/traffic_mirror_targets_Describe' - update: [] - title: traffic_mirror_targets - transit_gateway_attachment_propagations: - name: transit_gateway_attachment_propagations - methods: - transit_gateway_attachment_propagations_Get: - operation: - $ref: '#/paths/~1?Action=GetTransitGatewayAttachmentPropagations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayAttachmentPropagations/item - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_attachment_propagations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_attachment_propagations/methods/transit_gateway_attachment_propagations_Get' - update: [] - title: transit_gateway_attachment_propagations - transit_gateway_attachments: - name: transit_gateway_attachments - methods: - transit_gateway_attachments_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayAttachments&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayAttachments/item - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_attachments - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_attachments/methods/transit_gateway_attachments_Describe' - update: [] - title: transit_gateway_attachments - transit_gateway_connect_peers: - name: transit_gateway_connect_peers - methods: - transit_gateway_connect_peer_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayConnectPeer&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_connect_peer_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayConnectPeer&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_connect_peers_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayConnectPeers&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayConnectPeerSet/item - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_connect_peers - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connect_peers/methods/transit_gateway_connect_peer_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connect_peers/methods/transit_gateway_connect_peer_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connect_peers/methods/transit_gateway_connect_peers_Describe' - update: [] - title: transit_gateway_connect_peers - transit_gateway_connects: - name: transit_gateway_connects - methods: - transit_gateway_connect_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayConnect&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_connect_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayConnect&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_connects_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayConnects&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayConnectSet/item - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_connects - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/transit_gateway_connect_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/transit_gateway_connect_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/transit_gateway_connects_Describe' - update: [] - title: transit_gateway_connects - transit_gateway_multicast_domain_associations: - name: transit_gateway_multicast_domain_associations - methods: - transit_gateway_multicast_domain_associations_Accept: - operation: - $ref: '#/paths/~1?Action=AcceptTransitGatewayMulticastDomainAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_domain_associations_Get: - operation: - $ref: '#/paths/~1?Action=GetTransitGatewayMulticastDomainAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/multicastDomainAssociations/item - openAPIDocKey: '200' - transit_gateway_multicast_domain_associations_Reject: - operation: - $ref: '#/paths/~1?Action=RejectTransitGatewayMulticastDomainAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_multicast_domain_associations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domain_associations/methods/transit_gateway_multicast_domain_associations_Get' - update: [] - title: transit_gateway_multicast_domain_associations - transit_gateway_multicast_domains: - name: transit_gateway_multicast_domains - methods: - transit_gateway_multicast_domain_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateTransitGatewayMulticastDomain&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_domain_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayMulticastDomain&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_domain_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayMulticastDomain&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_domain_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateTransitGatewayMulticastDomain&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_domains_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayMulticastDomains&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayMulticastDomains/item - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_multicast_domains - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/transit_gateway_multicast_domain_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/transit_gateway_multicast_domain_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/transit_gateway_multicast_domains_Describe' - update: [] - title: transit_gateway_multicast_domains - transit_gateway_multicast_group_members: - name: transit_gateway_multicast_group_members - methods: - transit_gateway_multicast_group_members_Deregister: - operation: - $ref: '#/paths/~1?Action=DeregisterTransitGatewayMulticastGroupMembers&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_group_members_Register: - operation: - $ref: '#/paths/~1?Action=RegisterTransitGatewayMulticastGroupMembers&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_multicast_group_members - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: transit_gateway_multicast_group_members - transit_gateway_multicast_group_sources: - name: transit_gateway_multicast_group_sources - methods: - transit_gateway_multicast_group_sources_Deregister: - operation: - $ref: '#/paths/~1?Action=DeregisterTransitGatewayMulticastGroupSources&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_group_sources_Register: - operation: - $ref: '#/paths/~1?Action=RegisterTransitGatewayMulticastGroupSources&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_multicast_group_sources - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: transit_gateway_multicast_group_sources - transit_gateway_multicast_groups: - name: transit_gateway_multicast_groups - methods: - transit_gateway_multicast_groups_Search: - operation: - $ref: '#/paths/~1?Action=SearchTransitGatewayMulticastGroups&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_multicast_groups - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: transit_gateway_multicast_groups - transit_gateway_peering_attachments: - name: transit_gateway_peering_attachments - methods: - transit_gateway_peering_attachment_Accept: - operation: - $ref: '#/paths/~1?Action=AcceptTransitGatewayPeeringAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_peering_attachment_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayPeeringAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_peering_attachment_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayPeeringAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_peering_attachment_Reject: - operation: - $ref: '#/paths/~1?Action=RejectTransitGatewayPeeringAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_peering_attachments_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayPeeringAttachments&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayPeeringAttachments/item - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_peering_attachments - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/transit_gateway_peering_attachment_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/transit_gateway_peering_attachment_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/transit_gateway_peering_attachments_Describe' - update: [] - title: transit_gateway_peering_attachments - transit_gateway_prefix_list_references: - name: transit_gateway_prefix_list_references - methods: - transit_gateway_prefix_list_reference_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayPrefixListReference&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_prefix_list_reference_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayPrefixListReference&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_prefix_list_reference_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyTransitGatewayPrefixListReference&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_prefix_list_references_Get: - operation: - $ref: '#/paths/~1?Action=GetTransitGatewayPrefixListReferences&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayPrefixListReferenceSet/item - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_prefix_list_references - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_prefix_list_references/methods/transit_gateway_prefix_list_reference_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_prefix_list_references/methods/transit_gateway_prefix_list_reference_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_prefix_list_references/methods/transit_gateway_prefix_list_references_Get' - update: [] - title: transit_gateway_prefix_list_references - transit_gateway_route_table_associations: - name: transit_gateway_route_table_associations - methods: - transit_gateway_route_table_associations_Get: - operation: - $ref: '#/paths/~1?Action=GetTransitGatewayRouteTableAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/associations/item - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_route_table_associations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_associations/methods/transit_gateway_route_table_associations_Get' - update: [] - title: transit_gateway_route_table_associations - transit_gateway_route_table_propagations: - name: transit_gateway_route_table_propagations - methods: - transit_gateway_route_table_propagation_Disable: - operation: - $ref: '#/paths/~1?Action=DisableTransitGatewayRouteTablePropagation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_table_propagation_Enable: - operation: - $ref: '#/paths/~1?Action=EnableTransitGatewayRouteTablePropagation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_table_propagations_Get: - operation: - $ref: '#/paths/~1?Action=GetTransitGatewayRouteTablePropagations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayRouteTablePropagations/item - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_route_table_propagations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_propagations/methods/transit_gateway_route_table_propagations_Get' - update: [] - title: transit_gateway_route_table_propagations - transit_gateway_route_tables: - name: transit_gateway_route_tables - methods: - transit_gateway_route_table_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateTransitGatewayRouteTable&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_table_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayRouteTable&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_table_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayRouteTable&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_table_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateTransitGatewayRouteTable&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_tables_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayRouteTables&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayRouteTables/item - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_route_tables - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/transit_gateway_route_table_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/transit_gateway_route_table_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/transit_gateway_route_tables_Describe' - update: [] - title: transit_gateway_route_tables - transit_gateway_routes: - name: transit_gateway_routes - methods: - transit_gateway_route_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_Replace: - operation: - $ref: '#/paths/~1?Action=ReplaceTransitGatewayRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_routes_Export: - operation: - $ref: '#/paths/~1?Action=ExportTransitGatewayRoutes&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_routes_Search: - operation: - $ref: '#/paths/~1?Action=SearchTransitGatewayRoutes&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_routes - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_routes/methods/transit_gateway_route_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_routes/methods/transit_gateway_route_Create' - select: [] - update: [] - title: transit_gateway_routes - transit_gateway_vpc_attachments: - name: transit_gateway_vpc_attachments - methods: - transit_gateway_vpc_attachment_Accept: - operation: - $ref: '#/paths/~1?Action=AcceptTransitGatewayVpcAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_vpc_attachment_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayVpcAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_vpc_attachment_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayVpcAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_vpc_attachment_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyTransitGatewayVpcAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_vpc_attachment_Reject: - operation: - $ref: '#/paths/~1?Action=RejectTransitGatewayVpcAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_vpc_attachments_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayVpcAttachments&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayVpcAttachments/item - openAPIDocKey: '200' - id: aws.ec2.transit_gateway_vpc_attachments - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/transit_gateway_vpc_attachment_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/transit_gateway_vpc_attachment_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/transit_gateway_vpc_attachments_Describe' - update: [] - title: transit_gateway_vpc_attachments - transit_gateways: - name: transit_gateways - methods: - transit_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyTransitGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2.transit_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/transit_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/transit_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/transit_gateways_Describe' - update: [] - title: transit_gateways - trunk_interface: - name: trunk_interface - methods: - trunk_interface_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateTrunkInterface&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - trunk_interface_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateTrunkInterface&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.trunk_interface - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: trunk_interface - trunk_interface_associations: - name: trunk_interface_associations - methods: - trunk_interface_associations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTrunkInterfaceAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/interfaceAssociationSet/item - openAPIDocKey: '200' - id: aws.ec2.trunk_interface_associations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/trunk_interface_associations/methods/trunk_interface_associations_Describe' - update: [] - title: trunk_interface_associations - vgw_route_propagation: - name: vgw_route_propagation - methods: - vgw_route_propagation_Disable: - operation: - $ref: '#/paths/~1?Action=DisableVgwRoutePropagation&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - vgw_route_propagation_Enable: - operation: - $ref: '#/paths/~1?Action=EnableVgwRoutePropagation&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.vgw_route_propagation - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vgw_route_propagation - volume_attribute: - name: volume_attribute - methods: - volume_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVolumeAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - volume_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVolumeAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.volume_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/volume_attribute/methods/volume_attribute_Describe' - update: [] - title: volume_attribute - volume_i_o: - name: volume_i_o - methods: - volume_i_o_Enable: - operation: - $ref: '#/paths/~1?Action=EnableVolumeIO&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.volume_i_o - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: volume_i_o - volume_status: - name: volume_status - methods: - volume_status_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVolumeStatus&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/volumeStatusSet/item - openAPIDocKey: '200' - id: aws.ec2.volume_status - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/volume_status/methods/volume_status_Describe' - update: [] - title: volume_status - volumes: - name: volumes - methods: - volume_Attach: - operation: - $ref: '#/paths/~1?Action=AttachVolume&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - volume_Create: - operation: - $ref: '#/paths/~1?Action=CreateVolume&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - volume_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVolume&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - volume_Detach: - operation: - $ref: '#/paths/~1?Action=DetachVolume&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - volume_Import: - operation: - $ref: '#/paths/~1?Action=ImportVolume&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - volume_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVolume&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - volumes_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVolumes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/volumeSet/item - openAPIDocKey: '200' - id: aws.ec2.volumes - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/volumes/methods/volume_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/volumes/methods/volume_Create' - select: - - $ref: '#/components/x-stackQL-resources/volumes/methods/volumes_Describe' - update: - - $ref: '#/components/x-stackQL-resources/volumes/methods/volume_Modify' - title: volumes - volumes_modifications: - name: volumes_modifications - methods: - volumes_modifications_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVolumesModifications&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/volumeModificationSet/item - openAPIDocKey: '200' - id: aws.ec2.volumes_modifications - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/volumes_modifications/methods/volumes_modifications_Describe' - update: [] - title: volumes_modifications - vpc_attribute: - name: vpc_attribute - methods: - vpc_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - vpc_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.vpc_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpc_attribute/methods/vpc_attribute_Describe' - update: [] - title: vpc_attribute - vpc_cidr_block: - name: vpc_cidr_block - methods: - vpc_cidr_block_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateVpcCidrBlock&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_cidr_block_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateVpcCidrBlock&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.vpc_cidr_block - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpc_cidr_block - vpc_classic_link: - name: vpc_classic_link - methods: - vpc_classic_link_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcClassicLink&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpcSet/item - openAPIDocKey: '200' - vpc_classic_link_Disable: - operation: - $ref: '#/paths/~1?Action=DisableVpcClassicLink&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_classic_link_Enable: - operation: - $ref: '#/paths/~1?Action=EnableVpcClassicLink&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.vpc_classic_link - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpc_classic_link/methods/vpc_classic_link_Describe' - update: [] - title: vpc_classic_link - vpc_classic_link_dns_support: - name: vpc_classic_link_dns_support - methods: - vpc_classic_link_dns_support_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcClassicLinkDnsSupport&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpcs/item - openAPIDocKey: '200' - vpc_classic_link_dns_support_Disable: - operation: - $ref: '#/paths/~1?Action=DisableVpcClassicLinkDnsSupport&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_classic_link_dns_support_Enable: - operation: - $ref: '#/paths/~1?Action=EnableVpcClassicLinkDnsSupport&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.vpc_classic_link_dns_support - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpc_classic_link_dns_support/methods/vpc_classic_link_dns_support_Describe' - update: [] - title: vpc_classic_link_dns_support - vpc_endpoint_connection_notifications: - name: vpc_endpoint_connection_notifications - methods: - vpc_endpoint_connection_notification_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpcEndpointConnectionNotification&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_connection_notification_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcEndpointConnectionNotification&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_connection_notifications_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpcEndpointConnectionNotifications&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_connection_notifications_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcEndpointConnectionNotifications&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/connectionNotificationSet/item - openAPIDocKey: '200' - id: aws.ec2.vpc_endpoint_connection_notifications - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/vpc_endpoint_connection_notifications_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/vpc_endpoint_connection_notification_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/vpc_endpoint_connection_notifications_Describe' - update: [] - title: vpc_endpoint_connection_notifications - vpc_endpoint_connections: - name: vpc_endpoint_connections - methods: - vpc_endpoint_connections_Accept: - operation: - $ref: '#/paths/~1?Action=AcceptVpcEndpointConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_connections_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcEndpointConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpcEndpointConnectionSet/item - openAPIDocKey: '200' - vpc_endpoint_connections_Reject: - operation: - $ref: '#/paths/~1?Action=RejectVpcEndpointConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.vpc_endpoint_connections - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connections/methods/vpc_endpoint_connections_Describe' - update: [] - title: vpc_endpoint_connections - vpc_endpoint_service_configurations: - name: vpc_endpoint_service_configurations - methods: - vpc_endpoint_service_configuration_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpcEndpointServiceConfiguration&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_service_configuration_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcEndpointServiceConfiguration&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_service_configurations_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpcEndpointServiceConfigurations&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_service_configurations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcEndpointServiceConfigurations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/serviceConfigurationSet/item - openAPIDocKey: '200' - id: aws.ec2.vpc_endpoint_service_configurations - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_configurations/methods/vpc_endpoint_service_configurations_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_configurations/methods/vpc_endpoint_service_configuration_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_configurations/methods/vpc_endpoint_service_configurations_Describe' - update: [] - title: vpc_endpoint_service_configurations - vpc_endpoint_service_payer_responsibility: - name: vpc_endpoint_service_payer_responsibility - methods: - vpc_endpoint_service_payer_responsibility_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcEndpointServicePayerResponsibility&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.vpc_endpoint_service_payer_responsibility - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpc_endpoint_service_payer_responsibility - vpc_endpoint_service_permissions: - name: vpc_endpoint_service_permissions - methods: - vpc_endpoint_service_permissions_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcEndpointServicePermissions&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/allowedPrincipals/item - openAPIDocKey: '200' - vpc_endpoint_service_permissions_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcEndpointServicePermissions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.vpc_endpoint_service_permissions - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_permissions/methods/vpc_endpoint_service_permissions_Describe' - update: [] - title: vpc_endpoint_service_permissions - vpc_endpoint_service_private_dns_verification: - name: vpc_endpoint_service_private_dns_verification - methods: - vpc_endpoint_service_private_dns_verification_Start: - operation: - $ref: '#/paths/~1?Action=StartVpcEndpointServicePrivateDnsVerification&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.vpc_endpoint_service_private_dns_verification - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpc_endpoint_service_private_dns_verification - vpc_endpoint_services: - name: vpc_endpoint_services - methods: - vpc_endpoint_services_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcEndpointServices&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/serviceDetailSet/item - openAPIDocKey: '200' - id: aws.ec2.vpc_endpoint_services - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_services/methods/vpc_endpoint_services_Describe' - update: [] - title: vpc_endpoint_services - vpc_endpoints: - name: vpc_endpoints - methods: - vpc_endpoint_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpcEndpoint&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcEndpoint&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoints_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpcEndpoints&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoints_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcEndpoints&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpcEndpointSet/item - openAPIDocKey: '200' - id: aws.ec2.vpc_endpoints - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/vpc_endpoints_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/vpc_endpoint_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/vpc_endpoints_Describe' - update: [] - title: vpc_endpoints - vpc_peering_connection_options: - name: vpc_peering_connection_options - methods: - vpc_peering_connection_options_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcPeeringConnectionOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.vpc_peering_connection_options - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpc_peering_connection_options - vpc_peering_connections: - name: vpc_peering_connections - methods: - vpc_peering_connection_Accept: - operation: - $ref: '#/paths/~1?Action=AcceptVpcPeeringConnection&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_peering_connection_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpcPeeringConnection&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_peering_connection_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpcPeeringConnection&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_peering_connection_Reject: - operation: - $ref: '#/paths/~1?Action=RejectVpcPeeringConnection&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_peering_connections_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcPeeringConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpcPeeringConnectionSet/item - openAPIDocKey: '200' - id: aws.ec2.vpc_peering_connections - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/vpc_peering_connection_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/vpc_peering_connection_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/vpc_peering_connections_Describe' - update: [] - title: vpc_peering_connections - vpc_tenancy: - name: vpc_tenancy - methods: - vpc_tenancy_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcTenancy&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.vpc_tenancy - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpc_tenancy - vpcs: - name: vpcs - methods: - vpc_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpc&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpc&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - vpcs_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpcSet/item - openAPIDocKey: '200' - id: aws.ec2.vpcs - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpcs/methods/vpc_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpcs/methods/vpc_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpcs/methods/vpcs_Describe' - update: [] - title: vpcs - vpn_connection_device_sample_configuration: - name: vpn_connection_device_sample_configuration - methods: - vpn_connection_device_sample_configuration_Get: - operation: - $ref: '#/paths/~1?Action=GetVpnConnectionDeviceSampleConfiguration&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2.vpn_connection_device_sample_configuration - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpn_connection_device_sample_configuration/methods/vpn_connection_device_sample_configuration_Get' - update: [] - title: vpn_connection_device_sample_configuration - vpn_connection_device_types: - name: vpn_connection_device_types - methods: - vpn_connection_device_types_Get: - operation: - $ref: '#/paths/~1?Action=GetVpnConnectionDeviceTypes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpnConnectionDeviceTypeSet/item - openAPIDocKey: '200' - id: aws.ec2.vpn_connection_device_types - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpn_connection_device_types/methods/vpn_connection_device_types_Get' - update: [] - title: vpn_connection_device_types - vpn_connection_options: - name: vpn_connection_options - methods: - vpn_connection_options_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpnConnectionOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.vpn_connection_options - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpn_connection_options - vpn_connection_route: - name: vpn_connection_route - methods: - vpn_connection_route_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpnConnectionRoute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - vpn_connection_route_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpnConnectionRoute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2.vpn_connection_route - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpn_connection_route/methods/vpn_connection_route_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpn_connection_route/methods/vpn_connection_route_Create' - select: [] - update: [] - title: vpn_connection_route - vpn_connections: - name: vpn_connections - methods: - vpn_connection_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpnConnection&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpn_connection_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpnConnection&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - vpn_connection_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpnConnection&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpn_connections_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpnConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpnConnectionSet/item - openAPIDocKey: '200' - id: aws.ec2.vpn_connections - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/vpn_connection_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/vpn_connection_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/vpn_connections_Describe' - update: [] - title: vpn_connections - vpn_gateways: - name: vpn_gateways - methods: - vpn_gateway_Attach: - operation: - $ref: '#/paths/~1?Action=AttachVpnGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpn_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpnGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpn_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpnGateway&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - vpn_gateway_Detach: - operation: - $ref: '#/paths/~1?Action=DetachVpnGateway&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - vpn_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpnGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpnGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2.vpn_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/vpn_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/vpn_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/vpn_gateways_Describe' - update: [] - title: vpn_gateways - vpn_tunnel_certificate: - name: vpn_tunnel_certificate - methods: - vpn_tunnel_certificate_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpnTunnelCertificate&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.vpn_tunnel_certificate - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpn_tunnel_certificate - vpn_tunnel_options: - name: vpn_tunnel_options - methods: - vpn_tunnel_options_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpnTunnelOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2.vpn_tunnel_options - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpn_tunnel_options - parameters: - X-Amz-Content-Sha256: - name: X-Amz-Content-Sha256 - in: header - schema: - type: string - required: false - X-Amz-Date: - name: X-Amz-Date - in: header - schema: - type: string - required: false - X-Amz-Algorithm: - name: X-Amz-Algorithm - in: header - schema: - type: string - required: false - X-Amz-Credential: - name: X-Amz-Credential - 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-Signature: - name: X-Amz-Signature - in: header - schema: - type: string - required: false - X-Amz-SignedHeaders: - name: X-Amz-SignedHeaders - in: header - schema: - type: string - required: false - securitySchemes: - hmac: - type: apiKey - name: Authorization - in: header - description: Amazon Signature authorization v4 - x-amazon-apigateway-authtype: awsSigv4 - schemas: - AcceptReservedInstancesExchangeQuoteResult: - type: object - properties: - exchangeId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the successful exchange. - description: The result of the exchange and whether it wassuccessful.
- ReservationId:
- type: string
- TargetConfigurationRequest:
- type: object
- required:
- - OfferingId
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesOfferingId'
- - description: The Convertible Reserved Instance offering ID.
- description: Details about the target configuration.
- AcceptTransitGatewayMulticastDomainAssociationsResult:
- type: object
- properties:
- associations:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
- String:
- type: string
- AcceptTransitGatewayPeeringAttachmentResult:
- type: object
- properties:
- transitGatewayPeeringAttachment:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
- - description: The transit gateway peering attachment.
- AcceptTransitGatewayVpcAttachmentResult:
- type: object
- properties:
- transitGatewayVpcAttachment:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- - description: The VPC attachment.
- AcceptVpcEndpointConnectionsResult:
- type: object
- properties:
- unsuccessful:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulItemSet'
- - description: 'Information about the interface endpoints that were not accepted, if applicable.'
- VpcEndpointId:
- type: string
- AcceptVpcPeeringConnectionResult:
- type: object
- properties:
- vpcPeeringConnection:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnection'
- - description: Information about the VPC peering connection.
- AdvertiseByoipCidrResult:
- type: object
- properties:
- byoipCidr:
- allOf:
- - $ref: '#/components/schemas/ByoipCidr'
- - description: Information about the address range.
- AllocateAddressResult:
- type: object
- example:
- Domain: standard
- PublicIp: 198.51.100.0
- properties:
- publicIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Elastic IP address.
- allocationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: '[EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.'
- publicIpv4Pool:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of an address pool.
- networkBorderGroup:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.'
- domain:
- allOf:
- - $ref: '#/components/schemas/DomainType'
- - description: Indicates whether the Elastic IP address is for use with instances in a VPC (vpc) or instances in EC2-Classic (standard).
- customerOwnedIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The customer-owned IP address.
- customerOwnedIpv4Pool:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the customer-owned address pool.
- carrierIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The carrier IP address. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). '
- TagSpecification:
- type: object
- properties:
- resourceType:
- allOf:
- - $ref: '#/components/schemas/ResourceType'
- - description: The type of resource to tag on creation.
- Tag:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags to apply to the resource.
- description: The tags to apply to a resource when the resource is being created.
- AllocateHostsResult:
- type: object
- properties:
- hostIdSet:
- allOf:
- - $ref: '#/components/schemas/ResponseHostIdList'
- - description: The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.
- description: Contains the output of AllocateHosts.
- AllocateIpamPoolCidrResult:
- type: object
- properties:
- ipamPoolAllocation:
- allOf:
- - $ref: '#/components/schemas/IpamPoolAllocation'
- - description: Information about the allocation created.
- ApplySecurityGroupsToClientVpnTargetNetworkResult:
- type: object
- properties:
- securityGroupIds:
- allOf:
- - $ref: '#/components/schemas/ClientVpnSecurityGroupIdSet'
- - description: The IDs of the applied security groups.
- SecurityGroupId:
- type: string
- AssignIpv6AddressesResult:
- type: object
- properties:
- assignedIpv6Addresses:
- allOf:
- - $ref: '#/components/schemas/Ipv6AddressList'
- - description: The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses that were assigned to the network interface before the request are not included.
- assignedIpv6PrefixSet:
- allOf:
- - $ref: '#/components/schemas/IpPrefixList'
- - description: The IPv6 prefixes that are assigned to the network interface.
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network interface.
- AssignPrivateIpAddressesResult:
- type: object
- properties:
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network interface.
- assignedPrivateIpAddressesSet:
- allOf:
- - $ref: '#/components/schemas/AssignedPrivateIpAddressList'
- - description: The private IP addresses assigned to the network interface.
- assignedIpv4PrefixSet:
- allOf:
- - $ref: '#/components/schemas/Ipv4PrefixesList'
- - description: The IPv4 prefixes that are assigned to the network interface.
- AssociateAddressResult:
- type: object
- example:
- AssociationId: eipassoc-2bebb745
- properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: '[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.'
- AssociateClientVpnTargetNetworkResult:
- type: object
- properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The unique ID of the target network association.
- status:
- allOf:
- - $ref: '#/components/schemas/AssociationStatus'
- - description: The current state of the target network association.
- AssociateEnclaveCertificateIamRoleResult:
- type: object
- properties:
- certificateS3BucketName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the Amazon S3 bucket to which the certificate was uploaded.
- certificateS3ObjectKey:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The object key is formatted as follows: role_arn/certificate_arn.'
- encryptionKmsKeyId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the KMS key used to encrypt the private key of the certificate.
- AssociateIamInstanceProfileResult:
- type: object
- example:
- IamInstanceProfileAssociation:
- AssociationId: iip-assoc-0e7736511a163c209
- IamInstanceProfile:
- Arn: 'arn:aws:iam::123456789012:instance-profile/admin-role'
- Id: AIPAJBLK7RKJKWDXVHIEC
- InstanceId: i-123456789abcde123
- State: associating
- properties:
- iamInstanceProfileAssociation:
- allOf:
- - $ref: '#/components/schemas/IamInstanceProfileAssociation'
- - description: Information about the IAM instance profile association.
- AssociateInstanceEventWindowResult:
- type: object
- properties:
- instanceEventWindow:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindow'
- - description: Information about the event window.
- InstanceIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - xml:
- name: item
- TagList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Tag'
- - xml:
- name: item
- DedicatedHostIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DedicatedHostId'
- - xml:
- name: item
- AssociateRouteTableResult:
- type: object
- example:
- AssociationId: rtbassoc-781d0d1a
- properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The route table association ID. This ID is required for disassociating the route table.
- associationState:
- allOf:
- - $ref: '#/components/schemas/RouteTableAssociationState'
- - description: The state of the association.
- AssociateSubnetCidrBlockResult:
- type: object
- properties:
- ipv6CidrBlockAssociation:
- allOf:
- - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation'
- - description: Information about the IPv6 association.
- subnetId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the subnet.
- AssociateTransitGatewayMulticastDomainResult:
- type: object
- properties:
- associations:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
- - description: Information about the transit gateway multicast domain associations.
- SubnetId:
- type: string
- AssociateTransitGatewayRouteTableResult:
- type: object
- properties:
- association:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAssociation'
- - description: The ID of the association.
- AssociateTrunkInterfaceResult:
- type: object
- properties:
- interfaceAssociation:
- allOf:
- - $ref: '#/components/schemas/TrunkInterfaceAssociation'
- - description: Information about the association between the trunk network interface and branch network interface.
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.'
- AssociateVpcCidrBlockResult:
- type: object
- properties:
- ipv6CidrBlockAssociation:
- allOf:
- - $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation'
- - description: Information about the IPv6 CIDR block association.
- cidrBlockAssociation:
- allOf:
- - $ref: '#/components/schemas/VpcCidrBlockAssociation'
- - description: Information about the IPv4 CIDR block association.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- AttachClassicLinkVpcResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- AttachNetworkInterfaceResult:
- type: object
- example:
- AttachmentId: eni-attach-66c4350a
- properties:
- attachmentId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network interface attachment.
- networkCardIndex:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The index of the network card.
- description: Contains the output of AttachNetworkInterface.
- VolumeAttachment:
- type: object
- example:
- AttachTime: '2014-02-27T19:23:06.000Z'
- Device: /dev/sdb
- InstanceId: i-1234567890abcdef0
- State: detaching
- VolumeId: vol-049df61146c4d7901
- properties:
- attachTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time stamp when the attachment initiated.
- device:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The device name.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance.
- status:
- allOf:
- - $ref: '#/components/schemas/VolumeAttachmentState'
- - description: The attachment state of the volume.
- volumeId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the volume.
- deleteOnTermination:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the EBS volume is deleted on instance termination.
- description: Describes volume attachment details.
- AttachVpnGatewayResult:
- type: object
- properties:
- attachment:
- allOf:
- - $ref: '#/components/schemas/VpcAttachment'
- - description: Information about the attachment.
- description: Contains the output of AttachVpnGateway.
- AuthorizeClientVpnIngressResult:
- type: object
- properties:
- status:
- allOf:
- - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus'
- - description: The current state of the authorization rule.
- AuthorizeSecurityGroupEgressResult:
- type: object
- example: {}
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, returns an error.'
- securityGroupRuleSet:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRuleList'
- - description: Information about the outbound (egress) security group rules that were added.
- IpPermission:
- type: object
- properties:
- fromPort:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.'
- ipProtocol:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
-1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.'
- groups:
- allOf:
- - $ref: '#/components/schemas/UserIdGroupPairList'
- - description: The security group and Amazon Web Services account ID pairs.
- description: Describes a set of permissions for a security group rule.
- AuthorizeSecurityGroupIngressResult:
- type: object
- example: {}
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, returns an error.'
- securityGroupRuleSet:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRuleList'
- - description: Information about the inbound (ingress) security group rules that were added.
- BundleInstanceResult:
- type: object
- properties:
- bundleInstanceTask:
- allOf:
- - $ref: '#/components/schemas/BundleTask'
- - description: Information about the bundle task.
- description: Contains the output of BundleInstance.
- S3Storage:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing Amazon Web Services Access Keys.'
- bucket:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.'
- prefix:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The beginning of the file name of the AMI.
- uploadPolicy:
- allOf:
- - $ref: '#/components/schemas/Blob'
- - description: An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
- uploadPolicySignature:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The signature of the JSON document.
- description: Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed AMI.
- CancelBundleTaskResult:
- type: object
- properties:
- bundleInstanceTask:
- allOf:
- - $ref: '#/components/schemas/BundleTask'
- - description: Information about the bundle task.
- description: Contains the output of CancelBundleTask.
- CancelCapacityReservationResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- CancelCapacityReservationFleetsResult:
- type: object
- properties:
- successfulFleetCancellationSet:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationFleetCancellationStateSet'
- - description: Information about the Capacity Reservation Fleets that were successfully cancelled.
- failedFleetCancellationSet:
- allOf:
- - $ref: '#/components/schemas/FailedCapacityReservationFleetCancellationResultSet'
- - description: Information about the Capacity Reservation Fleets that could not be cancelled.
- CapacityReservationFleetId:
- type: string
- CancelImportTaskResult:
- type: object
- properties:
- importTaskId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the task being canceled.
- previousState:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The current state of the task being canceled.
- state:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The current state of the task being canceled.
- CancelReservedInstancesListingResult:
- type: object
- properties:
- reservedInstancesListingsSet:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesListingList'
- - description: The Reserved Instance listing.
- description: Contains the output of CancelReservedInstancesListing.
- CancelSpotFleetRequestsResponse:
- type: object
- example:
- SuccessfulFleetRequests:
- - CurrentSpotFleetRequestState: cancelled_terminating
- PreviousSpotFleetRequestState: active
- SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
- properties:
- successfulFleetRequestSet:
- allOf:
- - $ref: '#/components/schemas/CancelSpotFleetRequestsSuccessSet'
- - description: Information about the Spot Fleet requests that are successfully canceled.
- unsuccessfulFleetRequestSet:
- allOf:
- - $ref: '#/components/schemas/CancelSpotFleetRequestsErrorSet'
- - description: Information about the Spot Fleet requests that are not successfully canceled.
- description: Contains the output of CancelSpotFleetRequests.
- SpotFleetRequestId:
- type: string
- CancelSpotInstanceRequestsResult:
- type: object
- example:
- CancelledSpotInstanceRequests:
- - SpotInstanceRequestId: sir-08b93456
- State: cancelled
- properties:
- spotInstanceRequestSet:
- allOf:
- - $ref: '#/components/schemas/CancelledSpotInstanceRequestList'
- - description: One or more Spot Instance requests.
- description: Contains the output of CancelSpotInstanceRequests.
- SpotInstanceRequestId:
- type: string
- ConfirmProductInstanceResult:
- type: object
- example:
- OwnerId: '123456789012'
- properties:
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID of the instance owner. This is only present if the product code is attached to the instance.
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.
- CopyFpgaImageResult:
- type: object
- properties:
- fpgaImageId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the new AFI.
- CopyImageResult:
- type: object
- example:
- ImageId: ami-438bea42
- properties:
- imageId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the new AMI.
- description: Contains the output of CopyImage.
- CopySnapshotResult:
- type: object
- example:
- SnapshotId: snap-066877671789bd71b
- properties:
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the new snapshot.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags applied to the new snapshot.
- CreateCapacityReservationResult:
- type: object
- properties:
- capacityReservation:
- allOf:
- - $ref: '#/components/schemas/CapacityReservation'
- - description: Information about the Capacity Reservation.
- CreateCapacityReservationFleetResult:
- type: object
- properties:
- capacityReservationFleetId:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationFleetId'
- - description: The ID of the Capacity Reservation Fleet.
- state:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationFleetState'
- - description: The status of the Capacity Reservation Fleet.
- totalTargetCapacity:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.
- totalFulfilledCapacity:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: The requested capacity units that have been successfully reserved.
- instanceMatchCriteria:
- allOf:
- - $ref: '#/components/schemas/FleetInstanceMatchCriteria'
- - description: The instance matching criteria for the Capacity Reservation Fleet.
- allocationStrategy:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The allocation strategy used by the Capacity Reservation Fleet.
- createTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The date and time at which the Capacity Reservation Fleet was created.
- endDate:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The date and time at which the Capacity Reservation Fleet expires.
- tenancy:
- allOf:
- - $ref: '#/components/schemas/FleetCapacityReservationTenancy'
- - description: Indicates the tenancy of Capacity Reservation Fleet.
- fleetCapacityReservationSet:
- allOf:
- - $ref: '#/components/schemas/FleetCapacityReservationSet'
- - description: Information about the individual Capacity Reservations in the Capacity Reservation Fleet.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the Capacity Reservation Fleet.
- ReservationFleetInstanceSpecification:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/IntegerWithConstraints'
- - description: 'The priority to assign to the instance type. This value is used to determine which of the instance types specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more information, see Instance type priority in the Amazon EC2 User Guide.'
- description: Information about an instance type to use in a Capacity Reservation Fleet.
- CreateCarrierGatewayResult:
- type: object
- properties:
- carrierGateway:
- allOf:
- - $ref: '#/components/schemas/CarrierGateway'
- - description: Information about the carrier gateway.
- CreateClientVpnEndpointResult:
- type: object
- properties:
- clientVpnEndpointId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Client VPN endpoint.
- status:
- allOf:
- - $ref: '#/components/schemas/ClientVpnEndpointStatus'
- - description: The current state of the Client VPN endpoint.
- dnsName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The DNS name to be used by clients when establishing their VPN session.
- ClientVpnAuthenticationRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/FederatedAuthenticationRequest'
- - description: 'Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.'
- description: 'Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.'
- CreateClientVpnRouteResult:
- type: object
- properties:
- status:
- allOf:
- - $ref: '#/components/schemas/ClientVpnRouteStatus'
- - description: The current state of the route.
- CreateCustomerGatewayResult:
- type: object
- example:
- CustomerGateway:
- BgpAsn: '65534'
- CustomerGatewayId: cgw-0e11f167
- IpAddress: 12.1.2.3
- State: available
- Type: ipsec.1
- properties:
- customerGateway:
- allOf:
- - $ref: '#/components/schemas/CustomerGateway'
- - description: Information about the customer gateway.
- description: Contains the output of CreateCustomerGateway.
- CreateDefaultSubnetResult:
- type: object
- properties:
- subnet:
- allOf:
- - $ref: '#/components/schemas/Subnet'
- - description: Information about the subnet.
- CreateDefaultVpcResult:
- type: object
- properties:
- vpc:
- allOf:
- - $ref: '#/components/schemas/Vpc'
- - description: Information about the VPC.
- CreateDhcpOptionsResult:
- type: object
- example:
- DhcpOptions:
- DhcpConfigurations:
- - Key: domain-name-servers
- Values:
- - Value: 10.2.5.2
- - Value: 10.2.5.1
- DhcpOptionsId: dopt-d9070ebb
- properties:
- dhcpOptions:
- allOf:
- - $ref: '#/components/schemas/DhcpOptions'
- - description: A set of DHCP options.
- NewDhcpConfiguration:
- type: object
- properties:
- key:
- $ref: '#/components/schemas/String'
- Value:
- $ref: '#/components/schemas/ValueStringList'
- CreateEgressOnlyInternetGatewayResult:
- type: object
- properties:
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
- egressOnlyInternetGateway:
- allOf:
- - $ref: '#/components/schemas/EgressOnlyInternetGateway'
- - description: Information about the egress-only internet gateway.
- CreateFleetResult:
- type: object
- properties:
- fleetId:
- allOf:
- - $ref: '#/components/schemas/FleetId'
- - description: The ID of the EC2 Fleet.
- errorSet:
- allOf:
- - $ref: '#/components/schemas/CreateFleetErrorsSet'
- - description: Information about the instances that could not be launched by the fleet. Supported only for fleets of type instant.
- fleetInstanceSet:
- allOf:
- - $ref: '#/components/schemas/CreateFleetInstancesSet'
- - description: Information about the instances that were launched by the fleet. Supported only for fleets of type instant.
- FleetLaunchTemplateConfigRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/FleetLaunchTemplateOverridesListRequest'
- - description: 'Any parameters that you specify override the same parameters in the launch template.
For fleets of type request and maintain, a maximum of 300 items is allowed across all launch templates.
/dev/sdh or xvdh).'
- virtualName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
' - ebs: - allOf: - - $ref: '#/components/schemas/EbsBlockDevice' - - description: Parameters used to automatically set up EBS volumes when the instance is launched. - noDevice: - allOf: - - $ref: '#/components/schemas/String' - - description: 'To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.' - description: 'Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.' - CreateInstanceEventWindowResult: - type: object - properties: - instanceEventWindow: - allOf: - - $ref: '#/components/schemas/InstanceEventWindow' - - description: Information about the event window. - InstanceEventWindowTimeRangeRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Hour' - - description: The hour when the time range ends. - description: 'The start day and time and the end day and time of the time range, in UTC.' - CreateInstanceExportTaskResult: - type: object - properties: - exportTask: - allOf: - - $ref: '#/components/schemas/ExportTask' - - description: Information about the export instance task. - ContainerFormat: - type: string - enum: - - ova - DiskImageFormat: - type: string - enum: - - VMDK - - RAW - - VHD - CreateInternetGatewayResult: - type: object - example: - InternetGateway: - Attachments: [] - InternetGatewayId: igw-c0a643a9 - Tags: [] - properties: - internetGateway: - allOf: - - $ref: '#/components/schemas/InternetGateway' - - description: Information about the internet gateway. - CreateIpamResult: - type: object - properties: - ipam: - allOf: - - $ref: '#/components/schemas/Ipam' - - description: Information about the IPAM created. - AddIpamOperatingRegion: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the operating Region. - description: 'Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' - CreateIpamPoolResult: - type: object - properties: - ipamPool: - allOf: - - $ref: '#/components/schemas/IpamPool' - - description: Information about the IPAM pool created. - RequestIpamResourceTag: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The value for the tag. - description: A tag on an IPAM resource. - CreateIpamScopeResult: - type: object - properties: - ipamScope: - allOf: - - $ref: '#/components/schemas/IpamScope' - - description: Information about the created scope. - KeyPair: - type: object - properties: - keyFingerprint: - allOf: - - $ref: '#/components/schemas/String' - - description: 'For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.'
- LaunchTemplateInstanceMaintenanceOptionsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateAutoRecoveryState'
- - description: 'Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.'
- description: The maintenance options of your instance.
- CreateLaunchTemplateVersionResult:
- type: object
- example:
- LaunchTemplateVersion:
- CreateTime: '2017-12-01T13:35:46.000Z'
- CreatedBy: 'arn:aws:iam::123456789012:root'
- DefaultVersion: false
- LaunchTemplateData:
- ImageId: ami-c998b6b2
- InstanceType: t2.micro
- NetworkInterfaces:
- - AssociatePublicIpAddress: true
- DeviceIndex: 0
- Ipv6Addresses:
- - Ipv6Address: '2001:db8:1234:1a00::123'
- SubnetId: subnet-7b16de0c
- LaunchTemplateId: lt-0abcd290751193123
- LaunchTemplateName: my-template
- VersionDescription: WebVersion2
- VersionNumber: 2
- properties:
- launchTemplateVersion:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateVersion'
- - description: Information about the launch template version.
- warning:
- allOf:
- - $ref: '#/components/schemas/ValidationWarning'
- - description: 'If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that''s found.'
- CreateLocalGatewayRouteResult:
- type: object
- properties:
- route:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRoute'
- - description: Information about the route.
- CreateLocalGatewayRouteTableVpcAssociationResult:
- type: object
- properties:
- localGatewayRouteTableVpcAssociation:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociation'
- - description: Information about the association.
- CreateManagedPrefixListResult:
- type: object
- properties:
- prefixList:
- allOf:
- - $ref: '#/components/schemas/ManagedPrefixList'
- - description: Information about the prefix list.
- AddPrefixListEntry:
- type: object
- required:
- - Cidr
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A description for the entry.
Constraints: Up to 255 characters in length.
' - description: An entry for a prefix list. - CreateNatGatewayResult: - type: object - example: - NatGateway: - CreateTime: '2015-12-17T12:45:26.732Z' - NatGatewayAddresses: - - AllocationId: eipalloc-37fc1a52 - NatGatewayId: nat-08d48af2a8e83edfd - State: pending - SubnetId: subnet-1a2b3c4d - VpcId: vpc-1122aabb - properties: - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.' - natGateway: - allOf: - - $ref: '#/components/schemas/NatGateway' - - description: Information about the NAT gateway. - CreateNetworkAclResult: - type: object - example: - NetworkAcl: - Associations: [] - Entries: - - CidrBlock: 0.0.0.0/0 - Egress: true - Protocol: '-1' - RuleAction: deny - RuleNumber: 32767 - - CidrBlock: 0.0.0.0/0 - Egress: false - Protocol: '-1' - RuleAction: deny - RuleNumber: 32767 - IsDefault: false - NetworkAclId: acl-5fb85d36 - Tags: [] - VpcId: vpc-a01106c2 - properties: - networkAcl: - allOf: - - $ref: '#/components/schemas/NetworkAcl' - - description: Information about the network ACL. - Integer: - type: integer - CreateNetworkInsightsAccessScopeResult: - type: object - properties: - networkInsightsAccessScope: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScope' - - description: The Network Access Scope. - networkInsightsAccessScopeContent: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeContent' - - description: The Network Access Scope content. - AccessScopePathRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/PathStatementRequest' - - description: The destination. - ThroughResource: - allOf: - - $ref: '#/components/schemas/ThroughResourcesStatementRequestList' - - description: The through resources. - description: Describes a path. - CreateNetworkInsightsPathResult: - type: object - properties: - networkInsightsPath: - allOf: - - $ref: '#/components/schemas/NetworkInsightsPath' - - description: Information about the path. - CreateNetworkInterfaceResult: - type: object - example: - NetworkInterface: - AvailabilityZone: us-east-1d - Description: my network interface - Groups: - - GroupId: sg-903004f8 - GroupName: default - MacAddress: '02:1a:80:41:52:9c' - NetworkInterfaceId: eni-e5aa89a3 - OwnerId: '123456789012' - PrivateIpAddress: 10.0.2.17 - PrivateIpAddresses: - - Primary: true - PrivateIpAddress: 10.0.2.17 - RequesterManaged: false - SourceDestCheck: true - Status: pending - SubnetId: subnet-9d4a7b6c - TagSet: [] - VpcId: vpc-a01106c2 - properties: - networkInterface: - allOf: - - $ref: '#/components/schemas/NetworkInterface' - - description: Information about the network interface. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value isnull when there are no more results to return.
- description: Contains the output of CreateNetworkInterface.
- InstanceIpv6Address:
- type: object
- properties:
- ipv6Address:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 address.
- description: Describes an IPv6 address.
- PrivateIpAddressSpecification:
- type: object
- properties:
- primary:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
- privateIpAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The private IPv4 addresses.
- description: Describes a secondary private IPv4 address for a network interface.
- Ipv4PrefixSpecificationRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.'
- description: Describes the IPv4 prefix option for a network interface.
- Ipv6PrefixSpecificationRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 prefix.
- description: Describes the IPv4 prefix option for a network interface.
- CreateNetworkInterfacePermissionResult:
- type: object
- properties:
- interfacePermission:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfacePermission'
- - description: Information about the permission for the network interface.
- description: Contains the output of CreateNetworkInterfacePermission.
- CreatePlacementGroupResult:
- type: object
- example: {}
- properties:
- placementGroup:
- $ref: '#/components/schemas/PlacementGroup'
- CreatePublicIpv4PoolResult:
- type: object
- properties:
- poolId:
- allOf:
- - $ref: '#/components/schemas/Ipv4PoolEc2Id'
- - description: The ID of the public IPv4 pool.
- CreateReplaceRootVolumeTaskResult:
- type: object
- properties:
- replaceRootVolumeTask:
- allOf:
- - $ref: '#/components/schemas/ReplaceRootVolumeTask'
- - description: Information about the root volume replacement task.
- CreateReservedInstancesListingResult:
- type: object
- properties:
- reservedInstancesListingsSet:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesListingList'
- - description: Information about the Standard Reserved Instance listing.
- description: Contains the output of CreateReservedInstancesListing.
- PriceScheduleSpecification:
- type: object
- properties:
- currencyCode:
- allOf:
- - $ref: '#/components/schemas/CurrencyCodeValues'
- - description: 'The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.'
- price:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: The fixed price for the term.
- term:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: 'The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.'
- description: Describes the price for a Reserved Instance.
- CreateRestoreImageTaskResult:
- type: object
- properties:
- imageId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The AMI ID.
- CreateRouteResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- CreateRouteTableResult:
- type: object
- example:
- RouteTable:
- Associations: []
- PropagatingVgws: []
- RouteTableId: rtb-22574640
- Routes:
- - DestinationCidrBlock: 10.0.0.0/16
- GatewayId: local
- State: active
- Tags: []
- VpcId: vpc-a01106c2
- properties:
- routeTable:
- allOf:
- - $ref: '#/components/schemas/RouteTable'
- - description: Information about the route table.
- CreateSecurityGroupResult:
- type: object
- example:
- GroupId: sg-903004f8
- properties:
- groupId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the security group.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the security group.
- Snapshot:
- type: object
- example:
- Description: This is my root volume snapshot.
- OwnerId: 012345678910
- SnapshotId: snap-066877671789bd71b
- StartTime: '2014-02-28T21:06:01.000Z'
- State: pending
- Tags: []
- VolumeId: vol-1234567890abcdef0
- VolumeSize: 8
- properties:
- dataEncryptionKeyId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.'
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description for the snapshot.
- encrypted:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the snapshot is encrypted.
- kmsKeyId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the EBS snapshot.
- progress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The progress of the snapshot, as a percentage.'
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
- startTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time stamp when the snapshot was initiated.
- status:
- allOf:
- - $ref: '#/components/schemas/SnapshotState'
- - description: The snapshot state.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.'
- volumeId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
- volumeSize:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The size of the volume, in GiB.'
- ownerAlias:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.'
- outpostArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.'
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the snapshot.
- storageTier:
- allOf:
- - $ref: '#/components/schemas/StorageTier'
- - description: The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
- restoreExpiryTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
- description: Describes a snapshot.
- CreateSnapshotsResult:
- type: object
- properties:
- snapshotSet:
- allOf:
- - $ref: '#/components/schemas/SnapshotSet'
- - description: List of snapshots.
- CreateSpotDatafeedSubscriptionResult:
- type: object
- example:
- SpotDatafeedSubscription:
- Bucket: my-s3-bucket
- OwnerId: '123456789012'
- Prefix: spotdata
- State: Active
- properties:
- spotDatafeedSubscription:
- allOf:
- - $ref: '#/components/schemas/SpotDatafeedSubscription'
- - description: The Spot Instance data feed subscription.
- description: Contains the output of CreateSpotDatafeedSubscription.
- CreateStoreImageTaskResult:
- type: object
- properties:
- objectKey:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the stored AMI object in the S3 bucket.
- S3ObjectTag:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The value of the tag.
Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in length.
' - description: 'The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. For more information, see Categorizing your storage using tags in the Amazon Simple Storage Service User Guide.' - CreateSubnetResult: - type: object - example: - Subnet: - AvailabilityZone: us-west-2c - AvailableIpAddressCount: 251 - CidrBlock: 10.0.1.0/24 - State: pending - SubnetId: subnet-9d4a7b6c - VpcId: vpc-a01106c2 - properties: - subnet: - allOf: - - $ref: '#/components/schemas/Subnet' - - description: Information about the subnet. - CreateSubnetCidrReservationResult: - type: object - properties: - subnetCidrReservation: - allOf: - - $ref: '#/components/schemas/SubnetCidrReservation' - - description: Information about the created subnet CIDR reservation. - TaggableResourceId: - type: string - Tag: - type: object - properties: - key: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
' - description: Describes a tag. - CreateTrafficMirrorFilterResult: - type: object - properties: - trafficMirrorFilter: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilter' - - description: Information about the Traffic Mirror filter. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - CreateTrafficMirrorFilterRuleResult: - type: object - properties: - trafficMirrorFilterRule: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilterRule' - - description: The Traffic Mirror rule. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - CreateTrafficMirrorSessionResult: - type: object - properties: - trafficMirrorSession: - allOf: - - $ref: '#/components/schemas/TrafficMirrorSession' - - description: Information about the Traffic Mirror session. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - CreateTrafficMirrorTargetResult: - type: object - properties: - trafficMirrorTarget: - allOf: - - $ref: '#/components/schemas/TrafficMirrorTarget' - - description: Information about the Traffic Mirror target. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - CreateTransitGatewayResult: - type: object - properties: - transitGateway: - allOf: - - $ref: '#/components/schemas/TransitGateway' - - description: Information about the transit gateway. - TransitGatewayCidrBlockStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - CreateTransitGatewayConnectResult: - type: object - properties: - transitGatewayConnect: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnect' - - description: Information about the Connect attachment. - ProtocolValue: - type: string - enum: - - gre - CreateTransitGatewayConnectPeerResult: - type: object - properties: - transitGatewayConnectPeer: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectPeer' - - description: Information about the Connect peer. - Long: - type: integer - CreateTransitGatewayMulticastDomainResult: - type: object - properties: - transitGatewayMulticastDomain: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomain' - - description: Information about the transit gateway multicast domain. - AutoAcceptSharedAssociationsValue: - type: string - enum: - - enable - - disable - CreateTransitGatewayPeeringAttachmentResult: - type: object - properties: - transitGatewayPeeringAttachment: - allOf: - - $ref: '#/components/schemas/TransitGatewayPeeringAttachment' - - description: The transit gateway peering attachment. - CreateTransitGatewayPrefixListReferenceResult: - type: object - properties: - transitGatewayPrefixListReference: - allOf: - - $ref: '#/components/schemas/TransitGatewayPrefixListReference' - - description: Information about the prefix list reference. - CreateTransitGatewayRouteResult: - type: object - properties: - route: - allOf: - - $ref: '#/components/schemas/TransitGatewayRoute' - - description: Information about the route. - CreateTransitGatewayRouteTableResult: - type: object - properties: - transitGatewayRouteTable: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTable' - - description: Information about the transit gateway route table. - CreateTransitGatewayVpcAttachmentResult: - type: object - properties: - transitGatewayVpcAttachment: - allOf: - - $ref: '#/components/schemas/TransitGatewayVpcAttachment' - - description: Information about the VPC attachment. - ApplianceModeSupportValue: - type: string - enum: - - enable - - disable - Volume: - type: object - example: - Attachments: [] - AvailabilityZone: us-east-1a - CreateTime: '2016-08-29T18:52:32.724Z' - Iops: 1000 - Size: 500 - SnapshotId: snap-066877671789bd71b - State: creating - Tags: [] - VolumeId: vol-1234567890abcdef0 - VolumeType: io1 - properties: - attachmentSet: - allOf: - - $ref: '#/components/schemas/VolumeAttachmentList' - - description: Information about the volume attachments. - AvailabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone for the volume. - - xml: - name: 'availabilityZone' - createTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time stamp when volume creation was initiated. - encrypted: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the volume is encrypted. - kmsKeyId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume. - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Outpost. - size: - # allOf: - # - $ref: '#/components/schemas/Integer' - # - description: 'The size of the volume, in GiBs.' - type: integer - description: 'The size of the volume, in GiBs.' - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The snapshot from which the volume was created, if applicable.' - status: - allOf: - - $ref: '#/components/schemas/VolumeState' - - description: The volume state. - volumeId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the volume. - iops: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of I/O operations per second (IOPS). Forgp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.'
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the volume.
- volumeType:
- allOf:
- - $ref: '#/components/schemas/VolumeType'
- - description: The volume type.
- fastRestored:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the volume was created using fast snapshot restore.
- multiAttachEnabled:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether Amazon EBS Multi-Attach is enabled.
- throughput:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The throughput that the volume supports, in MiB/s.'
- description: Describes a volume.
- CreateVpcResult:
- type: object
- example:
- Vpc:
- CidrBlock: 10.0.0.0/16
- DhcpOptionsId: dopt-7a8b9c2d
- InstanceTenancy: default
- State: pending
- VpcId: vpc-a01106c2
- properties:
- vpc:
- allOf:
- - $ref: '#/components/schemas/Vpc'
- - description: Information about the VPC.
- CreateVpcEndpointResult:
- type: object
- properties:
- vpcEndpoint:
- allOf:
- - $ref: '#/components/schemas/VpcEndpoint'
- - description: Information about the endpoint.
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
- description: Contains the output of CreateVpcEndpoint.
- RouteTableId:
- type: string
- DnsRecordIpType:
- type: string
- enum:
- - ipv4
- - dualstack
- - ipv6
- - service-defined
- CreateVpcEndpointConnectionNotificationResult:
- type: object
- properties:
- connectionNotification:
- allOf:
- - $ref: '#/components/schemas/ConnectionNotification'
- - description: Information about the notification.
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
- CreateVpcEndpointServiceConfigurationResult:
- type: object
- properties:
- serviceConfiguration:
- allOf:
- - $ref: '#/components/schemas/ServiceConfiguration'
- - description: Information about the service configuration.
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
- CreateVpcPeeringConnectionResult:
- type: object
- properties:
- vpcPeeringConnection:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnection'
- - description: Information about the VPC peering connection.
- CreateVpnConnectionResult:
- type: object
- properties:
- vpnConnection:
- allOf:
- - $ref: '#/components/schemas/VpnConnection'
- - description: Information about the VPN connection.
- description: Contains the output of CreateVpnConnection.
- CreateVpnGatewayResult:
- type: object
- properties:
- vpnGateway:
- allOf:
- - $ref: '#/components/schemas/VpnGateway'
- - description: Information about the virtual private gateway.
- description: Contains the output of CreateVpnGateway.
- DeleteCarrierGatewayResult:
- type: object
- properties:
- carrierGateway:
- allOf:
- - $ref: '#/components/schemas/CarrierGateway'
- - description: Information about the carrier gateway.
- DeleteClientVpnEndpointResult:
- type: object
- properties:
- status:
- allOf:
- - $ref: '#/components/schemas/ClientVpnEndpointStatus'
- - description: The current state of the Client VPN endpoint.
- DeleteClientVpnRouteResult:
- type: object
- properties:
- status:
- allOf:
- - $ref: '#/components/schemas/ClientVpnRouteStatus'
- - description: The current state of the route.
- DeleteEgressOnlyInternetGatewayResult:
- type: object
- properties:
- returnCode:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- DeleteFleetsResult:
- type: object
- properties:
- successfulFleetDeletionSet:
- allOf:
- - $ref: '#/components/schemas/DeleteFleetSuccessSet'
- - description: Information about the EC2 Fleets that are successfully deleted.
- unsuccessfulFleetDeletionSet:
- allOf:
- - $ref: '#/components/schemas/DeleteFleetErrorSet'
- - description: Information about the EC2 Fleets that are not successfully deleted.
- FleetId:
- type: string
- DeleteFlowLogsResult:
- type: object
- properties:
- unsuccessful:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulItemSet'
- - description: Information about the flow logs that could not be deleted successfully.
- VpcFlowLogId:
- type: string
- DeleteFpgaImageResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Is true if the request succeeds, and an error otherwise.'
- DeleteInstanceEventWindowResult:
- type: object
- properties:
- instanceEventWindowState:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowStateChange'
- - description: The state of the event window.
- DeleteIpamResult:
- type: object
- properties:
- ipam:
- allOf:
- - $ref: '#/components/schemas/Ipam'
- - description: Information about the results of the deletion.
- DeleteIpamPoolResult:
- type: object
- properties:
- ipamPool:
- allOf:
- - $ref: '#/components/schemas/IpamPool'
- - description: Information about the results of the deletion.
- DeleteIpamScopeResult:
- type: object
- properties:
- ipamScope:
- allOf:
- - $ref: '#/components/schemas/IpamScope'
- - description: Information about the results of the deletion.
- DeleteLaunchTemplateResult:
- type: object
- example:
- LaunchTemplate:
- CreateTime: '2017-11-23T16:46:25.000Z'
- CreatedBy: 'arn:aws:iam::123456789012:root'
- DefaultVersionNumber: 2
- LatestVersionNumber: 2
- LaunchTemplateId: lt-0abcd290751193123
- LaunchTemplateName: my-template
- properties:
- launchTemplate:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplate'
- - description: Information about the launch template.
- DeleteLaunchTemplateVersionsResult:
- type: object
- example:
- SuccessfullyDeletedLaunchTemplateVersions:
- - LaunchTemplateId: lt-0abcd290751193123
- LaunchTemplateName: my-template
- VersionNumber: 1
- UnsuccessfullyDeletedLaunchTemplateVersions: []
- properties:
- successfullyDeletedLaunchTemplateVersionSet:
- allOf:
- - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseSuccessSet'
- - description: Information about the launch template versions that were successfully deleted.
- unsuccessfullyDeletedLaunchTemplateVersionSet:
- allOf:
- - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseErrorSet'
- - description: Information about the launch template versions that could not be deleted.
- DeleteLocalGatewayRouteResult:
- type: object
- properties:
- route:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRoute'
- - description: Information about the route.
- DeleteLocalGatewayRouteTableVpcAssociationResult:
- type: object
- properties:
- localGatewayRouteTableVpcAssociation:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociation'
- - description: Information about the association.
- DeleteManagedPrefixListResult:
- type: object
- properties:
- prefixList:
- allOf:
- - $ref: '#/components/schemas/ManagedPrefixList'
- - description: Information about the prefix list.
- DeleteNatGatewayResult:
- type: object
- example:
- NatGatewayId: nat-04ae55e711cec5680
- properties:
- natGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the NAT gateway.
- DeleteNetworkInsightsAccessScopeResult:
- type: object
- properties:
- networkInsightsAccessScopeId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- - description: The ID of the Network Access Scope.
- DeleteNetworkInsightsAccessScopeAnalysisResult:
- type: object
- properties:
- networkInsightsAccessScopeAnalysisId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
- - description: The ID of the Network Access Scope analysis.
- DeleteNetworkInsightsAnalysisResult:
- type: object
- properties:
- networkInsightsAnalysisId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAnalysisId'
- - description: The ID of the network insights analysis.
- DeleteNetworkInsightsPathResult:
- type: object
- properties:
- networkInsightsPathId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsPathId'
- - description: The ID of the path.
- DeleteNetworkInterfacePermissionResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds, otherwise returns an error.'
- description: Contains the output for DeleteNetworkInterfacePermission.
- DeletePublicIpv4PoolResult:
- type: object
- properties:
- returnValue:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Information about the result of deleting the public IPv4 pool.
- DeleteQueuedReservedInstancesResult:
- type: object
- properties:
- successfulQueuedPurchaseDeletionSet:
- allOf:
- - $ref: '#/components/schemas/SuccessfulQueuedPurchaseDeletionSet'
- - description: Information about the queued purchases that were successfully deleted.
- failedQueuedPurchaseDeletionSet:
- allOf:
- - $ref: '#/components/schemas/FailedQueuedPurchaseDeletionSet'
- - description: Information about the queued purchases that could not be deleted.
- DeleteSubnetCidrReservationResult:
- type: object
- properties:
- deletedSubnetCidrReservation:
- allOf:
- - $ref: '#/components/schemas/SubnetCidrReservation'
- - description: Information about the deleted subnet CIDR reservation.
- DeleteTrafficMirrorFilterResult:
- type: object
- properties:
- trafficMirrorFilterId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Traffic Mirror filter.
- DeleteTrafficMirrorFilterRuleResult:
- type: object
- properties:
- trafficMirrorFilterRuleId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the deleted Traffic Mirror rule.
- DeleteTrafficMirrorSessionResult:
- type: object
- properties:
- trafficMirrorSessionId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the deleted Traffic Mirror session.
- DeleteTrafficMirrorTargetResult:
- type: object
- properties:
- trafficMirrorTargetId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the deleted Traffic Mirror target.
- DeleteTransitGatewayResult:
- type: object
- properties:
- transitGateway:
- allOf:
- - $ref: '#/components/schemas/TransitGateway'
- - description: Information about the deleted transit gateway.
- DeleteTransitGatewayConnectResult:
- type: object
- properties:
- transitGatewayConnect:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnect'
- - description: Information about the deleted Connect attachment.
- DeleteTransitGatewayConnectPeerResult:
- type: object
- properties:
- transitGatewayConnectPeer:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnectPeer'
- - description: Information about the deleted Connect peer.
- DeleteTransitGatewayMulticastDomainResult:
- type: object
- properties:
- transitGatewayMulticastDomain:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomain'
- - description: Information about the deleted transit gateway multicast domain.
- DeleteTransitGatewayPeeringAttachmentResult:
- type: object
- properties:
- transitGatewayPeeringAttachment:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
- - description: The transit gateway peering attachment.
- DeleteTransitGatewayPrefixListReferenceResult:
- type: object
- properties:
- transitGatewayPrefixListReference:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPrefixListReference'
- - description: Information about the deleted prefix list reference.
- DeleteTransitGatewayRouteResult:
- type: object
- properties:
- route:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRoute'
- - description: Information about the route.
- DeleteTransitGatewayRouteTableResult:
- type: object
- properties:
- transitGatewayRouteTable:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTable'
- - description: Information about the deleted transit gateway route table.
- DeleteTransitGatewayVpcAttachmentResult:
- type: object
- properties:
- transitGatewayVpcAttachment:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- - description: Information about the deleted VPC attachment.
- DeleteVpcEndpointConnectionNotificationsResult:
- type: object
- properties:
- unsuccessful:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulItemSet'
- - description: Information about the notifications that could not be deleted successfully.
- ConnectionNotificationId:
- type: string
- DeleteVpcEndpointServiceConfigurationsResult:
- type: object
- properties:
- unsuccessful:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulItemSet'
- - description: 'Information about the service configurations that were not deleted, if applicable.'
- VpcEndpointServiceId:
- type: string
- DeleteVpcEndpointsResult:
- type: object
- properties:
- unsuccessful:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulItemSet'
- - description: Information about the VPC endpoints that were not successfully deleted.
- description: Contains the output of DeleteVpcEndpoints.
- DeleteVpcPeeringConnectionResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- DeprovisionByoipCidrResult:
- type: object
- properties:
- byoipCidr:
- allOf:
- - $ref: '#/components/schemas/ByoipCidr'
- - description: Information about the address range.
- DeprovisionIpamPoolCidrResult:
- type: object
- properties:
- ipamPoolCidr:
- allOf:
- - $ref: '#/components/schemas/IpamPoolCidr'
- - description: The deprovisioned pool CIDR.
- DeprovisionPublicIpv4PoolCidrResult:
- type: object
- properties:
- poolId:
- allOf:
- - $ref: '#/components/schemas/Ipv4PoolEc2Id'
- - description: The ID of the pool that you deprovisioned the CIDR from.
- deprovisionedAddressSet:
- allOf:
- - $ref: '#/components/schemas/DeprovisionedAddressSet'
- - description: The deprovisioned CIDRs.
- DeregisterInstanceEventNotificationAttributesResult:
- type: object
- properties:
- instanceTagAttribute:
- allOf:
- - $ref: '#/components/schemas/InstanceTagNotificationAttribute'
- - description: The resulting set of tag keys.
- InstanceTagKeySet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- DeregisterTransitGatewayMulticastGroupMembersResult:
- type: object
- properties:
- deregisteredMulticastGroupMembers:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDeregisteredGroupMembers'
- - description: Information about the deregistered members.
- NetworkInterfaceId:
- type: string
- DeregisterTransitGatewayMulticastGroupSourcesResult:
- type: object
- properties:
- deregisteredMulticastGroupSources:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDeregisteredGroupSources'
- - description: Information about the deregistered group sources.
- DescribeAccountAttributesResult:
- type: object
- example:
- AccountAttributes:
- - AttributeName: supported-platforms
- AttributeValues:
- - AttributeValue: EC2
- - AttributeValue: VPC
- - AttributeName: vpc-max-security-groups-per-interface
- AttributeValues:
- - AttributeValue: '5'
- - AttributeName: max-elastic-ips
- AttributeValues:
- - AttributeValue: '5'
- - AttributeName: max-instances
- AttributeValues:
- - AttributeValue: '20'
- - AttributeName: vpc-max-elastic-ips
- AttributeValues:
- - AttributeValue: '5'
- - AttributeName: default-vpc
- AttributeValues:
- - AttributeValue: none
- properties:
- accountAttributeSet:
- allOf:
- - $ref: '#/components/schemas/AccountAttributeList'
- - description: Information about the account attributes.
- AccountAttributeName:
- type: string
- enum:
- - supported-platforms
- - default-vpc
- DescribeAddressesResult:
- type: object
- example:
- Addresses:
- - Domain: standard
- InstanceId: i-1234567890abcdef0
- PublicIp: 198.51.100.0
- properties:
- addressesSet:
- allOf:
- - $ref: '#/components/schemas/AddressList'
- - description: Information about the Elastic IP addresses.
- Filter:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the filter. Filter names are case-sensitive.
- Value:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: 'The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.'
- description: 'A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
null when there are no more results to return.
- DescribeAggregateIdFormatResult:
- type: object
- properties:
- useLongIdsAggregated:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether all resource types in the Region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the Region.
- statusSet:
- allOf:
- - $ref: '#/components/schemas/IdFormatList'
- - description: Information about each resource's ID format.
- DescribeAvailabilityZonesResult:
- type: object
- example:
- AvailabilityZones:
- - Messages: []
- RegionName: us-east-1
- State: available
- ZoneName: us-east-1b
- - Messages: []
- RegionName: us-east-1
- State: available
- ZoneName: us-east-1c
- - Messages: []
- RegionName: us-east-1
- State: available
- ZoneName: us-east-1d
- - Messages: []
- RegionName: us-east-1
- State: available
- ZoneName: us-east-1e
- properties:
- availabilityZoneInfo:
- allOf:
- - $ref: '#/components/schemas/AvailabilityZoneList'
- - description: 'Information about the Availability Zones, Local Zones, and Wavelength Zones.'
- DescribeBundleTasksResult:
- type: object
- properties:
- bundleInstanceTasksSet:
- allOf:
- - $ref: '#/components/schemas/BundleTaskList'
- - description: Information about the bundle tasks.
- BundleId:
- type: string
- DescribeByoipCidrsResult:
- type: object
- properties:
- byoipCidrSet:
- allOf:
- - $ref: '#/components/schemas/ByoipCidrSet'
- - description: Information about your address ranges.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeCapacityReservationFleetsResult:
- type: object
- properties:
- capacityReservationFleetSet:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationFleetSet'
- - description: Information about the Capacity Reservation Fleets.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeCapacityReservationsResult:
- type: object
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- capacityReservationSet:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationSet'
- - description: Information about the Capacity Reservations.
- CapacityReservationId:
- type: string
- DescribeCarrierGatewaysResult:
- type: object
- properties:
- carrierGatewaySet:
- allOf:
- - $ref: '#/components/schemas/CarrierGatewaySet'
- - description: Information about the carrier gateway.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- CarrierGatewayId:
- type: string
- DescribeClassicLinkInstancesResult:
- type: object
- properties:
- instancesSet:
- allOf:
- - $ref: '#/components/schemas/ClassicLinkInstanceList'
- - description: Information about one or more linked EC2-Classic instances.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- InstanceId:
- type: string
- DescribeClientVpnAuthorizationRulesResult:
- type: object
- properties:
- authorizationRule:
- allOf:
- - $ref: '#/components/schemas/AuthorizationRuleSet'
- - description: Information about the authorization rules.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeClientVpnConnectionsResult:
- type: object
- properties:
- connections:
- allOf:
- - $ref: '#/components/schemas/ClientVpnConnectionSet'
- - description: Information about the active and terminated client connections.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeClientVpnEndpointsResult:
- type: object
- properties:
- clientVpnEndpoint:
- allOf:
- - $ref: '#/components/schemas/EndpointSet'
- - description: Information about the Client VPN endpoints.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- ClientVpnEndpointId:
- type: string
- DescribeClientVpnRoutesResult:
- type: object
- properties:
- routes:
- allOf:
- - $ref: '#/components/schemas/ClientVpnRouteSet'
- - description: Information about the Client VPN endpoint routes.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeClientVpnTargetNetworksResult:
- type: object
- properties:
- clientVpnTargetNetworks:
- allOf:
- - $ref: '#/components/schemas/TargetNetworkSet'
- - description: Information about the associated target networks.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeCoipPoolsResult:
- type: object
- properties:
- coipPoolSet:
- allOf:
- - $ref: '#/components/schemas/CoipPoolSet'
- - description: Information about the address pools.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Ipv4PoolCoipId:
- type: string
- DescribeConversionTasksResult:
- type: object
- properties:
- conversionTasks:
- allOf:
- - $ref: '#/components/schemas/DescribeConversionTaskList'
- - description: Information about the conversion tasks.
- ConversionTaskId:
- type: string
- DescribeCustomerGatewaysResult:
- type: object
- example:
- CustomerGateways:
- - BgpAsn: '65534'
- CustomerGatewayId: cgw-0e11f167
- IpAddress: 12.1.2.3
- State: available
- Type: ipsec.1
- properties:
- customerGatewaySet:
- allOf:
- - $ref: '#/components/schemas/CustomerGatewayList'
- - description: Information about one or more customer gateways.
- description: Contains the output of DescribeCustomerGateways.
- CustomerGatewayId:
- type: string
- DescribeDhcpOptionsResult:
- type: object
- example:
- DhcpOptions:
- - DhcpConfigurations:
- - Key: domain-name-servers
- Values:
- - Value: 10.2.5.2
- - Value: 10.2.5.1
- DhcpOptionsId: dopt-d9070ebb
- properties:
- dhcpOptionsSet:
- allOf:
- - $ref: '#/components/schemas/DhcpOptionsList'
- - description: Information about one or more DHCP options sets.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DhcpOptionsId:
- type: string
- DescribeEgressOnlyInternetGatewaysResult:
- type: object
- properties:
- egressOnlyInternetGatewaySet:
- allOf:
- - $ref: '#/components/schemas/EgressOnlyInternetGatewayList'
- - description: Information about the egress-only internet gateways.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- EgressOnlyInternetGatewayId:
- type: string
- DescribeElasticGpusResult:
- type: object
- properties:
- elasticGpuSet:
- allOf:
- - $ref: '#/components/schemas/ElasticGpuSet'
- - description: Information about the Elastic Graphics accelerators.
- maxResults:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- ElasticGpuId:
- type: string
- DescribeExportImageTasksResult:
- type: object
- properties:
- exportImageTaskSet:
- allOf:
- - $ref: '#/components/schemas/ExportImageTaskList'
- - description: Information about the export image tasks.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to get the next page of results. This value is null when there are no more results to return.
- ExportImageTaskId:
- type: string
- DescribeExportTasksResult:
- type: object
- properties:
- exportTaskSet:
- allOf:
- - $ref: '#/components/schemas/ExportTaskList'
- - description: Information about the export tasks.
- ExportTaskId:
- type: string
- DescribeFastLaunchImagesResult:
- type: object
- properties:
- fastLaunchImageSet:
- allOf:
- - $ref: '#/components/schemas/DescribeFastLaunchImagesSuccessSet'
- - description: A collection of details about the fast-launch enabled Windows images that meet the requested criteria.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use for the next set of results. This value is null when there are no more results to return.
- ImageId:
- type: string
- DescribeFastSnapshotRestoresResult:
- type: object
- properties:
- fastSnapshotRestoreSet:
- allOf:
- - $ref: '#/components/schemas/DescribeFastSnapshotRestoreSuccessSet'
- - description: Information about the state of fast snapshot restores.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeFleetHistoryResult:
- type: object
- properties:
- historyRecordSet:
- allOf:
- - $ref: '#/components/schemas/HistoryRecordSet'
- - description: Information about the events in the history of the EC2 Fleet.
- lastEvaluatedTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more results, this value is not present.
null when there are no more results to return.
- DescribeFpgaImageAttributeResult:
- type: object
- properties:
- fpgaImageAttribute:
- allOf:
- - $ref: '#/components/schemas/FpgaImageAttribute'
- - description: Information about the attribute.
- DescribeFpgaImagesResult:
- type: object
- properties:
- fpgaImageSet:
- allOf:
- - $ref: '#/components/schemas/FpgaImageList'
- - description: Information about the FPGA images.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- FpgaImageId:
- type: string
- DescribeHostReservationOfferingsResult:
- type: object
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- offeringSet:
- allOf:
- - $ref: '#/components/schemas/HostOfferingSet'
- - description: Information about the offerings.
- DescribeHostReservationsResult:
- type: object
- properties:
- hostReservationSet:
- allOf:
- - $ref: '#/components/schemas/HostReservationSet'
- - description: Details about the reservation's configuration.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- HostReservationId:
- type: string
- DescribeHostsResult:
- type: object
- properties:
- hostSet:
- allOf:
- - $ref: '#/components/schemas/HostList'
- - description: Information about the Dedicated Hosts.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DedicatedHostId:
- type: string
- DescribeIamInstanceProfileAssociationsResult:
- type: object
- example:
- IamInstanceProfileAssociations:
- - AssociationId: iip-assoc-0db249b1f25fa24b8
- IamInstanceProfile:
- Arn: 'arn:aws:iam::123456789012:instance-profile/admin-role'
- Id: AIPAJVQN4F5WVLGCJDRGM
- InstanceId: i-09eb09efa73ec1dee
- State: associated
- properties:
- iamInstanceProfileAssociationSet:
- allOf:
- - $ref: '#/components/schemas/IamInstanceProfileAssociationSet'
- - description: Information about the IAM instance profile associations.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- IamInstanceProfileAssociationId:
- type: string
- DescribeIdFormatResult:
- type: object
- properties:
- statusSet:
- allOf:
- - $ref: '#/components/schemas/IdFormatList'
- - description: Information about the ID format for the resource.
- DescribeIdentityIdFormatResult:
- type: object
- properties:
- statusSet:
- allOf:
- - $ref: '#/components/schemas/IdFormatList'
- - description: Information about the ID format for the resources.
- ImageAttribute:
- type: object
- example:
- ImageId: ami-5731123e
- LaunchPermissions:
- - UserId: '123456789012'
- properties:
- blockDeviceMapping:
- allOf:
- - $ref: '#/components/schemas/BlockDeviceMappingList'
- - description: The block device mapping entries.
- imageId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the AMI.
- launchPermission:
- allOf:
- - $ref: '#/components/schemas/LaunchPermissionList'
- - description: The launch permissions.
- productCodes:
- allOf:
- - $ref: '#/components/schemas/ProductCodeList'
- - description: The product codes.
- description:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: A description for the AMI.
- kernel:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: The kernel ID.
- ramdisk:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: The RAM disk ID.
- sriovNetSupport:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
- bootMode:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: The boot mode.
- tpmSupport:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: 'If the image is configured for NitroTPM support, the value is v2.0.'
- uefiData:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: 'Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.'
- lastLaunchedTime:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: 'The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used, there is a 24-hour delay before that usage is reported.
lastLaunchedTime data is available starting April 2017.
null when there are no more results to return.
- ImportImageTaskId:
- type: string
- DescribeImportSnapshotTasksResult:
- type: object
- properties:
- importSnapshotTaskSet:
- allOf:
- - $ref: '#/components/schemas/ImportSnapshotTaskList'
- - description: A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to get the next page of results. This value is null when there are no more results to return.
- ImportSnapshotTaskId:
- type: string
- InstanceAttribute:
- type: object
- example:
- BlockDeviceMappings:
- - DeviceName: /dev/sda1
- Ebs:
- AttachTime: '2013-05-17T22:42:34.000Z'
- DeleteOnTermination: true
- Status: attached
- VolumeId: vol-049df61146c4d7901
- - DeviceName: /dev/sdf
- Ebs:
- AttachTime: '2013-09-10T23:07:00.000Z'
- DeleteOnTermination: false
- Status: attached
- VolumeId: vol-049df61146c4d7901
- InstanceId: i-1234567890abcdef0
- properties:
- groupSet:
- allOf:
- - $ref: '#/components/schemas/GroupIdentifierList'
- - description: The security groups associated with the instance.
- blockDeviceMapping:
- allOf:
- - $ref: '#/components/schemas/InstanceBlockDeviceMappingList'
- - description: The block device mapping of the instance.
- disableApiTermination:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: 'If the value is true, you can''t terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.'
- enaSupport:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: Indicates whether enhanced networking with ENA is enabled.
- enclaveOptions:
- allOf:
- - $ref: '#/components/schemas/EnclaveOptions'
- - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.'
- ebsOptimized:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: Indicates whether the instance is optimized for Amazon EBS I/O.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance.
- instanceInitiatedShutdownBehavior:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
- instanceType:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: The instance type.
- kernel:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: The kernel ID.
- productCodes:
- allOf:
- - $ref: '#/components/schemas/ProductCodeList'
- - description: A list of product codes.
- ramdisk:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: The RAM disk ID.
- rootDeviceName:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: 'The device name of the root device volume (for example, /dev/sda1).'
- sourceDestCheck:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
- sriovNetSupport:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
- userData:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: The user data.
- description: Describes an instance attribute.
- DescribeInstanceCreditSpecificationsResult:
- type: object
- properties:
- instanceCreditSpecificationSet:
- allOf:
- - $ref: '#/components/schemas/InstanceCreditSpecificationList'
- - description: Information about the credit option for CPU usage of an instance.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeInstanceEventNotificationAttributesResult:
- type: object
- properties:
- instanceTagAttribute:
- allOf:
- - $ref: '#/components/schemas/InstanceTagNotificationAttribute'
- - description: Information about the registered tag keys.
- DescribeInstanceEventWindowsResult:
- type: object
- properties:
- instanceEventWindowSet:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowSet'
- - description: Information about the event windows.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
- InstanceEventWindowId:
- type: string
- DescribeInstanceStatusResult:
- type: object
- example:
- InstanceStatuses:
- - AvailabilityZone: us-east-1d
- InstanceId: i-1234567890abcdef0
- InstanceState:
- Code: 16
- Name: running
- InstanceStatus:
- Details:
- - Name: reachability
- Status: passed
- Status: ok
- SystemStatus:
- Details:
- - Name: reachability
- Status: passed
- Status: ok
- properties:
- instanceStatusSet:
- allOf:
- - $ref: '#/components/schemas/InstanceStatusList'
- - description: Information about the status of the instances.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeInstanceTypeOfferingsResult:
- type: object
- properties:
- instanceTypeOfferingSet:
- allOf:
- - $ref: '#/components/schemas/InstanceTypeOfferingsList'
- - description: The instance types offered.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeInstanceTypesResult:
- type: object
- properties:
- instanceTypeSet:
- allOf:
- - $ref: '#/components/schemas/InstanceTypeInfoList'
- - description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.'
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- InstanceType:
- type: string
- enum:
- - a1.medium
- - a1.large
- - a1.xlarge
- - a1.2xlarge
- - a1.4xlarge
- - a1.metal
- - c1.medium
- - c1.xlarge
- - c3.large
- - c3.xlarge
- - c3.2xlarge
- - c3.4xlarge
- - c3.8xlarge
- - c4.large
- - c4.xlarge
- - c4.2xlarge
- - c4.4xlarge
- - c4.8xlarge
- - c5.large
- - c5.xlarge
- - c5.2xlarge
- - c5.4xlarge
- - c5.9xlarge
- - c5.12xlarge
- - c5.18xlarge
- - c5.24xlarge
- - c5.metal
- - c5a.large
- - c5a.xlarge
- - c5a.2xlarge
- - c5a.4xlarge
- - c5a.8xlarge
- - c5a.12xlarge
- - c5a.16xlarge
- - c5a.24xlarge
- - c5ad.large
- - c5ad.xlarge
- - c5ad.2xlarge
- - c5ad.4xlarge
- - c5ad.8xlarge
- - c5ad.12xlarge
- - c5ad.16xlarge
- - c5ad.24xlarge
- - c5d.large
- - c5d.xlarge
- - c5d.2xlarge
- - c5d.4xlarge
- - c5d.9xlarge
- - c5d.12xlarge
- - c5d.18xlarge
- - c5d.24xlarge
- - c5d.metal
- - c5n.large
- - c5n.xlarge
- - c5n.2xlarge
- - c5n.4xlarge
- - c5n.9xlarge
- - c5n.18xlarge
- - c5n.metal
- - c6g.medium
- - c6g.large
- - c6g.xlarge
- - c6g.2xlarge
- - c6g.4xlarge
- - c6g.8xlarge
- - c6g.12xlarge
- - c6g.16xlarge
- - c6g.metal
- - c6gd.medium
- - c6gd.large
- - c6gd.xlarge
- - c6gd.2xlarge
- - c6gd.4xlarge
- - c6gd.8xlarge
- - c6gd.12xlarge
- - c6gd.16xlarge
- - c6gd.metal
- - c6gn.medium
- - c6gn.large
- - c6gn.xlarge
- - c6gn.2xlarge
- - c6gn.4xlarge
- - c6gn.8xlarge
- - c6gn.12xlarge
- - c6gn.16xlarge
- - c6i.large
- - c6i.xlarge
- - c6i.2xlarge
- - c6i.4xlarge
- - c6i.8xlarge
- - c6i.12xlarge
- - c6i.16xlarge
- - c6i.24xlarge
- - c6i.32xlarge
- - c6i.metal
- - cc1.4xlarge
- - cc2.8xlarge
- - cg1.4xlarge
- - cr1.8xlarge
- - d2.xlarge
- - d2.2xlarge
- - d2.4xlarge
- - d2.8xlarge
- - d3.xlarge
- - d3.2xlarge
- - d3.4xlarge
- - d3.8xlarge
- - d3en.xlarge
- - d3en.2xlarge
- - d3en.4xlarge
- - d3en.6xlarge
- - d3en.8xlarge
- - d3en.12xlarge
- - dl1.24xlarge
- - f1.2xlarge
- - f1.4xlarge
- - f1.16xlarge
- - g2.2xlarge
- - g2.8xlarge
- - g3.4xlarge
- - g3.8xlarge
- - g3.16xlarge
- - g3s.xlarge
- - g4ad.xlarge
- - g4ad.2xlarge
- - g4ad.4xlarge
- - g4ad.8xlarge
- - g4ad.16xlarge
- - g4dn.xlarge
- - g4dn.2xlarge
- - g4dn.4xlarge
- - g4dn.8xlarge
- - g4dn.12xlarge
- - g4dn.16xlarge
- - g4dn.metal
- - g5.xlarge
- - g5.2xlarge
- - g5.4xlarge
- - g5.8xlarge
- - g5.12xlarge
- - g5.16xlarge
- - g5.24xlarge
- - g5.48xlarge
- - g5g.xlarge
- - g5g.2xlarge
- - g5g.4xlarge
- - g5g.8xlarge
- - g5g.16xlarge
- - g5g.metal
- - hi1.4xlarge
- - hpc6a.48xlarge
- - hs1.8xlarge
- - h1.2xlarge
- - h1.4xlarge
- - h1.8xlarge
- - h1.16xlarge
- - i2.xlarge
- - i2.2xlarge
- - i2.4xlarge
- - i2.8xlarge
- - i3.large
- - i3.xlarge
- - i3.2xlarge
- - i3.4xlarge
- - i3.8xlarge
- - i3.16xlarge
- - i3.metal
- - i3en.large
- - i3en.xlarge
- - i3en.2xlarge
- - i3en.3xlarge
- - i3en.6xlarge
- - i3en.12xlarge
- - i3en.24xlarge
- - i3en.metal
- - im4gn.large
- - im4gn.xlarge
- - im4gn.2xlarge
- - im4gn.4xlarge
- - im4gn.8xlarge
- - im4gn.16xlarge
- - inf1.xlarge
- - inf1.2xlarge
- - inf1.6xlarge
- - inf1.24xlarge
- - is4gen.medium
- - is4gen.large
- - is4gen.xlarge
- - is4gen.2xlarge
- - is4gen.4xlarge
- - is4gen.8xlarge
- - m1.small
- - m1.medium
- - m1.large
- - m1.xlarge
- - m2.xlarge
- - m2.2xlarge
- - m2.4xlarge
- - m3.medium
- - m3.large
- - m3.xlarge
- - m3.2xlarge
- - m4.large
- - m4.xlarge
- - m4.2xlarge
- - m4.4xlarge
- - m4.10xlarge
- - m4.16xlarge
- - m5.large
- - m5.xlarge
- - m5.2xlarge
- - m5.4xlarge
- - m5.8xlarge
- - m5.12xlarge
- - m5.16xlarge
- - m5.24xlarge
- - m5.metal
- - m5a.large
- - m5a.xlarge
- - m5a.2xlarge
- - m5a.4xlarge
- - m5a.8xlarge
- - m5a.12xlarge
- - m5a.16xlarge
- - m5a.24xlarge
- - m5ad.large
- - m5ad.xlarge
- - m5ad.2xlarge
- - m5ad.4xlarge
- - m5ad.8xlarge
- - m5ad.12xlarge
- - m5ad.16xlarge
- - m5ad.24xlarge
- - m5d.large
- - m5d.xlarge
- - m5d.2xlarge
- - m5d.4xlarge
- - m5d.8xlarge
- - m5d.12xlarge
- - m5d.16xlarge
- - m5d.24xlarge
- - m5d.metal
- - m5dn.large
- - m5dn.xlarge
- - m5dn.2xlarge
- - m5dn.4xlarge
- - m5dn.8xlarge
- - m5dn.12xlarge
- - m5dn.16xlarge
- - m5dn.24xlarge
- - m5dn.metal
- - m5n.large
- - m5n.xlarge
- - m5n.2xlarge
- - m5n.4xlarge
- - m5n.8xlarge
- - m5n.12xlarge
- - m5n.16xlarge
- - m5n.24xlarge
- - m5n.metal
- - m5zn.large
- - m5zn.xlarge
- - m5zn.2xlarge
- - m5zn.3xlarge
- - m5zn.6xlarge
- - m5zn.12xlarge
- - m5zn.metal
- - m6a.large
- - m6a.xlarge
- - m6a.2xlarge
- - m6a.4xlarge
- - m6a.8xlarge
- - m6a.12xlarge
- - m6a.16xlarge
- - m6a.24xlarge
- - m6a.32xlarge
- - m6a.48xlarge
- - m6g.metal
- - m6g.medium
- - m6g.large
- - m6g.xlarge
- - m6g.2xlarge
- - m6g.4xlarge
- - m6g.8xlarge
- - m6g.12xlarge
- - m6g.16xlarge
- - m6gd.metal
- - m6gd.medium
- - m6gd.large
- - m6gd.xlarge
- - m6gd.2xlarge
- - m6gd.4xlarge
- - m6gd.8xlarge
- - m6gd.12xlarge
- - m6gd.16xlarge
- - m6i.large
- - m6i.xlarge
- - m6i.2xlarge
- - m6i.4xlarge
- - m6i.8xlarge
- - m6i.12xlarge
- - m6i.16xlarge
- - m6i.24xlarge
- - m6i.32xlarge
- - m6i.metal
- - mac1.metal
- - p2.xlarge
- - p2.8xlarge
- - p2.16xlarge
- - p3.2xlarge
- - p3.8xlarge
- - p3.16xlarge
- - p3dn.24xlarge
- - p4d.24xlarge
- - r3.large
- - r3.xlarge
- - r3.2xlarge
- - r3.4xlarge
- - r3.8xlarge
- - r4.large
- - r4.xlarge
- - r4.2xlarge
- - r4.4xlarge
- - r4.8xlarge
- - r4.16xlarge
- - r5.large
- - r5.xlarge
- - r5.2xlarge
- - r5.4xlarge
- - r5.8xlarge
- - r5.12xlarge
- - r5.16xlarge
- - r5.24xlarge
- - r5.metal
- - r5a.large
- - r5a.xlarge
- - r5a.2xlarge
- - r5a.4xlarge
- - r5a.8xlarge
- - r5a.12xlarge
- - r5a.16xlarge
- - r5a.24xlarge
- - r5ad.large
- - r5ad.xlarge
- - r5ad.2xlarge
- - r5ad.4xlarge
- - r5ad.8xlarge
- - r5ad.12xlarge
- - r5ad.16xlarge
- - r5ad.24xlarge
- - r5b.large
- - r5b.xlarge
- - r5b.2xlarge
- - r5b.4xlarge
- - r5b.8xlarge
- - r5b.12xlarge
- - r5b.16xlarge
- - r5b.24xlarge
- - r5b.metal
- - r5d.large
- - r5d.xlarge
- - r5d.2xlarge
- - r5d.4xlarge
- - r5d.8xlarge
- - r5d.12xlarge
- - r5d.16xlarge
- - r5d.24xlarge
- - r5d.metal
- - r5dn.large
- - r5dn.xlarge
- - r5dn.2xlarge
- - r5dn.4xlarge
- - r5dn.8xlarge
- - r5dn.12xlarge
- - r5dn.16xlarge
- - r5dn.24xlarge
- - r5dn.metal
- - r5n.large
- - r5n.xlarge
- - r5n.2xlarge
- - r5n.4xlarge
- - r5n.8xlarge
- - r5n.12xlarge
- - r5n.16xlarge
- - r5n.24xlarge
- - r5n.metal
- - r6g.medium
- - r6g.large
- - r6g.xlarge
- - r6g.2xlarge
- - r6g.4xlarge
- - r6g.8xlarge
- - r6g.12xlarge
- - r6g.16xlarge
- - r6g.metal
- - r6gd.medium
- - r6gd.large
- - r6gd.xlarge
- - r6gd.2xlarge
- - r6gd.4xlarge
- - r6gd.8xlarge
- - r6gd.12xlarge
- - r6gd.16xlarge
- - r6gd.metal
- - r6i.large
- - r6i.xlarge
- - r6i.2xlarge
- - r6i.4xlarge
- - r6i.8xlarge
- - r6i.12xlarge
- - r6i.16xlarge
- - r6i.24xlarge
- - r6i.32xlarge
- - r6i.metal
- - t1.micro
- - t2.nano
- - t2.micro
- - t2.small
- - t2.medium
- - t2.large
- - t2.xlarge
- - t2.2xlarge
- - t3.nano
- - t3.micro
- - t3.small
- - t3.medium
- - t3.large
- - t3.xlarge
- - t3.2xlarge
- - t3a.nano
- - t3a.micro
- - t3a.small
- - t3a.medium
- - t3a.large
- - t3a.xlarge
- - t3a.2xlarge
- - t4g.nano
- - t4g.micro
- - t4g.small
- - t4g.medium
- - t4g.large
- - t4g.xlarge
- - t4g.2xlarge
- - u-6tb1.56xlarge
- - u-6tb1.112xlarge
- - u-9tb1.112xlarge
- - u-12tb1.112xlarge
- - u-6tb1.metal
- - u-9tb1.metal
- - u-12tb1.metal
- - u-18tb1.metal
- - u-24tb1.metal
- - vt1.3xlarge
- - vt1.6xlarge
- - vt1.24xlarge
- - x1.16xlarge
- - x1.32xlarge
- - x1e.xlarge
- - x1e.2xlarge
- - x1e.4xlarge
- - x1e.8xlarge
- - x1e.16xlarge
- - x1e.32xlarge
- - x2iezn.2xlarge
- - x2iezn.4xlarge
- - x2iezn.6xlarge
- - x2iezn.8xlarge
- - x2iezn.12xlarge
- - x2iezn.metal
- - x2gd.medium
- - x2gd.large
- - x2gd.xlarge
- - x2gd.2xlarge
- - x2gd.4xlarge
- - x2gd.8xlarge
- - x2gd.12xlarge
- - x2gd.16xlarge
- - x2gd.metal
- - z1d.large
- - z1d.xlarge
- - z1d.2xlarge
- - z1d.3xlarge
- - z1d.6xlarge
- - z1d.12xlarge
- - z1d.metal
- - x2idn.16xlarge
- - x2idn.24xlarge
- - x2idn.32xlarge
- - x2iedn.xlarge
- - x2iedn.2xlarge
- - x2iedn.4xlarge
- - x2iedn.8xlarge
- - x2iedn.16xlarge
- - x2iedn.24xlarge
- - x2iedn.32xlarge
- - c6a.large
- - c6a.xlarge
- - c6a.2xlarge
- - c6a.4xlarge
- - c6a.8xlarge
- - c6a.12xlarge
- - c6a.16xlarge
- - c6a.24xlarge
- - c6a.32xlarge
- - c6a.48xlarge
- - c6a.metal
- - m6a.metal
- - i4i.large
- - i4i.xlarge
- - i4i.2xlarge
- - i4i.4xlarge
- - i4i.8xlarge
- - i4i.16xlarge
- - i4i.32xlarge
- DescribeInstancesResult:
- type: object
- example: {}
- properties:
- reservationSet:
- allOf:
- - $ref: '#/components/schemas/ReservationList'
- - description: Information about the reservations.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeInternetGatewaysResult:
- type: object
- example:
- InternetGateways:
- - Attachments:
- - State: available
- VpcId: vpc-a01106c2
- InternetGatewayId: igw-c0a643a9
- Tags: []
- properties:
- internetGatewaySet:
- allOf:
- - $ref: '#/components/schemas/InternetGatewayList'
- - description: Information about one or more internet gateways.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- InternetGatewayId:
- type: string
- DescribeIpamPoolsResult:
- type: object
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- ipamPoolSet:
- allOf:
- - $ref: '#/components/schemas/IpamPoolSet'
- - description: Information about the IPAM pools.
- DescribeIpamScopesResult:
- type: object
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- ipamScopeSet:
- allOf:
- - $ref: '#/components/schemas/IpamScopeSet'
- - description: The scopes you want information on.
- DescribeIpamsResult:
- type: object
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- ipamSet:
- allOf:
- - $ref: '#/components/schemas/IpamSet'
- - description: Information about the IPAMs.
- DescribeIpv6PoolsResult:
- type: object
- properties:
- ipv6PoolSet:
- allOf:
- - $ref: '#/components/schemas/Ipv6PoolSet'
- - description: Information about the IPv6 address pools.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Ipv6PoolEc2Id:
- type: string
- DescribeKeyPairsResult:
- type: object
- example:
- KeyPairs:
- - KeyFingerprint: '1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f'
- KeyName: my-key-pair
- properties:
- keySet:
- allOf:
- - $ref: '#/components/schemas/KeyPairList'
- - description: Information about the key pairs.
- KeyPairName:
- type: string
- KeyPairId:
- type: string
- DescribeLaunchTemplateVersionsResult:
- type: object
- example:
- LaunchTemplateVersions:
- - CreateTime: '2017-11-20T13:12:32.000Z'
- CreatedBy: 'arn:aws:iam::123456789102:root'
- DefaultVersion: false
- LaunchTemplateData:
- ImageId: ami-6057e21a
- InstanceType: t2.medium
- KeyName: kp-us-east
- NetworkInterfaces:
- - DeviceIndex: 0
- Groups:
- - sg-7c227019
- SubnetId: subnet-1a2b3c4d
- LaunchTemplateId: lt-068f72b72934aff71
- LaunchTemplateName: Webservers
- VersionNumber: 2
- - CreateTime: '2017-11-20T12:52:33.000Z'
- CreatedBy: 'arn:aws:iam::123456789102:root'
- DefaultVersion: true
- LaunchTemplateData:
- ImageId: ami-aabbcc11
- InstanceType: t2.medium
- KeyName: kp-us-east
- NetworkInterfaces:
- - AssociatePublicIpAddress: true
- DeleteOnTermination: false
- DeviceIndex: 0
- Groups:
- - sg-7c227019
- SubnetId: subnet-7b16de0c
- UserData: ''
- LaunchTemplateId: lt-068f72b72934aff71
- LaunchTemplateName: Webservers
- VersionNumber: 1
- properties:
- launchTemplateVersionSet:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateVersionSet'
- - description: Information about the launch template versions.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeLaunchTemplatesResult:
- type: object
- example:
- LaunchTemplates:
- - CreateTime: '2018-01-16T04:32:57.000Z'
- CreatedBy: 'arn:aws:iam::123456789012:root'
- DefaultVersionNumber: 1
- LatestVersionNumber: 1
- LaunchTemplateId: lt-01238c059e3466abc
- LaunchTemplateName: my-template
- properties:
- launchTemplates:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateSet'
- - description: Information about the launch templates.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- LaunchTemplateId:
- type: string
- LaunchTemplateName:
- type: string
- pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
- minLength: 3
- maxLength: 128
- DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult:
- type: object
- properties:
- localGatewayRouteTableVirtualInterfaceGroupAssociationSet:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet'
- - description: Information about the associations.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- LocalGatewayRouteTableVirtualInterfaceGroupAssociationId:
- type: string
- DescribeLocalGatewayRouteTableVpcAssociationsResult:
- type: object
- properties:
- localGatewayRouteTableVpcAssociationSet:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationSet'
- - description: Information about the associations.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- LocalGatewayRouteTableVpcAssociationId:
- type: string
- DescribeLocalGatewayRouteTablesResult:
- type: object
- properties:
- localGatewayRouteTableSet:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableSet'
- - description: Information about the local gateway route tables.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- LocalGatewayRoutetableId:
- type: string
- DescribeLocalGatewayVirtualInterfaceGroupsResult:
- type: object
- properties:
- localGatewayVirtualInterfaceGroupSet:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupSet'
- - description: The virtual interface groups.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- LocalGatewayVirtualInterfaceGroupId:
- type: string
- DescribeLocalGatewayVirtualInterfacesResult:
- type: object
- properties:
- localGatewayVirtualInterfaceSet:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceSet'
- - description: Information about the virtual interfaces.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- LocalGatewayVirtualInterfaceId:
- type: string
- DescribeLocalGatewaysResult:
- type: object
- properties:
- localGatewaySet:
- allOf:
- - $ref: '#/components/schemas/LocalGatewaySet'
- - description: Information about the local gateways.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- LocalGatewayId:
- type: string
- DescribeManagedPrefixListsResult:
- type: object
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- prefixListSet:
- allOf:
- - $ref: '#/components/schemas/ManagedPrefixListSet'
- - description: Information about the prefix lists.
- DescribeMovingAddressesResult:
- type: object
- example:
- MovingAddressStatuses:
- - MoveStatus: MovingToVpc
- PublicIp: 198.51.100.0
- properties:
- movingAddressStatusSet:
- allOf:
- - $ref: '#/components/schemas/MovingAddressStatusSet'
- - description: The status for each Elastic IP address.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeNatGatewaysResult:
- type: object
- example:
- NatGateways:
- - CreateTime: '2015-12-01T12:26:55.983Z'
- NatGatewayAddresses:
- - AllocationId: eipalloc-89c620ec
- NetworkInterfaceId: eni-9dec76cd
- PrivateIp: 10.0.0.149
- PublicIp: 198.11.222.333
- NatGatewayId: nat-05dba92075d71c408
- State: available
- SubnetId: subnet-847e4dc2
- VpcId: vpc-1a2b3c4d
- properties:
- natGatewaySet:
- allOf:
- - $ref: '#/components/schemas/NatGatewayList'
- - description: Information about the NAT gateways.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- NatGatewayId:
- type: string
- DescribeNetworkAclsResult:
- type: object
- example:
- NetworkAcls:
- - Associations:
- - NetworkAclAssociationId: aclassoc-66ea5f0b
- NetworkAclId: acl-9aeb5ef7
- SubnetId: subnet-65ea5f08
- Entries:
- - CidrBlock: 0.0.0.0/0
- Egress: true
- Protocol: '-1'
- RuleAction: deny
- RuleNumber: 32767
- - CidrBlock: 0.0.0.0/0
- Egress: false
- Protocol: '-1'
- RuleAction: deny
- RuleNumber: 32767
- IsDefault: false
- NetworkAclId: acl-5fb85d36
- Tags: []
- VpcId: vpc-a01106c2
- properties:
- networkAclSet:
- allOf:
- - $ref: '#/components/schemas/NetworkAclList'
- - description: Information about one or more network ACLs.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- NetworkAclId:
- type: string
- DescribeNetworkInsightsAccessScopeAnalysesResult:
- type: object
- properties:
- networkInsightsAccessScopeAnalysisSet:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisList'
- - description: The Network Access Scope analyses.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- NetworkInsightsAccessScopeAnalysisId:
- type: string
- DescribeNetworkInsightsAccessScopesResult:
- type: object
- properties:
- networkInsightsAccessScopeSet:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeList'
- - description: The Network Access Scopes.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- NetworkInsightsAccessScopeId:
- type: string
- DescribeNetworkInsightsAnalysesResult:
- type: object
- properties:
- networkInsightsAnalysisSet:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAnalysisList'
- - description: Information about the network insights analyses.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- NetworkInsightsAnalysisId:
- type: string
- DescribeNetworkInsightsPathsResult:
- type: object
- properties:
- networkInsightsPathSet:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsPathList'
- - description: Information about the paths.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- NetworkInsightsPathId:
- type: string
- DescribeNetworkInterfaceAttributeResult:
- type: object
- example:
- NetworkInterfaceId: eni-686ea200
- SourceDestCheck:
- Value: true
- properties:
- attachment:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceAttachment'
- - description: The attachment (if any) of the network interface.
- description:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: The description of the network interface.
- groupSet:
- allOf:
- - $ref: '#/components/schemas/GroupIdentifierList'
- - description: The security groups associated with the network interface.
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network interface.
- sourceDestCheck:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: Indicates whether source/destination checking is enabled.
- description: Contains the output of DescribeNetworkInterfaceAttribute.
- DescribeNetworkInterfacePermissionsResult:
- type: object
- properties:
- networkInterfacePermissions:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfacePermissionList'
- - description: The network interface permissions.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results.
- description: Contains the output for DescribeNetworkInterfacePermissions.
- NetworkInterfacePermissionId:
- type: string
- DescribeNetworkInterfacesResult:
- type: object
- example:
- NetworkInterfaces:
- - Association:
- AssociationId: eipassoc-0fbb766a
- IpOwnerId: '123456789012'
- PublicDnsName: ec2-203-0-113-12.compute-1.amazonaws.com
- PublicIp: 203.0.113.12
- Attachment:
- AttachTime: '2013-11-30T23:36:42.000Z'
- AttachmentId: eni-attach-66c4350a
- DeleteOnTermination: false
- DeviceIndex: 1
- InstanceId: i-1234567890abcdef0
- InstanceOwnerId: '123456789012'
- Status: attached
- AvailabilityZone: us-east-1d
- Description: my network interface
- Groups:
- - GroupId: sg-8637d3e3
- GroupName: default
- MacAddress: '02:2f:8f:b0:cf:75'
- NetworkInterfaceId: eni-e5aa89a3
- OwnerId: '123456789012'
- PrivateDnsName: ip-10-0-1-17.ec2.internal
- PrivateIpAddress: 10.0.1.17
- PrivateIpAddresses:
- - Association:
- AssociationId: eipassoc-0fbb766a
- IpOwnerId: '123456789012'
- PublicDnsName: ec2-203-0-113-12.compute-1.amazonaws.com
- PublicIp: 203.0.113.12
- Primary: true
- PrivateDnsName: ip-10-0-1-17.ec2.internal
- PrivateIpAddress: 10.0.1.17
- RequesterManaged: false
- SourceDestCheck: true
- Status: in-use
- SubnetId: subnet-b61f49f0
- TagSet: []
- VpcId: vpc-a01106c2
- properties:
- networkInterfaceSet:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceList'
- - description: Information about one or more network interfaces.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- description: Contains the output of DescribeNetworkInterfaces.
- DescribePlacementGroupsResult:
- type: object
- properties:
- placementGroupSet:
- allOf:
- - $ref: '#/components/schemas/PlacementGroupList'
- - description: Information about the placement groups.
- PlacementGroupName:
- type: string
- PlacementGroupId:
- type: string
- DescribePrefixListsResult:
- type: object
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- prefixListSet:
- allOf:
- - $ref: '#/components/schemas/PrefixListSet'
- - description: All available prefix lists.
- PrefixListResourceId:
- type: string
- DescribePrincipalIdFormatResult:
- type: object
- properties:
- principalSet:
- allOf:
- - $ref: '#/components/schemas/PrincipalIdFormatList'
- - description: Information about the ID format settings for the ARN.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribePublicIpv4PoolsResult:
- type: object
- properties:
- publicIpv4PoolSet:
- allOf:
- - $ref: '#/components/schemas/PublicIpv4PoolSet'
- - description: Information about the address pools.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Ipv4PoolEc2Id:
- type: string
- DescribeRegionsResult:
- type: object
- example:
- Regions:
- - Endpoint: ec2.ap-south-1.amazonaws.com
- RegionName: ap-south-1
- - Endpoint: ec2.eu-west-1.amazonaws.com
- RegionName: eu-west-1
- - Endpoint: ec2.ap-southeast-1.amazonaws.com
- RegionName: ap-southeast-1
- - Endpoint: ec2.ap-southeast-2.amazonaws.com
- RegionName: ap-southeast-2
- - Endpoint: ec2.eu-central-1.amazonaws.com
- RegionName: eu-central-1
- - Endpoint: ec2.ap-northeast-2.amazonaws.com
- RegionName: ap-northeast-2
- - Endpoint: ec2.ap-northeast-1.amazonaws.com
- RegionName: ap-northeast-1
- - Endpoint: ec2.us-east-1.amazonaws.com
- RegionName: us-east-1
- - Endpoint: ec2.sa-east-1.amazonaws.com
- RegionName: sa-east-1
- - Endpoint: ec2.us-west-1.amazonaws.com
- RegionName: us-west-1
- - Endpoint: ec2.us-west-2.amazonaws.com
- RegionName: us-west-2
- properties:
- regionInfo:
- allOf:
- - $ref: '#/components/schemas/RegionList'
- - description: Information about the Regions.
- DescribeReplaceRootVolumeTasksResult:
- type: object
- properties:
- replaceRootVolumeTaskSet:
- allOf:
- - $ref: '#/components/schemas/ReplaceRootVolumeTasks'
- - description: Information about the root volume replacement task.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- ReplaceRootVolumeTaskId:
- type: string
- DescribeReservedInstancesResult:
- type: object
- properties:
- reservedInstancesSet:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesList'
- - description: A list of Reserved Instances.
- description: Contains the output for DescribeReservedInstances.
- DescribeReservedInstancesListingsResult:
- type: object
- properties:
- reservedInstancesListingsSet:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesListingList'
- - description: Information about the Reserved Instance listing.
- description: Contains the output of DescribeReservedInstancesListings.
- DescribeReservedInstancesModificationsResult:
- type: object
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- reservedInstancesModificationsSet:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesModificationList'
- - description: The Reserved Instance modification information.
- description: Contains the output of DescribeReservedInstancesModifications.
- ReservedInstancesModificationId:
- type: string
- DescribeReservedInstancesOfferingsResult:
- type: object
- properties:
- reservedInstancesOfferingsSet:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesOfferingList'
- - description: A list of Reserved Instances offerings.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- description: Contains the output of DescribeReservedInstancesOfferings.
- ReservedInstancesOfferingId:
- type: string
- DescribeRouteTablesResult:
- type: object
- example:
- RouteTables:
- - Associations:
- - Main: true
- RouteTableAssociationId: rtbassoc-d8ccddba
- RouteTableId: rtb-1f382e7d
- PropagatingVgws: []
- RouteTableId: rtb-1f382e7d
- Routes:
- - DestinationCidrBlock: 10.0.0.0/16
- GatewayId: local
- State: active
- Tags: []
- VpcId: vpc-a01106c2
- properties:
- routeTableSet:
- allOf:
- - $ref: '#/components/schemas/RouteTableList'
- - description: Information about one or more route tables.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- description: Contains the output of DescribeRouteTables.
- DescribeScheduledInstanceAvailabilityResult:
- type: object
- example:
- ScheduledInstanceAvailabilitySet:
- - AvailabilityZone: us-west-2b
- AvailableInstanceCount: 20
- FirstSlotStartTime: '2016-01-31T00:00:00Z'
- HourlyPrice: '0.095'
- InstanceType: c4.large
- MaxTermDurationInDays: 366
- MinTermDurationInDays: 366
- NetworkPlatform: EC2-VPC
- Platform: Linux/UNIX
- PurchaseToken: eyJ2IjoiMSIsInMiOjEsImMiOi...
- Recurrence:
- Frequency: Weekly
- Interval: 1
- OccurrenceDaySet:
- - 1
- OccurrenceRelativeToEnd: false
- SlotDurationInHours: 23
- TotalScheduledInstanceHours: 1219
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token required to retrieve the next set of results. This value is null when there are no more results to return.
- scheduledInstanceAvailabilitySet:
- allOf:
- - $ref: '#/components/schemas/ScheduledInstanceAvailabilitySet'
- - description: Information about the available Scheduled Instances.
- description: Contains the output of DescribeScheduledInstanceAvailability.
- DateTime:
- type: string
- format: date-time
- DescribeScheduledInstancesResult:
- type: object
- example:
- ScheduledInstanceSet:
- - AvailabilityZone: us-west-2b
- CreateDate: '2016-01-25T21:43:38.612Z'
- HourlyPrice: '0.095'
- InstanceCount: 1
- InstanceType: c4.large
- NetworkPlatform: EC2-VPC
- NextSlotStartTime: '2016-01-31T09:00:00Z'
- Platform: Linux/UNIX
- Recurrence:
- Frequency: Weekly
- Interval: 1
- OccurrenceDaySet:
- - 1
- OccurrenceRelativeToEnd: false
- OccurrenceUnit: ''
- ScheduledInstanceId: sci-1234-1234-1234-1234-123456789012
- SlotDurationInHours: 32
- TermEndDate: '2017-01-31T09:00:00Z'
- TermStartDate: '2016-01-31T09:00:00Z'
- TotalScheduledInstanceHours: 1696
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token required to retrieve the next set of results. This value is null when there are no more results to return.
- scheduledInstanceSet:
- allOf:
- - $ref: '#/components/schemas/ScheduledInstanceSet'
- - description: Information about the Scheduled Instances.
- description: Contains the output of DescribeScheduledInstances.
- ScheduledInstanceId:
- type: string
- DescribeSecurityGroupReferencesResult:
- type: object
- example:
- SecurityGroupReferenceSet:
- - GroupId: sg-903004f8
- ReferencingVpcId: vpc-1a2b3c4d
- VpcPeeringConnectionId: pcx-b04deed9
- properties:
- securityGroupReferenceSet:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupReferences'
- - description: Information about the VPCs with the referencing security groups.
- DescribeSecurityGroupRulesResult:
- type: object
- properties:
- securityGroupRuleSet:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRuleList'
- - description: Information about security group rules.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
- DescribeSecurityGroupsResult:
- type: object
- example: {}
- properties:
- securityGroupInfo:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupList'
- - description: Information about the security groups.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- SecurityGroupName:
- type: string
- DescribeSnapshotAttributeResult:
- type: object
- example:
- CreateVolumePermissions: []
- SnapshotId: snap-066877671789bd71b
- properties:
- createVolumePermission:
- allOf:
- - $ref: '#/components/schemas/CreateVolumePermissionList'
- - description: The users and groups that have the permissions for creating volumes from the snapshot.
- productCodes:
- allOf:
- - $ref: '#/components/schemas/ProductCodeList'
- - description: The product codes.
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the EBS snapshot.
- DescribeSnapshotTierStatusResult:
- type: object
- properties:
- snapshotTierStatusSet:
- allOf:
- - $ref: '#/components/schemas/snapshotTierStatusSet'
- - description: Information about the snapshot's storage tier.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeSnapshotsResult:
- type: object
- example:
- NextToken: ''
- Snapshots:
- - Description: This is my copied snapshot.
- OwnerId: 012345678910
- Progress: 87%
- SnapshotId: snap-066877671789bd71b
- StartTime: '2014-02-28T21:37:27.000Z'
- State: pending
- VolumeId: vol-1234567890abcdef0
- VolumeSize: 8
- properties:
- snapshotSet:
- allOf:
- - $ref: '#/components/schemas/SnapshotList'
- - description: Information about the snapshots.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.'
- SnapshotId:
- type: string
- DescribeSpotDatafeedSubscriptionResult:
- type: object
- example:
- SpotDatafeedSubscription:
- Bucket: my-s3-bucket
- OwnerId: '123456789012'
- Prefix: spotdata
- State: Active
- properties:
- spotDatafeedSubscription:
- allOf:
- - $ref: '#/components/schemas/SpotDatafeedSubscription'
- - description: The Spot Instance data feed subscription.
- description: Contains the output of DescribeSpotDatafeedSubscription.
- DescribeSpotFleetInstancesResponse:
- type: object
- example:
- ActiveInstances:
- - InstanceId: i-1234567890abcdef0
- InstanceType: m3.medium
- SpotInstanceRequestId: sir-08b93456
- SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
- properties:
- activeInstanceSet:
- allOf:
- - $ref: '#/components/schemas/ActiveInstanceSet'
- - description: The running instances. This list is refreshed periodically and might be out of date.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token required to retrieve the next set of results. This value is null when there are no more results to return.
- spotFleetRequestId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Spot Fleet request.
- description: Contains the output of DescribeSpotFleetInstances.
- DescribeSpotFleetRequestHistoryResponse:
- type: object
- example:
- HistoryRecords:
- - EventInformation:
- EventSubType: submitted
- EventType: fleetRequestChange
- Timestamp: '2015-05-26T23:17:20.697Z'
- - EventInformation:
- EventSubType: active
- EventType: fleetRequestChange
- Timestamp: '2015-05-26T23:17:20.873Z'
- - EventInformation:
- EventSubType: launched
- InstanceId: i-1234567890abcdef0
- EventType: instanceChange
- Timestamp: '2015-05-26T23:21:21.712Z'
- - EventInformation:
- EventSubType: launched
- InstanceId: i-1234567890abcdef1
- EventType: instanceChange
- Timestamp: '2015-05-26T23:21:21.816Z'
- NextToken: CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=
- SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
- StartTime: '2015-05-26T00:00:00Z'
- properties:
- historyRecordSet:
- allOf:
- - $ref: '#/components/schemas/HistoryRecords'
- - description: Information about the events in the history of the Spot Fleet request.
- lastEvaluatedTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more results, this value is not present.
null when there are no more results to return.
- spotFleetRequestId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Spot Fleet request.
- startTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- description: Contains the output of DescribeSpotFleetRequestHistory.
- DescribeSpotFleetRequestsResponse:
- type: object
- example:
- SpotFleetRequestConfigs:
- - SpotFleetRequestConfig:
- IamFleetRole: 'arn:aws:iam::123456789012:role/my-spot-fleet-role'
- LaunchSpecifications:
- - EbsOptimized: false
- ImageId: ami-1a2b3c4d
- InstanceType: cc2.8xlarge
- NetworkInterfaces:
- - AssociatePublicIpAddress: true
- DeleteOnTermination: false
- DeviceIndex: 0
- SecondaryPrivateIpAddressCount: 0
- SubnetId: subnet-a61dafcf
- - EbsOptimized: false
- ImageId: ami-1a2b3c4d
- InstanceType: r3.8xlarge
- NetworkInterfaces:
- - AssociatePublicIpAddress: true
- DeleteOnTermination: false
- DeviceIndex: 0
- SecondaryPrivateIpAddressCount: 0
- SubnetId: subnet-a61dafcf
- SpotPrice: '0.05'
- TargetCapacity: 20
- SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
- SpotFleetRequestState: active
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token required to retrieve the next set of results. This value is null when there are no more results to return.
- spotFleetRequestConfigSet:
- allOf:
- - $ref: '#/components/schemas/SpotFleetRequestConfigSet'
- - description: Information about the configuration of your Spot Fleet.
- description: Contains the output of DescribeSpotFleetRequests.
- DescribeSpotInstanceRequestsResult:
- type: object
- example:
- SpotInstanceRequests:
- - CreateTime: '2014-04-30T18:14:55.000Z'
- InstanceId: i-1234567890abcdef0
- LaunchSpecification:
- BlockDeviceMappings:
- - DeviceName: /dev/sda1
- Ebs:
- DeleteOnTermination: true
- VolumeSize: 8
- VolumeType: standard
- EbsOptimized: false
- ImageId: ami-7aba833f
- InstanceType: m1.small
- KeyName: my-key-pair
- SecurityGroups:
- - GroupId: sg-e38f24a7
- GroupName: my-security-group
- LaunchedAvailabilityZone: us-west-1b
- ProductDescription: Linux/UNIX
- SpotInstanceRequestId: sir-08b93456
- SpotPrice: '0.010000'
- State: active
- Status:
- Code: fulfilled
- Message: Your Spot request is fulfilled.
- UpdateTime: '2014-04-30T18:16:21.000Z'
- Type: one-time
- properties:
- spotInstanceRequestSet:
- allOf:
- - $ref: '#/components/schemas/SpotInstanceRequestList'
- - description: One or more Spot Instance requests.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next set of results. This value is null when there are no more results to return.
- description: Contains the output of DescribeSpotInstanceRequests.
- DescribeSpotPriceHistoryResult:
- type: object
- example:
- SpotPriceHistory:
- - AvailabilityZone: us-west-1a
- InstanceType: m1.xlarge
- ProductDescription: Linux/UNIX (Amazon VPC)
- SpotPrice: '0.080000'
- Timestamp: '2014-01-06T04:32:53.000Z'
- - AvailabilityZone: us-west-1c
- InstanceType: m1.xlarge
- ProductDescription: Linux/UNIX (Amazon VPC)
- SpotPrice: '0.080000'
- Timestamp: '2014-01-05T11:28:26.000Z'
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return.
- spotPriceHistorySet:
- allOf:
- - $ref: '#/components/schemas/SpotPriceHistoryList'
- - description: The historical Spot prices.
- description: Contains the output of DescribeSpotPriceHistory.
- DescribeStaleSecurityGroupsResult:
- type: object
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.'
- staleSecurityGroupSet:
- allOf:
- - $ref: '#/components/schemas/StaleSecurityGroupSet'
- - description: Information about the stale security groups.
- DescribeStoreImageTasksResult:
- type: object
- properties:
- storeImageTaskResultSet:
- allOf:
- - $ref: '#/components/schemas/StoreImageTaskResultSet'
- - description: The information about the AMI store tasks.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeSubnetsResult:
- type: object
- example:
- Subnets:
- - AvailabilityZone: us-east-1c
- AvailableIpAddressCount: 251
- CidrBlock: 10.0.1.0/24
- DefaultForAz: false
- MapPublicIpOnLaunch: false
- State: available
- SubnetId: subnet-9d4a7b6c
- VpcId: vpc-a01106c2
- properties:
- subnetSet:
- allOf:
- - $ref: '#/components/schemas/SubnetList'
- - description: Information about one or more subnets.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeTagsResult:
- type: object
- example:
- Tags:
- - Key: Stack
- ResourceId: i-1234567890abcdef8
- ResourceType: instance
- Value: test
- - Key: Name
- ResourceId: i-1234567890abcdef8
- ResourceType: instance
- Value: Beta Server
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagDescriptionList'
- - description: The tags.
- DescribeTrafficMirrorFiltersResult:
- type: object
- properties:
- trafficMirrorFilterSet:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorFilterSet'
- - description: Information about one or more Traffic Mirror filters.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. The value is null when there are no more results to return.
- TrafficMirrorFilterId:
- type: string
- DescribeTrafficMirrorSessionsResult:
- type: object
- properties:
- trafficMirrorSessionSet:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorSessionSet'
- - description: 'Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.'
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. The value is null when there are no more results to return.
- TrafficMirrorSessionId:
- type: string
- DescribeTrafficMirrorTargetsResult:
- type: object
- properties:
- trafficMirrorTargetSet:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorTargetSet'
- - description: Information about one or more Traffic Mirror targets.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. The value is null when there are no more results to return.
- TrafficMirrorTargetId:
- type: string
- DescribeTransitGatewayAttachmentsResult:
- type: object
- properties:
- transitGatewayAttachments:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentList'
- - description: Information about the attachments.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- TransitGatewayAttachmentId:
- type: string
- DescribeTransitGatewayConnectPeersResult:
- type: object
- properties:
- transitGatewayConnectPeerSet:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnectPeerList'
- - description: Information about the Connect peers.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- TransitGatewayConnectPeerId:
- type: string
- DescribeTransitGatewayConnectsResult:
- type: object
- properties:
- transitGatewayConnectSet:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnectList'
- - description: Information about the Connect attachments.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeTransitGatewayMulticastDomainsResult:
- type: object
- properties:
- transitGatewayMulticastDomains:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomainList'
- - description: Information about the transit gateway multicast domains.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- TransitGatewayMulticastDomainId:
- type: string
- DescribeTransitGatewayPeeringAttachmentsResult:
- type: object
- properties:
- transitGatewayPeeringAttachments:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPeeringAttachmentList'
- - description: The transit gateway peering attachments.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeTransitGatewayRouteTablesResult:
- type: object
- properties:
- transitGatewayRouteTables:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableList'
- - description: Information about the transit gateway route tables.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- TransitGatewayRouteTableId:
- type: string
- DescribeTransitGatewayVpcAttachmentsResult:
- type: object
- properties:
- transitGatewayVpcAttachments:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayVpcAttachmentList'
- - description: Information about the VPC attachments.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeTransitGatewaysResult:
- type: object
- properties:
- transitGatewaySet:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayList'
- - description: Information about the transit gateways.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- TransitGatewayId:
- type: string
- DescribeTrunkInterfaceAssociationsResult:
- type: object
- properties:
- interfaceAssociationSet:
- allOf:
- - $ref: '#/components/schemas/TrunkInterfaceAssociationList'
- - description: Information about the trunk associations.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- TrunkInterfaceAssociationId:
- type: string
- DescribeVolumeAttributeResult:
- type: object
- example:
- AutoEnableIO:
- Value: false
- VolumeId: vol-049df61146c4d7901
- properties:
- autoEnableIO:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: The state of autoEnableIO attribute.
- productCodes:
- allOf:
- - $ref: '#/components/schemas/ProductCodeList'
- - description: A list of product codes.
- volumeId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the volume.
- DescribeVolumeStatusResult:
- type: object
- example:
- VolumeStatuses: []
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- volumeStatusSet:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusList'
- - description: Information about the status of the volumes.
- VolumeId:
- type: string
- DescribeVolumesResult:
- type: object
- example:
- Volumes:
- - Attachments:
- - AttachTime: '2013-12-18T22:35:00.000Z'
- DeleteOnTermination: true
- Device: /dev/sda1
- InstanceId: i-1234567890abcdef0
- State: attached
- VolumeId: vol-049df61146c4d7901
- AvailabilityZone: us-east-1a
- CreateTime: '2013-12-18T22:35:00.084Z'
- Size: 8
- SnapshotId: snap-1234567890abcdef0
- State: in-use
- VolumeId: vol-049df61146c4d7901
- VolumeType: standard
- properties:
- volumeSet:
- allOf:
- - $ref: '#/components/schemas/VolumeList'
- - description: Information about the volumes.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.'
- DescribeVolumesModificationsResult:
- type: object
- properties:
- volumeModificationSet:
- allOf:
- - $ref: '#/components/schemas/VolumeModificationList'
- - description: Information about the volume modifications.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Token for pagination, null if there are no more results '
- DescribeVpcAttributeResult:
- type: object
- example:
- EnableDnsHostnames:
- Value: true
- VpcId: vpc-a01106c2
- properties:
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- enableDnsHostnames:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: 'Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.'
- enableDnsSupport:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: 'Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.'
- DescribeVpcClassicLinkResult:
- type: object
- properties:
- vpcSet:
- allOf:
- - $ref: '#/components/schemas/VpcClassicLinkList'
- - description: The ClassicLink status of one or more VPCs.
- VpcId:
- type: string
- DescribeVpcClassicLinkDnsSupportResult:
- type: object
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportNextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- vpcs:
- allOf:
- - $ref: '#/components/schemas/ClassicLinkDnsSupportList'
- - description: Information about the ClassicLink DNS support status of the VPCs.
- DescribeVpcEndpointConnectionNotificationsResult:
- type: object
- properties:
- connectionNotificationSet:
- allOf:
- - $ref: '#/components/schemas/ConnectionNotificationSet'
- - description: One or more notifications.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeVpcEndpointConnectionsResult:
- type: object
- properties:
- vpcEndpointConnectionSet:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointConnectionSet'
- - description: Information about one or more VPC endpoint connections.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeVpcEndpointServiceConfigurationsResult:
- type: object
- properties:
- serviceConfigurationSet:
- allOf:
- - $ref: '#/components/schemas/ServiceConfigurationSet'
- - description: Information about one or more services.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeVpcEndpointServicePermissionsResult:
- type: object
- properties:
- allowedPrincipals:
- allOf:
- - $ref: '#/components/schemas/AllowedPrincipalSet'
- - description: Information about one or more allowed principals.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeVpcEndpointServicesResult:
- type: object
- properties:
- serviceNameSet:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: A list of supported services.
- serviceDetailSet:
- allOf:
- - $ref: '#/components/schemas/ServiceDetailSet'
- - description: Information about the service.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.'
- description: Contains the output of DescribeVpcEndpointServices.
- DescribeVpcEndpointsResult:
- type: object
- properties:
- vpcEndpointSet:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointSet'
- - description: Information about the endpoints.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.'
- description: Contains the output of DescribeVpcEndpoints.
- DescribeVpcPeeringConnectionsResult:
- type: object
- properties:
- vpcPeeringConnectionSet:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnectionList'
- - description: Information about the VPC peering connections.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- VpcPeeringConnectionId:
- type: string
- DescribeVpcsResult:
- type: object
- example:
- Vpcs:
- - CidrBlock: 10.0.0.0/16
- DhcpOptionsId: dopt-7a8b9c2d
- InstanceTenancy: default
- IsDefault: false
- State: available
- Tags:
- - Key: Name
- Value: MyVPC
- VpcId: vpc-a01106c2
- properties:
- vpcSet:
- allOf:
- - $ref: '#/components/schemas/VpcList'
- - description: Information about one or more VPCs.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- DescribeVpnConnectionsResult:
- type: object
- properties:
- vpnConnectionSet:
- allOf:
- - $ref: '#/components/schemas/VpnConnectionList'
- - description: Information about one or more VPN connections.
- description: Contains the output of DescribeVpnConnections.
- VpnConnectionId:
- type: string
- DescribeVpnGatewaysResult:
- type: object
- properties:
- vpnGatewaySet:
- allOf:
- - $ref: '#/components/schemas/VpnGatewayList'
- - description: Information about one or more virtual private gateways.
- description: Contains the output of DescribeVpnGateways.
- VpnGatewayId:
- type: string
- DetachClassicLinkVpcResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- DisableEbsEncryptionByDefaultResult:
- type: object
- properties:
- ebsEncryptionByDefault:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The updated status of encryption by default.
- DisableFastLaunchResult:
- type: object
- properties:
- imageId:
- allOf:
- - $ref: '#/components/schemas/ImageId'
- - description: The ID of the image for which faster-launching has been turned off.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/FastLaunchResourceType'
- - description: 'The pre-provisioning resource type that must be cleaned after turning off faster launching for the Windows AMI. Supported values include: snapshot.'
- snapshotConfiguration:
- allOf:
- - $ref: '#/components/schemas/FastLaunchSnapshotConfigurationResponse'
- - description: Parameters that were used for faster launching for the Windows AMI before faster launching was turned off. This informs the clean-up process.
- launchTemplate:
- allOf:
- - $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationResponse'
- - description: The launch template that was used to launch Windows instances from pre-provisioned snapshots.
- maxParallelLaunches:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The maximum number of parallel instances to launch for creating resources.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The owner of the Windows AMI for which faster launching was turned off.
- state:
- allOf:
- - $ref: '#/components/schemas/FastLaunchStateCode'
- - description: The current state of faster launching for the specified Windows AMI.
- stateTransitionReason:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The reason that the state changed for faster launching for the Windows AMI.
- stateTransitionTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time that the state changed for faster launching for the Windows AMI.
- DisableFastSnapshotRestoresResult:
- type: object
- properties:
- successful:
- allOf:
- - $ref: '#/components/schemas/DisableFastSnapshotRestoreSuccessSet'
- - description: Information about the snapshots for which fast snapshot restores were successfully disabled.
- unsuccessful:
- allOf:
- - $ref: '#/components/schemas/DisableFastSnapshotRestoreErrorSet'
- - description: Information about the snapshots for which fast snapshot restores could not be disabled.
- DisableImageDeprecationResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- DisableIpamOrganizationAdminAccountResult:
- type: object
- properties:
- success:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The result of disabling the IPAM account.
- DisableSerialConsoleAccessResult:
- type: object
- properties:
- serialConsoleAccessEnabled:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.'
- DisableTransitGatewayRouteTablePropagationResult:
- type: object
- properties:
- propagation:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPropagation'
- - description: Information about route propagation.
- DisableVpcClassicLinkResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- DisableVpcClassicLinkDnsSupportResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- DisassociateClientVpnTargetNetworkResult:
- type: object
- properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the target network association.
- status:
- allOf:
- - $ref: '#/components/schemas/AssociationStatus'
- - description: The current state of the target network association.
- DisassociateEnclaveCertificateIamRoleResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- DisassociateIamInstanceProfileResult:
- type: object
- example:
- IamInstanceProfileAssociation:
- AssociationId: iip-assoc-05020b59952902f5f
- IamInstanceProfile:
- Arn: 'arn:aws:iam::123456789012:instance-profile/admin-role'
- Id: AIPAI5IVIHMFFYY2DKV5Y
- InstanceId: i-123456789abcde123
- State: disassociating
- properties:
- iamInstanceProfileAssociation:
- allOf:
- - $ref: '#/components/schemas/IamInstanceProfileAssociation'
- - description: Information about the IAM instance profile association.
- DisassociateInstanceEventWindowResult:
- type: object
- properties:
- instanceEventWindow:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindow'
- - description: Information about the event window.
- DisassociateSubnetCidrBlockResult:
- type: object
- properties:
- ipv6CidrBlockAssociation:
- allOf:
- - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation'
- - description: Information about the IPv6 CIDR block association.
- subnetId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the subnet.
- DisassociateTransitGatewayMulticastDomainResult:
- type: object
- properties:
- associations:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
- - description: Information about the association.
- DisassociateTransitGatewayRouteTableResult:
- type: object
- properties:
- association:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAssociation'
- - description: Information about the association.
- DisassociateTrunkInterfaceResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.'
- DisassociateVpcCidrBlockResult:
- type: object
- properties:
- ipv6CidrBlockAssociation:
- allOf:
- - $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation'
- - description: Information about the IPv6 CIDR block association.
- cidrBlockAssociation:
- allOf:
- - $ref: '#/components/schemas/VpcCidrBlockAssociation'
- - description: Information about the IPv4 CIDR block association.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- EnableEbsEncryptionByDefaultResult:
- type: object
- properties:
- ebsEncryptionByDefault:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The updated status of encryption by default.
- EnableFastLaunchResult:
- type: object
- properties:
- imageId:
- allOf:
- - $ref: '#/components/schemas/ImageId'
- - description: The image ID that identifies the Windows AMI for which faster launching was enabled.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/FastLaunchResourceType'
- - description: The type of resource that was defined for pre-provisioning the Windows AMI for faster launching.
- snapshotConfiguration:
- allOf:
- - $ref: '#/components/schemas/FastLaunchSnapshotConfigurationResponse'
- - description: The configuration settings that were defined for creating and managing the pre-provisioned snapshots for faster launching of the Windows AMI. This property is returned when the associated resourceType is snapshot.
- launchTemplate:
- allOf:
- - $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationResponse'
- - description: The launch template that is used when launching Windows instances from pre-provisioned snapshots.
- maxParallelLaunches:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The maximum number of parallel instances to launch for creating resources.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The owner ID for the Windows AMI for which faster launching was enabled.
- state:
- allOf:
- - $ref: '#/components/schemas/FastLaunchStateCode'
- - description: The current state of faster launching for the specified Windows AMI.
- stateTransitionReason:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The reason that the state changed for faster launching for the Windows AMI.
- stateTransitionTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time that the state changed for faster launching for the Windows AMI.
- EnableFastSnapshotRestoresResult:
- type: object
- properties:
- successful:
- allOf:
- - $ref: '#/components/schemas/EnableFastSnapshotRestoreSuccessSet'
- - description: Information about the snapshots for which fast snapshot restores were successfully enabled.
- unsuccessful:
- allOf:
- - $ref: '#/components/schemas/EnableFastSnapshotRestoreErrorSet'
- - description: Information about the snapshots for which fast snapshot restores could not be enabled.
- EnableImageDeprecationResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- EnableIpamOrganizationAdminAccountResult:
- type: object
- properties:
- success:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The result of enabling the IPAM account.
- EnableSerialConsoleAccessResult:
- type: object
- properties:
- serialConsoleAccessEnabled:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.'
- EnableTransitGatewayRouteTablePropagationResult:
- type: object
- properties:
- propagation:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPropagation'
- - description: Information about route propagation.
- EnableVpcClassicLinkResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- EnableVpcClassicLinkDnsSupportResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- ExportClientVpnClientCertificateRevocationListResult:
- type: object
- properties:
- certificateRevocationList:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Information about the client certificate revocation list.
- status:
- allOf:
- - $ref: '#/components/schemas/ClientCertificateRevocationListStatus'
- - description: The current state of the client certificate revocation list.
- ExportClientVpnClientConfigurationResult:
- type: object
- properties:
- clientConfiguration:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The contents of the Client VPN endpoint configuration file.
- ExportImageResult:
- type: object
- properties:
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the image being exported.
- diskImageFormat:
- allOf:
- - $ref: '#/components/schemas/DiskImageFormat'
- - description: The disk image format for the exported image.
- exportImageTaskId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the export image task.
- imageId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the image.
- roleName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
- progress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The percent complete of the export image task.
- s3ExportLocation:
- allOf:
- - $ref: '#/components/schemas/ExportTaskS3Location'
- - description: Information about the destination Amazon S3 bucket.
- status:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The status of the export image task. The possible values are active, completed, deleting, and deleted.'
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The status message for the export image task.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the export image task.
- ExportTransitGatewayRoutesResult:
- type: object
- properties:
- s3Location:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.'
- GetAssociatedEnclaveCertificateIamRolesResult:
- type: object
- properties:
- associatedRoleSet:
- allOf:
- - $ref: '#/components/schemas/AssociatedRolesList'
- - description: Information about the associated IAM roles.
- GetAssociatedIpv6PoolCidrsResult:
- type: object
- properties:
- ipv6CidrAssociationSet:
- allOf:
- - $ref: '#/components/schemas/Ipv6CidrAssociationSet'
- - description: Information about the IPv6 CIDR block associations.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- GetCapacityReservationUsageResult:
- type: object
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- capacityReservationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Capacity Reservation.
- instanceType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The type of instance for which the Capacity Reservation reserves capacity.
- totalInstanceCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of instances for which the Capacity Reservation reserves capacity.
- availableInstanceCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
- state:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationState'
- - description: 'The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active - The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
null when there are no more results to return.
- capacityReservationGroupSet:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationGroupSet'
- - description: Information about the resource groups to which the Capacity Reservation has been added.
- GetHostReservationPurchasePreviewResult:
- type: object
- properties:
- currencyCode:
- allOf:
- - $ref: '#/components/schemas/CurrencyCodeValues'
- - description: 'The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.'
- purchase:
- allOf:
- - $ref: '#/components/schemas/PurchaseSet'
- - description: The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
- totalHourlyPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The potential total hourly price of the reservation per hour.
- totalUpfrontPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The potential total upfront price. This is billed immediately.
- GetInstanceTypesFromInstanceRequirementsResult:
- type: object
- properties:
- instanceTypeSet:
- allOf:
- - $ref: '#/components/schemas/InstanceTypeInfoFromInstanceRequirementsSet'
- - description: The instance types with the specified instance attributes.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next set of results.
- ArchitectureType:
- type: string
- enum:
- - i386
- - x86_64
- - arm64
- - x86_64_mac
- VirtualizationType:
- type: string
- enum:
- - hvm
- - paravirtual
- MemoryMiBRequest:
- type: object
- required:
- - Min
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.'
- description: 'The minimum and maximum amount of memory, in MiB.'
- MemoryGiBPerVCpuRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: 'The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.'
- description: 'The minimum and maximum amount of memory per vCPU, in GiB.'
- ExcludedInstanceTypeSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ExcludedInstanceType'
- - xml:
- name: item
- minItems: 0
- maxItems: 400
- LocalStorage:
- type: string
- enum:
- - included
- - required
- - excluded
- BaselineEbsBandwidthMbpsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.'
- description: 'The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.'
- AcceleratorCountRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0.'
- description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set Max to 0.'
- AcceleratorManufacturerSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AcceleratorManufacturer'
- - xml:
- name: item
- AcceleratorTotalMemoryMiBRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.'
- description: 'The minimum and maximum amount of total accelerator memory, in MiB.'
- GetInstanceUefiDataResult:
- type: object
- properties:
- instanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of the instance from which to retrieve the UEFI data.
- uefiData:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Base64 representation of the non-volatile UEFI variable store.
- GetIpamAddressHistoryResult:
- type: object
- properties:
- historyRecordSet:
- allOf:
- - $ref: '#/components/schemas/IpamAddressHistoryRecordSet'
- - description: 'A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.'
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- GetIpamPoolAllocationsResult:
- type: object
- properties:
- ipamPoolAllocationSet:
- allOf:
- - $ref: '#/components/schemas/IpamPoolAllocationSet'
- - description: The IPAM pool allocations you want information on.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- GetIpamPoolCidrsResult:
- type: object
- properties:
- ipamPoolCidrSet:
- allOf:
- - $ref: '#/components/schemas/IpamPoolCidrSet'
- - description: Information about the CIDRs provisioned to an IPAM pool.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- GetIpamResourceCidrsResult:
- type: object
- properties:
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- ipamResourceCidrSet:
- allOf:
- - $ref: '#/components/schemas/IpamResourceCidrSet'
- - description: The resource CIDRs.
- GetLaunchTemplateDataResult:
- type: object
- example:
- LaunchTemplateData:
- BlockDeviceMappings:
- - DeviceName: /dev/xvda
- Ebs:
- DeleteOnTermination: true
- Encrypted: false
- Iops: 100
- SnapshotId: snap-02594938353ef77d3
- VolumeSize: 8
- VolumeType: gp2
- EbsOptimized: false
- ImageId: ami-32cf7b4a
- InstanceType: t2.medium
- KeyName: my-key-pair
- Monitoring:
- Enabled: false
- NetworkInterfaces:
- - AssociatePublicIpAddress: false
- DeleteOnTermination: true
- Description: ''
- DeviceIndex: 0
- Groups:
- - sg-d14e1bb4
- Ipv6Addresses: []
- NetworkInterfaceId: eni-4338b5a9
- PrivateIpAddress: 10.0.3.233
- PrivateIpAddresses:
- - Primary: true
- PrivateIpAddress: 10.0.3.233
- SubnetId: subnet-5264e837
- Placement:
- AvailabilityZone: us-east-2b
- GroupName: ''
- Tenancy: default
- properties:
- launchTemplateData:
- allOf:
- - $ref: '#/components/schemas/ResponseLaunchTemplateData'
- - description: The instance data.
- GetManagedPrefixListAssociationsResult:
- type: object
- properties:
- prefixListAssociationSet:
- allOf:
- - $ref: '#/components/schemas/PrefixListAssociationSet'
- - description: Information about the associations.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- GetManagedPrefixListEntriesResult:
- type: object
- properties:
- entrySet:
- allOf:
- - $ref: '#/components/schemas/PrefixListEntrySet'
- - description: Information about the prefix list entries.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- GetNetworkInsightsAccessScopeAnalysisFindingsResult:
- type: object
- properties:
- networkInsightsAccessScopeAnalysisId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
- - description: The ID of the Network Access Scope analysis.
- analysisStatus:
- allOf:
- - $ref: '#/components/schemas/AnalysisStatus'
- - description: The status of Network Access Scope Analysis.
- analysisFindingSet:
- allOf:
- - $ref: '#/components/schemas/AccessScopeAnalysisFindingList'
- - description: The findings associated with Network Access Scope Analysis.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- GetNetworkInsightsAccessScopeContentResult:
- type: object
- properties:
- networkInsightsAccessScopeContent:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeContent'
- - description: The Network Access Scope content.
- GetPasswordDataResult:
- type: object
- properties:
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Windows instance.
- passwordData:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The password of the instance. Returns an empty string if the password is not available.
- timestamp:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time the data was last updated.
- GetReservedInstancesExchangeQuoteResult:
- type: object
- properties:
- currencyCode:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The currency of the transaction.
- isValidExchange:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If true, the exchange is valid. If false, the exchange cannot be completed.'
- outputReservedInstancesWillExpireAt:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The new end date of the reservation term.
- paymentDue:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The total true upfront charge for the exchange.
- reservedInstanceValueRollup:
- allOf:
- - $ref: '#/components/schemas/ReservationValue'
- - description: The cost associated with the Reserved Instance.
- reservedInstanceValueSet:
- allOf:
- - $ref: '#/components/schemas/ReservedInstanceReservationValueSet'
- - description: The configuration of your Convertible Reserved Instances.
- targetConfigurationValueRollup:
- allOf:
- - $ref: '#/components/schemas/ReservationValue'
- - description: The cost associated with the Reserved Instance.
- targetConfigurationValueSet:
- allOf:
- - $ref: '#/components/schemas/TargetReservationValueSet'
- - description: The values of the target Convertible Reserved Instances.
- validationFailureReason:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Describes the reason why the exchange cannot be completed.
- description: Contains the output of GetReservedInstancesExchangeQuote.
- GetSerialConsoleAccessStatusResult:
- type: object
- properties:
- serialConsoleAccessEnabled:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.'
- GetSpotPlacementScoresResult:
- type: object
- properties:
- spotPlacementScoreSet:
- allOf:
- - $ref: '#/components/schemas/SpotPlacementScores'
- - description: 'The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale from 1 to 10. Each score
reflects how likely it is that each Region or Availability Zone will succeed at fulfilling the specified target capacity
at the time of the Spot placement score request. A score of 10 means that your Spot capacity request is highly likely to succeed in that Region or Availability Zone.
If you request a Spot placement score for Regions, a high score assumes that your fleet request will be configured to use all Availability Zones and the capacity-optimized allocation strategy. If you request a Spot placement score for Availability Zones, a high score assumes that your fleet request will be configured to use a single Availability Zone and the capacity-optimized allocation strategy.
Different Regions or Availability Zones might return the same score.
The Spot placement score serves as a recommendation only. No score guarantees that your Spot request will be fully or partially fulfilled.
The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
' - ExcludedInstanceType: - allOf: - - $ref: '#/components/schemas/ExcludedInstanceTypeSet' - - description: 'The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
Default: No excluded instance types
' - InstanceGeneration: - allOf: - - $ref: '#/components/schemas/LocalStorage' - - description: 'Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
To include instance types with instance store volumes, specify included.
To require only instance types with instance store volumes, specify required.
To exclude instance types with instance store volumes, specify excluded.
Default: included
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
' - AcceleratorType: - allOf: - - $ref: '#/components/schemas/AcceleratorCountRequest' - - description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
' - AcceleratorManufacturer: - allOf: - - $ref: '#/components/schemas/AcceleratorManufacturerSet' - - description: 'Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
' - AcceleratorName: - allOf: - - $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest' - - description: 'The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
' - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
You must specify VCpuCount and MemoryMiB. All other parameters are optional. Any unspecified optional parameter is set to its default.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
' - GetSubnetCidrReservationsResult: - type: object - properties: - subnetIpv4CidrReservationSet: - allOf: - - $ref: '#/components/schemas/SubnetCidrReservationList' - - description: Information about the IPv4 subnet CIDR reservations. - subnetIpv6CidrReservationSet: - allOf: - - $ref: '#/components/schemas/SubnetCidrReservationList' - - description: Information about the IPv6 subnet CIDR reservations. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value isnull when there are no more results to return.
- GetTransitGatewayAttachmentPropagationsResult:
- type: object
- properties:
- transitGatewayAttachmentPropagations:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentPropagationList'
- - description: Information about the propagation route tables.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- GetTransitGatewayMulticastDomainAssociationsResult:
- type: object
- properties:
- multicastDomainAssociations:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociationList'
- - description: Information about the multicast domain associations.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- GetTransitGatewayPrefixListReferencesResult:
- type: object
- properties:
- transitGatewayPrefixListReferenceSet:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPrefixListReferenceSet'
- - description: Information about the prefix list references.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- GetTransitGatewayRouteTableAssociationsResult:
- type: object
- properties:
- associations:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableAssociationList'
- - description: Information about the associations.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- GetTransitGatewayRouteTablePropagationsResult:
- type: object
- properties:
- transitGatewayRouteTablePropagations:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTablePropagationList'
- - description: Information about the route table propagations.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- GetVpnConnectionDeviceSampleConfigurationResult:
- type: object
- properties:
- vpnConnectionDeviceSampleConfiguration:
- allOf:
- - $ref: '#/components/schemas/VpnConnectionDeviceSampleConfiguration'
- - description: Sample configuration file for the specified customer gateway device.
- GetVpnConnectionDeviceTypesResult:
- type: object
- properties:
- vpnConnectionDeviceTypeSet:
- allOf:
- - $ref: '#/components/schemas/VpnConnectionDeviceTypeList'
- - description: List of customer gateway devices that have a sample configuration file available for use.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: 'The NextToken value to include in a future GetVpnConnectionDeviceTypes request. When the results of a GetVpnConnectionDeviceTypes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.'
- ImportClientVpnClientCertificateRevocationListResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- ImportImageResult:
- type: object
- properties:
- architecture:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The architecture of the virtual machine.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the import task.
- encrypted:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the AMI is encrypted.
- hypervisor:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The target hypervisor of the import task.
- imageId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Machine Image (AMI) created by the import task.
- importTaskId:
- allOf:
- - $ref: '#/components/schemas/ImportImageTaskId'
- - description: The task ID of the import image task.
- kmsKeyId:
- allOf:
- - $ref: '#/components/schemas/KmsKeyId'
- - description: The identifier for the symmetric KMS key that was used to create the encrypted AMI.
- licenseType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The license type of the virtual machine.
- platform:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The operating system of the virtual machine.
- progress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The progress of the task.
- snapshotDetailSet:
- allOf:
- - $ref: '#/components/schemas/SnapshotDetailList'
- - description: Information about the snapshots.
- status:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A brief status of the task.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A detailed status message of the import task.
- licenseSpecifications:
- allOf:
- - $ref: '#/components/schemas/ImportImageLicenseSpecificationListResponse'
- - description: The ARNs of the license configurations.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the import image task.
- usageOperation:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The usage operation value.
- ImageDiskContainer:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/UserBucket'
- - description: The S3 bucket for the disk image.
- description: Describes the disk container object for an import image task.
- ImportImageLicenseConfigurationRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ARN of a license configuration.
- description: The request information of license configurations.
- ImportInstanceResult:
- type: object
- properties:
- conversionTask:
- allOf:
- - $ref: '#/components/schemas/ConversionTask'
- - description: Information about the conversion task.
- DiskImage:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VolumeDetail'
- - description: Information about the volume.
- description: Describes a disk image.
- ArchitectureValues:
- type: string
- enum:
- - i386
- - x86_64
- - arm64
- - x86_64_mac
- SecurityGroupStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupName'
- - xml:
- name: SecurityGroup
- ShutdownBehavior:
- type: string
- enum:
- - stop
- - terminate
- Placement:
- type: object
- properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet.
' - affinity: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
' - groupName: - allOf: - - $ref: '#/components/schemas/PlacementGroupName' - - description: The name of the placement group the instance is in. - partitionNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.
This parameter is not supported by CreateFleet.
' - hostId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
' - tenancy: - allOf: - - $ref: '#/components/schemas/Tenancy' - - description: 'The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
T3 instances that use the unlimited CPU credit option do not support host tenancy.
Reserved for future use.
This parameter is not supported by CreateFleet.
' - hostResourceGroupArn: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
This parameter is not supported by CreateFleet.
' - description: Describes the placement of an instance. - UserData: - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The user data. If you are using an Amazon Web Services SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.' - description: Describes the user data for an instance. - ImportKeyPairResult: - type: object - properties: - keyFingerprint: - allOf: - - $ref: '#/components/schemas/String' - - description: 'For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
null when there are no more results to return.
- ListSnapshotsInRecycleBinResult:
- type: object
- properties:
- snapshotSet:
- allOf:
- - $ref: '#/components/schemas/SnapshotRecycleBinInfoList'
- - description: Information about the snapshots.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- ModifyAddressAttributeResult:
- type: object
- properties:
- address:
- allOf:
- - $ref: '#/components/schemas/AddressAttribute'
- - description: Information about the Elastic IP address.
- ModifyAvailabilityZoneGroupResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Is true if the request succeeds, and an error otherwise.'
- ModifyCapacityReservationResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- ModifyCapacityReservationFleetResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- ModifyClientVpnEndpointResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- ModifyDefaultCreditSpecificationResult:
- type: object
- properties:
- instanceFamilyCreditSpecification:
- allOf:
- - $ref: '#/components/schemas/InstanceFamilyCreditSpecification'
- - description: The default credit option for CPU usage of the instance family.
- ModifyEbsDefaultKmsKeyIdResult:
- type: object
- properties:
- kmsKeyId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
- ModifyFleetResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.'
- ModifyFpgaImageAttributeResult:
- type: object
- properties:
- fpgaImageAttribute:
- allOf:
- - $ref: '#/components/schemas/FpgaImageAttribute'
- - description: Information about the attribute.
- LoadPermissionListRequest:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LoadPermissionRequest'
- - xml:
- name: item
- ModifyHostsResult:
- type: object
- properties:
- successful:
- allOf:
- - $ref: '#/components/schemas/ResponseHostIdList'
- - description: The IDs of the Dedicated Hosts that were successfully modified.
- unsuccessful:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulItemList'
- - description: The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.
- LaunchPermissionList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LaunchPermission'
- - xml:
- name: item
- InstanceBlockDeviceMappingSpecification:
- type: object
- properties:
- deviceName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The device name (for example, /dev/sdh or xvdh).'
- ebs:
- allOf:
- - $ref: '#/components/schemas/EbsInstanceBlockDeviceSpecification'
- - description: Parameters used to automatically set up EBS volumes when the instance is launched.
- noDevice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: suppress the specified device included in the block device mapping.
- virtualName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The virtual device name.
- description: Describes a block device mapping entry.
- Blob:
- type: string
- ModifyInstanceCapacityReservationAttributesResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- CapacityReservationTarget:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ARN of the Capacity Reservation resource group in which to run the instance.
- description: Describes a target Capacity Reservation or Capacity Reservation group.
- ModifyInstanceCreditSpecificationResult:
- type: object
- properties:
- successfulInstanceCreditSpecificationSet:
- allOf:
- - $ref: '#/components/schemas/SuccessfulInstanceCreditSpecificationSet'
- - description: Information about the instances whose credit option for CPU usage was successfully modified.
- unsuccessfulInstanceCreditSpecificationSet:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationSet'
- - description: Information about the instances whose credit option for CPU usage was not modified.
- InstanceCreditSpecificationRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The credit option for CPU usage of the instance. Valid values are standard and unlimited.
T3 instances with host tenancy do not support the unlimited CPU credit option.
true if the request succeeds, and an error otherwise.'
- ModifyIpamResult:
- type: object
- properties:
- ipam:
- allOf:
- - $ref: '#/components/schemas/Ipam'
- - description: The results of the modification.
- RemoveIpamOperatingRegion:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the operating Region you want to remove.
- description: 'Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide
' - ModifyIpamPoolResult: - type: object - properties: - ipamPool: - allOf: - - $ref: '#/components/schemas/IpamPool' - - description: The results of the modification. - ModifyIpamResourceCidrResult: - type: object - properties: - ipamResourceCidr: - $ref: '#/components/schemas/IpamResourceCidr' - ModifyIpamScopeResult: - type: object - properties: - ipamScope: - allOf: - - $ref: '#/components/schemas/IpamScope' - - description: The results of the modification. - ModifyLaunchTemplateResult: - type: object - example: - LaunchTemplate: - CreateTime: '2017-12-01T13:35:46.000Z' - CreatedBy: 'arn:aws:iam::123456789012:root' - DefaultVersionNumber: 2 - LatestVersionNumber: 2 - LaunchTemplateId: lt-0abcd290751193123 - LaunchTemplateName: WebServers - properties: - launchTemplate: - allOf: - - $ref: '#/components/schemas/LaunchTemplate' - - description: Information about the launch template. - ModifyManagedPrefixListResult: - type: object - properties: - prefixList: - allOf: - - $ref: '#/components/schemas/ManagedPrefixList' - - description: Information about the prefix list. - RemovePrefixListEntry: - type: object - required: - - Cidr - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR block. - description: An entry for a prefix list. - NetworkInterfaceAttachmentId: - type: string - ModifyPrivateDnsNameOptionsResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returnstrue if the request succeeds; otherwise, it returns an error.'
- ModifyReservedInstancesResult:
- type: object
- properties:
- reservedInstancesModificationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID for the modification.
- description: Contains the output of ModifyReservedInstances.
- ReservedInstancesConfiguration:
- type: object
- properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone for the modified Reserved Instances.
- instanceCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of modified Reserved Instances.
This is a required field for a request.
true if the request succeeds; otherwise, returns an error.'
- SecurityGroupRuleUpdate:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRuleRequest'
- - description: Information about the security group rule.
- description: Describes an update to a security group rule.
- CreateVolumePermissionList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CreateVolumePermission'
- - xml:
- name: item
- ModifySnapshotTierResult:
- type: object
- properties:
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the snapshot.
- tieringStartTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The date and time when the archive process was started.
- ModifySpotFleetRequestResponse:
- type: object
- example:
- Return: true
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.'
- description: Contains the output of ModifySpotFleetRequest.
- LaunchTemplateConfig:
- type: object
- properties:
- launchTemplateSpecification:
- allOf:
- - $ref: '#/components/schemas/FleetLaunchTemplateSpecification'
- - description: The launch template.
- overrides:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateOverridesList'
- - description: Any parameters that you specify override the same parameters in the launch template.
- description: Describes a launch template and overrides.
- ModifyTrafficMirrorFilterNetworkServicesResult:
- type: object
- properties:
- trafficMirrorFilter:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorFilter'
- - description: The Traffic Mirror filter that the network service is associated with.
- TrafficMirrorNetworkService:
- type: string
- enum:
- - amazon-dns
- ModifyTrafficMirrorFilterRuleResult:
- type: object
- properties:
- trafficMirrorFilterRule:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorFilterRule'
- - description: Modifies a Traffic Mirror rule.
- TrafficMirrorFilterRuleField:
- type: string
- enum:
- - destination-port-range
- - source-port-range
- - protocol
- - description
- ModifyTrafficMirrorSessionResult:
- type: object
- properties:
- trafficMirrorSession:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorSession'
- - description: Information about the Traffic Mirror session.
- TrafficMirrorSessionField:
- type: string
- enum:
- - packet-length
- - description
- - virtual-network-id
- ModifyTransitGatewayResult:
- type: object
- properties:
- transitGateway:
- $ref: '#/components/schemas/TransitGateway'
- ModifyTransitGatewayPrefixListReferenceResult:
- type: object
- properties:
- transitGatewayPrefixListReference:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPrefixListReference'
- - description: Information about the prefix list reference.
- ModifyTransitGatewayVpcAttachmentResult:
- type: object
- properties:
- transitGatewayVpcAttachment:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- - description: Information about the modified attachment.
- ModifyVolumeResult:
- type: object
- properties:
- volumeModification:
- allOf:
- - $ref: '#/components/schemas/VolumeModification'
- - description: Information about the volume modification.
- ModifyVpcEndpointResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- ModifyVpcEndpointConnectionNotificationResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- ModifyVpcEndpointServiceConfigurationResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- ModifyVpcEndpointServicePayerResponsibilityResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- ModifyVpcEndpointServicePermissionsResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- ModifyVpcPeeringConnectionOptionsResult:
- type: object
- properties:
- accepterPeeringConnectionOptions:
- allOf:
- - $ref: '#/components/schemas/PeeringConnectionOptions'
- - description: Information about the VPC peering connection options for the accepter VPC.
- requesterPeeringConnectionOptions:
- allOf:
- - $ref: '#/components/schemas/PeeringConnectionOptions'
- - description: Information about the VPC peering connection options for the requester VPC.
- ModifyVpcTenancyResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, returns an error.'
- ModifyVpnConnectionResult:
- type: object
- properties:
- vpnConnection:
- $ref: '#/components/schemas/VpnConnection'
- ModifyVpnConnectionOptionsResult:
- type: object
- properties:
- vpnConnection:
- $ref: '#/components/schemas/VpnConnection'
- ModifyVpnTunnelCertificateResult:
- type: object
- properties:
- vpnConnection:
- $ref: '#/components/schemas/VpnConnection'
- ModifyVpnTunnelOptionsResult:
- type: object
- properties:
- vpnConnection:
- $ref: '#/components/schemas/VpnConnection'
- Phase1EncryptionAlgorithmsRequestList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsRequestListValue'
- - xml:
- name: item
- Phase2EncryptionAlgorithmsRequestList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsRequestListValue'
- - xml:
- name: item
- Phase1IntegrityAlgorithmsRequestList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsRequestListValue'
- - xml:
- name: item
- Phase2IntegrityAlgorithmsRequestList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsRequestListValue'
- - xml:
- name: item
- Phase1DHGroupNumbersRequestList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Phase1DHGroupNumbersRequestListValue'
- - xml:
- name: item
- Phase2DHGroupNumbersRequestList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Phase2DHGroupNumbersRequestListValue'
- - xml:
- name: item
- MonitorInstancesResult:
- type: object
- properties:
- instancesSet:
- allOf:
- - $ref: '#/components/schemas/InstanceMonitoringList'
- - description: The monitoring information.
- MoveAddressToVpcResult:
- type: object
- example:
- Status: MoveInProgress
- properties:
- allocationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The allocation ID for the Elastic IP address.
- status:
- allOf:
- - $ref: '#/components/schemas/Status'
- - description: The status of the move of the IP address.
- MoveByoipCidrToIpamResult:
- type: object
- properties:
- byoipCidr:
- $ref: '#/components/schemas/ByoipCidr'
- ProvisionByoipCidrResult:
- type: object
- properties:
- byoipCidr:
- allOf:
- - $ref: '#/components/schemas/ByoipCidr'
- - description: Information about the address range.
- ProvisionIpamPoolCidrResult:
- type: object
- properties:
- ipamPoolCidr:
- allOf:
- - $ref: '#/components/schemas/IpamPoolCidr'
- - description: Information about the provisioned CIDR.
- ProvisionPublicIpv4PoolCidrResult:
- type: object
- properties:
- poolId:
- allOf:
- - $ref: '#/components/schemas/Ipv4PoolEc2Id'
- - description: The ID of the pool that you want to provision the CIDR to.
- poolAddressRange:
- $ref: '#/components/schemas/PublicIpv4PoolRange'
- PurchaseHostReservationResult:
- type: object
- properties:
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
- currencyCode:
- allOf:
- - $ref: '#/components/schemas/CurrencyCodeValues'
- - description: 'The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.'
- purchase:
- allOf:
- - $ref: '#/components/schemas/PurchaseSet'
- - description: Describes the details of the purchase.
- totalHourlyPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The total hourly price of the reservation calculated per hour.
- totalUpfrontPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The total amount charged to your account when you purchase the reservation.
- PurchaseReservedInstancesOfferingResult:
- type: object
- properties:
- reservedInstancesId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing pricing tiers in the Amazon Elastic Compute Cloud User Guide.'
- description: Contains the output of PurchaseReservedInstancesOffering.
- Double:
- type: number
- format: double
- CurrencyCodeValues:
- type: string
- enum:
- - USD
- PurchaseScheduledInstancesResult:
- type: object
- example:
- ScheduledInstanceSet:
- - AvailabilityZone: us-west-2b
- CreateDate: '2016-01-25T21:43:38.612Z'
- HourlyPrice: '0.095'
- InstanceCount: 1
- InstanceType: c4.large
- NetworkPlatform: EC2-VPC
- NextSlotStartTime: '2016-01-31T09:00:00Z'
- Platform: Linux/UNIX
- Recurrence:
- Frequency: Weekly
- Interval: 1
- OccurrenceDaySet:
- - 1
- OccurrenceRelativeToEnd: false
- OccurrenceUnit: ''
- ScheduledInstanceId: sci-1234-1234-1234-1234-123456789012
- SlotDurationInHours: 32
- TermEndDate: '2017-01-31T09:00:00Z'
- TermStartDate: '2016-01-31T09:00:00Z'
- TotalScheduledInstanceHours: 1696
- properties:
- scheduledInstanceSet:
- allOf:
- - $ref: '#/components/schemas/PurchasedScheduledInstanceSet'
- - description: Information about the Scheduled Instances.
- description: Contains the output of PurchaseScheduledInstances.
- PurchaseRequest:
- type: object
- required:
- - InstanceCount
- - PurchaseToken
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The purchase token.
- description: Describes a request to purchase Scheduled Instances.
- RegisterImageResult:
- type: object
- properties:
- imageId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the newly registered AMI.
- description: Contains the output of RegisterImage.
- RegisterInstanceEventNotificationAttributesResult:
- type: object
- properties:
- instanceTagAttribute:
- allOf:
- - $ref: '#/components/schemas/InstanceTagNotificationAttribute'
- - description: The resulting set of tag keys.
- RegisterTransitGatewayMulticastGroupMembersResult:
- type: object
- properties:
- registeredMulticastGroupMembers:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastRegisteredGroupMembers'
- - description: Information about the registered transit gateway multicast group members.
- RegisterTransitGatewayMulticastGroupSourcesResult:
- type: object
- properties:
- registeredMulticastGroupSources:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastRegisteredGroupSources'
- - description: Information about the transit gateway multicast group sources.
- RejectTransitGatewayMulticastDomainAssociationsResult:
- type: object
- properties:
- associations:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
- RejectTransitGatewayPeeringAttachmentResult:
- type: object
- properties:
- transitGatewayPeeringAttachment:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
- - description: The transit gateway peering attachment.
- RejectTransitGatewayVpcAttachmentResult:
- type: object
- properties:
- transitGatewayVpcAttachment:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- - description: Information about the attachment.
- RejectVpcEndpointConnectionsResult:
- type: object
- properties:
- unsuccessful:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulItemSet'
- - description: 'Information about the endpoints that were not rejected, if applicable.'
- RejectVpcPeeringConnectionResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- ReleaseHostsResult:
- type: object
- properties:
- successful:
- allOf:
- - $ref: '#/components/schemas/ResponseHostIdList'
- - description: The IDs of the Dedicated Hosts that were successfully released.
- unsuccessful:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulItemList'
- - description: 'The IDs of the Dedicated Hosts that could not be released, including an error message.'
- ReleaseIpamPoolAllocationResult:
- type: object
- properties:
- success:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates if the release was successful.
- ReplaceIamInstanceProfileAssociationResult:
- type: object
- properties:
- iamInstanceProfileAssociation:
- allOf:
- - $ref: '#/components/schemas/IamInstanceProfileAssociation'
- - description: Information about the IAM instance profile association.
- ReplaceNetworkAclAssociationResult:
- type: object
- example:
- NewAssociationId: aclassoc-3999875b
- properties:
- newAssociationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the new association.
- ReplaceRouteTableAssociationResult:
- type: object
- example:
- NewAssociationId: rtbassoc-3a1f0f58
- properties:
- newAssociationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the new association.
- associationState:
- allOf:
- - $ref: '#/components/schemas/RouteTableAssociationState'
- - description: The state of the association.
- ReplaceTransitGatewayRouteResult:
- type: object
- properties:
- route:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRoute'
- - description: Information about the modified route.
- ReportInstanceReasonCodes:
- type: string
- enum:
- - instance-stuck-in-state
- - unresponsive
- - not-accepting-credentials
- - password-not-available
- - performance-network
- - performance-instance-store
- - performance-ebs-volume
- - performance-other
- - other
- RequestSpotFleetResponse:
- type: object
- example:
- SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
- properties:
- spotFleetRequestId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Spot Fleet request.
- description: Contains the output of RequestSpotFleet.
- AllocationStrategy:
- type: string
- enum:
- - lowestPrice
- - diversified
- - capacityOptimized
- - capacityOptimizedPrioritized
- OnDemandAllocationStrategy:
- type: string
- enum:
- - lowestPrice
- - prioritized
- SpotMaintenanceStrategies:
- type: object
- properties:
- capacityRebalance:
- allOf:
- - $ref: '#/components/schemas/SpotCapacityRebalance'
- - description: 'The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.'
- description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
- ExcessCapacityTerminationPolicy:
- type: string
- enum:
- - noTermination
- - default
- LaunchSpecsList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SpotFleetLaunchSpecification'
- - xml:
- name: item
- LaunchTemplateConfigList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateConfig'
- - xml:
- name: item
- FleetType:
- type: string
- enum:
- - request
- - maintain
- - instant
- InstanceInterruptionBehavior:
- type: string
- enum:
- - hibernate
- - stop
- - terminate
- LoadBalancersConfig:
- type: object
- properties:
- classicLoadBalancersConfig:
- allOf:
- - $ref: '#/components/schemas/ClassicLoadBalancersConfig'
- - description: The Classic Load Balancers.
- targetGroupsConfig:
- allOf:
- - $ref: '#/components/schemas/TargetGroupsConfig'
- - description: The target groups.
- description: Describes the Classic Load Balancers and target groups to attach to a Spot Fleet request.
- TagSpecificationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagSpecification'
- - xml:
- name: item
- RequestSpotInstancesResult:
- type: object
- properties:
- spotInstanceRequestSet:
- allOf:
- - $ref: '#/components/schemas/SpotInstanceRequestList'
- - description: One or more Spot Instance requests.
- description: Contains the output of RequestSpotInstances.
- RequestSpotLaunchSpecificationSecurityGroupIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: item
- RequestSpotLaunchSpecificationSecurityGroupList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- BlockDeviceMappingList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/BlockDeviceMapping'
- - xml:
- name: item
- IamInstanceProfileSpecification:
- type: object
- properties:
- arn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the instance profile.
- name:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the instance profile.
- description: Describes an IAM instance profile.
- KernelId:
- type: string
- RunInstancesMonitoringEnabled:
- type: object
- required:
- - Enabled
- properties:
- enabled:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.'
- description: Describes the monitoring of an instance.
- InstanceNetworkInterfaceSpecificationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecification'
- - xml:
- name: item
- SpotPlacement:
- type: object
- properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
' - groupName: - allOf: - - $ref: '#/components/schemas/PlacementGroupName' - - description: The name of the placement group. - tenancy: - allOf: - - $ref: '#/components/schemas/Tenancy' - - description: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy ofdedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
- description: Describes Spot Instance placement.
- RamdiskId:
- type: string
- ResetAddressAttributeResult:
- type: object
- properties:
- address:
- allOf:
- - $ref: '#/components/schemas/AddressAttribute'
- - description: Information about the IP address.
- ResetEbsDefaultKmsKeyIdResult:
- type: object
- properties:
- kmsKeyId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the default KMS key for EBS encryption by default.
- ResetFpgaImageAttributeResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Is true if the request succeeds, and an error otherwise.'
- RestoreAddressToClassicResult:
- type: object
- example:
- PublicIp: 198.51.100.0
- Status: MoveInProgress
- properties:
- publicIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Elastic IP address.
- status:
- allOf:
- - $ref: '#/components/schemas/Status'
- - description: The move status for the IP address.
- RestoreImageFromRecycleBinResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- RestoreManagedPrefixListVersionResult:
- type: object
- properties:
- prefixList:
- allOf:
- - $ref: '#/components/schemas/ManagedPrefixList'
- - description: Information about the prefix list.
- RestoreSnapshotFromRecycleBinResult:
- type: object
- properties:
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the snapshot.
- outpostArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.'
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description for the snapshot.
- encrypted:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the snapshot is encrypted.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the EBS snapshot.
- progress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The progress of the snapshot, as a percentage.'
- startTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time stamp when the snapshot was initiated.
- status:
- allOf:
- - $ref: '#/components/schemas/SnapshotState'
- - description: The state of the snapshot.
- volumeId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the volume that was used to create the snapshot.
- volumeSize:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The size of the volume, in GiB.'
- RestoreSnapshotTierResult:
- type: object
- properties:
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the snapshot.
- restoreStartTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The date and time when the snapshot restore process started.
- restoreDuration:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: For temporary restores only. The number of days for which the archived snapshot is temporarily restored.
- isPermanentRestore:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the snapshot is permanently restored. true indicates a permanent restore. false indicates a temporary restore.
- RevokeClientVpnIngressResult:
- type: object
- properties:
- status:
- allOf:
- - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus'
- - description: The current state of the authorization rule.
- RevokeSecurityGroupEgressResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, returns an error.'
- unknownIpPermissionSet:
- allOf:
- - $ref: '#/components/schemas/IpPermissionList'
- - description: 'The outbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter. '
- RevokeSecurityGroupIngressResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, returns an error.'
- unknownIpPermissionSet:
- allOf:
- - $ref: '#/components/schemas/IpPermissionList'
- - description: 'The inbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter. '
- Reservation:
- type: object
- example: {}
- properties:
- groupSet:
- allOf:
- - $ref: '#/components/schemas/GroupIdentifierList'
- - description: '[EC2-Classic only] The security groups.'
- instancesSet:
- allOf:
- - $ref: '#/components/schemas/InstanceList'
- - description: The instances.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the reservation.
- requesterId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).'
- reservationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the reservation.
- description: 'Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.'
- Tenancy:
- type: string
- enum:
- - default
- - dedicated
- - host
- InstanceNetworkInterfaceSpecification:
- type: object
- properties:
- associatePublicIpAddress:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.'
- deleteOnTermination:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.'
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the network interface. Applies only if creating a network interface when launching an instance.
- deviceIndex:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. - ipv6AddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch. - ipv6AddressesSet: - allOf: - - $ref: '#/components/schemas/InstanceIpv6AddressList' - - description: One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: 'The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
' - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you''re launching more than one instance in a RunInstances request.' - privateIpAddressesSet: - allOf: - - $ref: '#/components/schemas/PrivateIpAddressSpecificationList' - - description: 'One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you''re launching more than one instance in a RunInstances request.' - secondaryPrivateIpAddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of secondary private IPv4 addresses. You can''t specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you''re launching more than one instance in a RunInstances request.' - subnetId: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances.
' - Ipv4Prefix: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use theIpv4Prefix option.
- Ipv6Prefix:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
- description: Describes a network interface.
- ElasticGpuSpecification:
- type: object
- required:
- - Type
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The type of Elastic Graphics accelerator. For more information about the values to specify for Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances.'
- description: A specification for an Elastic Graphics accelerator.
- ElasticInferenceAccelerator:
- type: object
- required:
- - Type
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ElasticInferenceAcceleratorCount'
- - description: 'The number of elastic inference accelerators to attach to the instance.
Default: 1
' - description: ' Describes an elastic inference accelerator. ' - SpotMarketOptions: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceInterruptionBehavior' - - description: The behavior when a Spot Instance is interrupted. The default isterminate.
- description: The options for Spot Instances.
- LicenseConfigurationRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the license configuration.
- description: Describes a license configuration.
- InstanceMetadataTagsState:
- type: string
- enum:
- - disabled
- - enabled
- InstanceAutoRecoveryState:
- type: string
- enum:
- - disabled
- - default
- RunScheduledInstancesResult:
- type: object
- example:
- InstanceIdSet:
- - i-1234567890abcdef0
- properties:
- instanceIdSet:
- allOf:
- - $ref: '#/components/schemas/InstanceIdSet'
- - description: The IDs of the newly launched instances.
- description: Contains the output of RunScheduledInstances.
- ScheduledInstancesMonitoring:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether monitoring is enabled.
- description: Describes whether monitoring is enabled for a Scheduled Instance.
- SearchLocalGatewayRoutesResult:
- type: object
- properties:
- routeSet:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteList'
- - description: Information about the routes.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- SearchTransitGatewayMulticastGroupsResult:
- type: object
- properties:
- multicastGroups:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastGroupList'
- - description: Information about the transit gateway multicast group.
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- SearchTransitGatewayRoutesResult:
- type: object
- properties:
- routeSet:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteList'
- - description: Information about the routes.
- additionalRoutesAvailable:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether there are additional routes available.
- StartInstancesResult:
- type: object
- example:
- StartingInstances:
- - CurrentState:
- Code: 0
- Name: pending
- InstanceId: i-1234567890abcdef0
- PreviousState:
- Code: 80
- Name: stopped
- properties:
- instancesSet:
- allOf:
- - $ref: '#/components/schemas/InstanceStateChangeList'
- - description: Information about the started instances.
- StartNetworkInsightsAccessScopeAnalysisResult:
- type: object
- properties:
- networkInsightsAccessScopeAnalysis:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysis'
- - description: The Network Access Scope analysis.
- StartNetworkInsightsAnalysisResult:
- type: object
- properties:
- networkInsightsAnalysis:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAnalysis'
- - description: Information about the network insights analysis.
- ResourceArn:
- type: string
- minLength: 1
- maxLength: 1283
- StartVpcEndpointServicePrivateDnsVerificationResult:
- type: object
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
- StopInstancesResult:
- type: object
- example:
- StoppingInstances:
- - CurrentState:
- Code: 64
- Name: stopping
- InstanceId: i-1234567890abcdef0
- PreviousState:
- Code: 16
- Name: running
- properties:
- instancesSet:
- allOf:
- - $ref: '#/components/schemas/InstanceStateChangeList'
- - description: Information about the stopped instances.
- TerminateClientVpnConnectionsResult:
- type: object
- properties:
- clientVpnEndpointId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Client VPN endpoint.
- username:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The user who established the terminated client connections.
- connectionStatuses:
- allOf:
- - $ref: '#/components/schemas/TerminateConnectionStatusSet'
- - description: The current state of the client connections.
- TerminateInstancesResult:
- type: object
- example:
- TerminatingInstances:
- - CurrentState:
- Code: 32
- Name: shutting-down
- InstanceId: i-1234567890abcdef0
- PreviousState:
- Code: 16
- Name: running
- properties:
- instancesSet:
- allOf:
- - $ref: '#/components/schemas/InstanceStateChangeList'
- - description: Information about the terminated instances.
- UnassignIpv6AddressesResult:
- type: object
- properties:
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network interface.
- unassignedIpv6Addresses:
- allOf:
- - $ref: '#/components/schemas/Ipv6AddressList'
- - description: The IPv6 addresses that have been unassigned from the network interface.
- unassignedIpv6PrefixSet:
- allOf:
- - $ref: '#/components/schemas/IpPrefixList'
- - description: The IPv4 prefixes that have been unassigned from the network interface.
- UnmonitorInstancesResult:
- type: object
- properties:
- instancesSet:
- allOf:
- - $ref: '#/components/schemas/InstanceMonitoringList'
- - description: The monitoring information.
- UpdateSecurityGroupRuleDescriptionsEgressResult:
- type: object
- example: {}
- properties:
- return:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Returns true if the request succeeds; otherwise, returns an error.'
- SecurityGroupRuleDescription:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the security group rule.
- description: Describes the description of a security group rule.
You can use this when you want to update the security group rule description for either an inbound or outbound rule.
- UpdateSecurityGroupRuleDescriptionsIngressResult: - type: object - example: {} - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returnstrue if the request succeeds; otherwise, returns an error.'
- WithdrawByoipCidrResult:
- type: object
- properties:
- byoipCidr:
- allOf:
- - $ref: '#/components/schemas/ByoipCidr'
- - description: Information about the address pool.
- AcceleratorCount:
- type: object
- properties:
- min:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.'
- max:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.'
- description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.'
- AcceleratorManufacturer:
- type: string
- enum:
- - nvidia
- - amd
- - amazon-web-services
- - xilinx
- AcceleratorName:
- type: string
- enum:
- - a100
- - v100
- - k80
- - t4
- - m60
- - radeon-pro-v520
- - vu9p
- AcceleratorNameSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AcceleratorName'
- - xml:
- name: item
- AcceleratorTotalMemoryMiB:
- type: object
- properties:
- min:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.'
- max:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.'
- description: 'The minimum and maximum amount of total accelerator memory, in MiB.'
- AcceleratorType:
- type: string
- enum:
- - gpu
- - fpga
- - inference
- AcceleratorTypeSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AcceleratorType'
- - xml:
- name: item
- ReservedInstanceIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservationId'
- - xml:
- name: ReservedInstanceId
- TargetConfigurationRequestSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TargetConfigurationRequest'
- - xml:
- name: TargetConfigurationRequest
- AcceptReservedInstancesExchangeQuoteRequest:
- type: object
- required:
- - ReservedInstanceIds
- title: AcceptReservedInstancesExchangeQuoteRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ReservedInstanceId:
- allOf:
- - $ref: '#/components/schemas/ReservedInstanceIdSet'
- - description: The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
- TargetConfiguration:
- allOf:
- - $ref: '#/components/schemas/TargetConfigurationRequestSet'
- - description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
- description: Contains the parameters for accepting the quote.
- AcceptTransitGatewayMulticastDomainAssociationsRequest:
- type: object
- title: AcceptTransitGatewayMulticastDomainAssociationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayMulticastDomainAssociations:
- type: object
- properties:
- transitGatewayMulticastDomainId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway multicast domain.
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway attachment.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- - description: 'The type of resource, for example a VPC attachment.'
- resourceOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: ' The ID of the Amazon Web Services account that owns the resource.'
- subnets:
- allOf:
- - $ref: '#/components/schemas/SubnetAssociationList'
- - description: The subnets associated with the multicast domain.
- description: Describes the multicast domain associations.
- AcceptTransitGatewayPeeringAttachmentRequest:
- type: object
- required:
- - TransitGatewayAttachmentId
- title: AcceptTransitGatewayPeeringAttachmentRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayPeeringAttachment:
- type: object
- properties:
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway peering attachment.
- requesterTgwInfo:
- allOf:
- - $ref: '#/components/schemas/PeeringTgwInfo'
- - description: Information about the requester transit gateway.
- accepterTgwInfo:
- allOf:
- - $ref: '#/components/schemas/PeeringTgwInfo'
- - description: Information about the accepter transit gateway.
- status:
- allOf:
- - $ref: '#/components/schemas/PeeringAttachmentStatus'
- - description: The status of the transit gateway peering attachment.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentState'
- - description: The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
- creationTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time the transit gateway peering attachment was created.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for the transit gateway peering attachment.
- description: Describes the transit gateway peering attachment.
- AcceptTransitGatewayVpcAttachmentRequest:
- type: object
- required:
- - TransitGatewayAttachmentId
- title: AcceptTransitGatewayVpcAttachmentRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayVpcAttachment:
- type: object
- properties:
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the attachment.
- transitGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- vpcOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the VPC.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentState'
- - description: The state of the VPC attachment. Note that the initiating state has been deprecated.
- subnetIds:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The IDs of the subnets.
- creationTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The creation time.
- options:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayVpcAttachmentOptions'
- - description: The VPC attachment options.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for the VPC attachment.
- description: Describes a VPC attachment.
- VpcEndpointIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointId'
- - xml:
- name: item
- AcceptVpcEndpointConnectionsRequest:
- type: object
- required:
- - ServiceId
- - VpcEndpointIds
- title: AcceptVpcEndpointConnectionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointServiceId'
- - description: The ID of the VPC endpoint service.
- VpcEndpointId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointIdList'
- - description: The IDs of one or more interface VPC endpoints.
- UnsuccessfulItemSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulItem'
- - xml:
- name: item
- AcceptVpcPeeringConnectionRequest:
- type: object
- title: AcceptVpcPeeringConnectionRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- vpcPeeringConnectionId:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnectionId'
- - description: The ID of the VPC peering connection. You must specify this parameter in the request.
- VpcPeeringConnection:
- type: object
- properties:
- accepterVpcInfo:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnectionVpcInfo'
- - description: Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
- expirationTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time that an unaccepted VPC peering connection will expire.
- requesterVpcInfo:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnectionVpcInfo'
- - description: Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
- status:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnectionStateReason'
- - description: The status of the VPC peering connection.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the resource.
- vpcPeeringConnectionId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC peering connection.
- description: Describes a VPC peering connection.
- PathComponentList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PathComponent'
- - xml:
- name: item
- AccessScopeAnalysisFinding:
- type: object
- properties:
- networkInsightsAccessScopeAnalysisId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
- - description: The ID of the Network Access Scope analysis.
- networkInsightsAccessScopeId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- - description: The ID of the Network Access Scope.
- findingId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the finding.
- findingComponentSet:
- allOf:
- - $ref: '#/components/schemas/PathComponentList'
- - description: The finding components.
- description: Describes a finding for a Network Access Scope.
- AccessScopeAnalysisFindingList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AccessScopeAnalysisFinding'
- - xml:
- name: item
- PathStatement:
- type: object
- properties:
- packetHeaderStatement:
- allOf:
- - $ref: '#/components/schemas/PacketHeaderStatement'
- - description: The packet header statement.
- resourceStatement:
- allOf:
- - $ref: '#/components/schemas/ResourceStatement'
- - description: The resource statement.
- description: Describes a path statement.
- ThroughResourcesStatementList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ThroughResourcesStatement'
- - xml:
- name: item
- AccessScopePath:
- type: object
- properties:
- source:
- allOf:
- - $ref: '#/components/schemas/PathStatement'
- - description: The source.
- destination:
- allOf:
- - $ref: '#/components/schemas/PathStatement'
- - description: The destination.
- throughResourceSet:
- allOf:
- - $ref: '#/components/schemas/ThroughResourcesStatementList'
- - description: The through resources.
- description: Describes a path.
- AccessScopePathList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AccessScopePath'
- - xml:
- name: item
- AccessScopePathListRequest:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AccessScopePathRequest'
- - xml:
- name: item
- PathStatementRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ResourceStatementRequest'
- - description: The resource statement.
- description: Describes a path statement.
- ThroughResourcesStatementRequestList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ThroughResourcesStatementRequest'
- - xml:
- name: item
- AccountAttributeValueList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AccountAttributeValue'
- - xml:
- name: item
- AccountAttribute:
- type: object
- properties:
- attributeName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the account attribute.
- attributeValueSet:
- allOf:
- - $ref: '#/components/schemas/AccountAttributeValueList'
- - description: The values for the account attribute.
- description: Describes an account attribute.
- AccountAttributeList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AccountAttribute'
- - xml:
- name: item
- AccountAttributeNameStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AccountAttributeName'
- - xml:
- name: attributeName
- AccountAttributeValue:
- type: object
- properties:
- attributeValue:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The value of the attribute.
- description: Describes a value of an account attribute.
- InstanceHealthStatus:
- type: string
- enum:
- - healthy
- - unhealthy
- ActiveInstance:
- type: object
- properties:
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance.
- instanceType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The instance type.
- spotInstanceRequestId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Spot Instance request.
- instanceHealth:
- allOf:
- - $ref: '#/components/schemas/InstanceHealthStatus'
- - description: 'The health status of the instance. If the status of either the instance status check or the system status check is impaired, the health status of the instance is unhealthy. Otherwise, the health status is healthy.'
- description: Describes a running instance in a Spot Fleet.
- ActiveInstanceSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ActiveInstance'
- - xml:
- name: item
- ActivityStatus:
- type: string
- enum:
- - error
- - pending_fulfillment
- - pending_termination
- - fulfilled
- AddIpamOperatingRegionSet:
- type: array
- items:
- $ref: '#/components/schemas/AddIpamOperatingRegion'
- minItems: 0
- maxItems: 50
- AddPrefixListEntries:
- type: array
- items:
- $ref: '#/components/schemas/AddPrefixListEntry'
- minItems: 0
- maxItems: 100
- AnalysisComponent:
- type: object
- properties:
- id:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the component.
- arn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the component.
- name:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the analysis component.
- description: Describes a path component.
- AdditionalDetail:
- type: object
- properties:
- additionalDetailType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The information type.
- component:
- allOf:
- - $ref: '#/components/schemas/AnalysisComponent'
- - description: The path component.
- description: Describes an additional detail for a path analysis.
- AdditionalDetailList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AdditionalDetail'
- - xml:
- name: item
- DomainType:
- type: string
- enum:
- - vpc
- - standard
- Address:
- type: object
- properties:
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance that the address is associated with (if any).
- publicIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Elastic IP address.
- allocationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID representing the allocation of the address for use with EC2-VPC.
- associationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID representing the association of the address with an instance in a VPC.
- domain:
- allOf:
- - $ref: '#/components/schemas/DomainType'
- - description: Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network interface.
- networkInterfaceOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the network interface.
- privateIpAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The private IP address associated with the Elastic IP address.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the Elastic IP address.
- publicIpv4Pool:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of an address pool.
- networkBorderGroup:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.'
- customerOwnedIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The customer-owned IP address.
- customerOwnedIpv4Pool:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the customer-owned address pool.
- carrierIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). '
- description: 'Describes an Elastic IP address, or a carrier IP address.'
- PublicIpAddress:
- type: string
- PtrUpdateStatus:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The value for the PTR record update.
- status:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The status of the PTR record update.
- reason:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The reason for the PTR record update.
- description: The status of an updated pointer (PTR) record for an Elastic IP address.
- AddressAttribute:
- type: object
- properties:
- publicIp:
- allOf:
- - $ref: '#/components/schemas/PublicIpAddress'
- - description: The public IP address.
- allocationId:
- allOf:
- - $ref: '#/components/schemas/AllocationId'
- - description: '[EC2-VPC] The allocation ID.'
- ptrRecord:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The pointer (PTR) record for the IP address.
- ptrRecordUpdate:
- allOf:
- - $ref: '#/components/schemas/PtrUpdateStatus'
- - description: The updated PTR record for the IP address.
- description: The attributes associated with an Elastic IP address.
- AddressAttributeName:
- type: string
- enum:
- - domain-name
- AddressFamily:
- type: string
- enum:
- - ipv4
- - ipv6
- AddressList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Address'
- - xml:
- name: item
- AddressMaxResults:
- type: integer
- minimum: 1
- maximum: 1000
- AddressSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AddressAttribute'
- - xml:
- name: item
- AdvertiseByoipCidrRequest:
- type: object
- required:
- - Cidr
- title: AdvertiseByoipCidrRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ByoipCidr:
- type: object
- properties:
- cidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The address range, in CIDR notation.'
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the address range.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Upon success, contains the ID of the address pool. Otherwise, contains an error message.'
- state:
- allOf:
- - $ref: '#/components/schemas/ByoipCidrState'
- - description: The state of the address pool.
- description: Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
- Affinity:
- type: string
- enum:
- - default
- - host
- AllocateAddressRequest:
- type: object
- title: AllocateAddressRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.'
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to assign to the Elastic IP address.
- AutoPlacement:
- type: string
- enum:
- - 'on'
- - 'off'
- AllocateHostsRequest:
- type: object
- required:
- - AvailabilityZone
- - Quantity
- title: AllocateHostsRequest
- properties:
- autoPlacement:
- allOf:
- - $ref: '#/components/schemas/AutoPlacement'
- - description: 'Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.
Default: on
Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
' - quantity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of Dedicated Hosts to allocate to your account with these parameters. - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. - ResponseHostIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - IpamPoolAllocationDisallowedCidrs: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - AllocateIpamPoolCidrRequest: - type: object - required: - - IpamPoolId - title: AllocateIpamPoolCidrRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: A preview of the next available CIDR in a pool. - DisallowedCidr: - allOf: - - $ref: '#/components/schemas/IpamPoolAllocationDisallowedCidrs' - - description: Exclude a particular CIDR range from being returned by the pool. - IpamPoolAllocation: - type: object - properties: - cidr: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.'
- ipamPoolAllocationId:
- allOf:
- - $ref: '#/components/schemas/IpamPoolAllocationId'
- - description: The ID of an allocation.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the pool allocation.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/IpamPoolAllocationResourceType'
- - description: The type of the resource.
- resourceRegion:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services Region of the resource.
- resourceOwner:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The owner of the resource.
- description: 'In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool.'
- AllocationIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AllocationId'
- - xml:
- name: AllocationId
- AllocationIds:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AllocationId'
- - xml:
- name: item
- AllocationState:
- type: string
- enum:
- - available
- - under-assessment
- - permanent-failure
- - released
- - released-permanent-failure
- - pending
- PrincipalType:
- type: string
- enum:
- - All
- - Service
- - OrganizationUnit
- - Account
- - User
- - Role
- AllowedPrincipal:
- type: object
- properties:
- principalType:
- allOf:
- - $ref: '#/components/schemas/PrincipalType'
- - description: The type of principal.
- principal:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the principal.
- description: Describes a principal.
- AllowedPrincipalSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AllowedPrincipal'
- - xml:
- name: item
- AllowsMultipleInstanceTypes:
- type: string
- enum:
- - 'on'
- - 'off'
- AlternatePathHint:
- type: object
- properties:
- componentId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the component.
- componentArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the component.
- description: Describes an potential intermediate component of a feasible path.
- AlternatePathHintList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AlternatePathHint'
- - xml:
- name: item
- PortRange:
- type: object
- properties:
- from:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The first port in the range.
- to:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The last port in the range.
- description: Describes a range of ports.
- AnalysisAclRule:
- type: object
- properties:
- cidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IPv4 address range, in CIDR notation.'
- egress:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the rule is an outbound rule.
- portRange:
- allOf:
- - $ref: '#/components/schemas/PortRange'
- - description: The range of ports.
- protocol:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The protocol.
- ruleAction:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Indicates whether to allow or deny traffic that matches the rule.
- ruleNumber:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The rule number.
- description: Describes a network access control (ACL) rule.
- AnalysisComponentList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AnalysisComponent'
- - xml:
- name: item
- Port:
- type: integer
- minimum: 1
- maximum: 65535
- AnalysisLoadBalancerListener:
- type: object
- properties:
- loadBalancerPort:
- allOf:
- - $ref: '#/components/schemas/Port'
- - description: The port on which the load balancer is listening.
- instancePort:
- allOf:
- - $ref: '#/components/schemas/Port'
- - description: '[Classic Load Balancers] The back-end port for the listener.'
- description: Describes a load balancer listener.
- IpAddress:
- type: string
- pattern: '^([0-9]{1,3}.){3}[0-9]{1,3}$'
- minLength: 0
- maxLength: 15
- AnalysisLoadBalancerTarget:
- type: object
- properties:
- address:
- allOf:
- - $ref: '#/components/schemas/IpAddress'
- - description: The IP address.
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone.
- instance:
- allOf:
- - $ref: '#/components/schemas/AnalysisComponent'
- - description: Information about the instance.
- port:
- allOf:
- - $ref: '#/components/schemas/Port'
- - description: The port on which the target is listening.
- description: Describes a load balancer target.
- IpAddressList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpAddress'
- - xml:
- name: item
- PortRangeList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PortRange'
- - xml:
- name: item
- AnalysisPacketHeader:
- type: object
- properties:
- destinationAddressSet:
- allOf:
- - $ref: '#/components/schemas/IpAddressList'
- - description: The destination addresses.
- destinationPortRangeSet:
- allOf:
- - $ref: '#/components/schemas/PortRangeList'
- - description: The destination port ranges.
- protocol:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The protocol.
- sourceAddressSet:
- allOf:
- - $ref: '#/components/schemas/IpAddressList'
- - description: The source addresses.
- sourcePortRangeSet:
- allOf:
- - $ref: '#/components/schemas/PortRangeList'
- - description: The source port ranges.
- description: Describes a header. Reflects any changes made by a component as traffic passes through. The fields of an inbound header are null except for the first component of a path.
- AnalysisRouteTableRoute:
- type: object
- properties:
- destinationCidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The destination IPv4 address, in CIDR notation.'
- destinationPrefixListId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The prefix of the Amazon Web Service.
- egressOnlyInternetGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of an egress-only internet gateway.
- gatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ID of the gateway, such as an internet gateway or virtual private gateway.'
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ID of the instance, such as a NAT instance.'
- natGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of a NAT gateway.
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of a network interface.
- origin:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Describes how the route was created. The following are the possible values:
CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.
The direction. The following are the possible values:
egress
ingress
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ClientVpnSecurityGroupIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: item
- ArchitectureTypeList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ArchitectureType'
- - xml:
- name: item
- ArnList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - xml:
- name: item
- IpPrefixList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- AssignIpv6AddressesRequest:
- type: object
- required:
- - NetworkInterfaceId
- title: AssignIpv6AddressesRequest
- properties:
- ipv6AddressCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
- ipv6Addresses:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.
- Ipv6Prefix:
- allOf:
- - $ref: '#/components/schemas/IpPrefixList'
- - description: One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceId'
- - description: The ID of the network interface.
- Ipv6AddressList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- PrivateIpAddressStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: PrivateIpAddress
- AssignPrivateIpAddressesRequest:
- type: object
- required:
- - NetworkInterfaceId
- title: AssignPrivateIpAddressesRequest
- properties:
- allowReassignment:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceId'
- - description: The ID of the network interface.
- privateIpAddress:
- allOf:
- - $ref: '#/components/schemas/PrivateIpAddressStringList'
- - description: 'One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can''t specify this parameter when also specifying a number of secondary IP addresses.
If you don''t specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
' - secondaryPrivateIpAddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. - Ipv4Prefix: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use theIpv4 Prefixes option.
- description: Contains the parameters for AssignPrivateIpAddresses.
- AssignedPrivateIpAddressList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AssignedPrivateIpAddress'
- - xml:
- name: item
- Ipv4PrefixesList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv4PrefixSpecification'
- - xml:
- name: item
- AssignedPrivateIpAddress:
- type: object
- properties:
- privateIpAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The private IP address assigned to the network interface.
- description: Describes the private IP addresses assigned to a network interface.
- AssociateAddressRequest:
- type: object
- title: AssociateAddressRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: '[EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic.'
- allowReassociation:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: '[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.'
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceId'
- - description: '[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
' - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: '[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.' - AssociateClientVpnTargetNetworkRequest: - type: object - required: - - ClientVpnEndpointId - - SubnetId - title: AssociateClientVpnTargetNetworkRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- AssociationStatus:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/AssociationStatusCode'
- - description: The state of the target network association.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A message about the status of the target network association, if applicable.'
- description: Describes the state of a target network association.
- AssociateDhcpOptionsRequest:
- type: object
- required:
- - DhcpOptionsId
- - VpcId
- title: AssociateDhcpOptionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- AssociateEnclaveCertificateIamRoleRequest:
- type: object
- title: AssociateEnclaveCertificateIamRoleRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- AssociateIamInstanceProfileRequest:
- type: object
- required:
- - IamInstanceProfile
- - InstanceId
- title: AssociateIamInstanceProfileRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of the instance.
- IamInstanceProfileAssociation:
- type: object
- properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the association.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance.
- iamInstanceProfile:
- allOf:
- - $ref: '#/components/schemas/IamInstanceProfile'
- - description: The IAM instance profile.
- state:
- allOf:
- - $ref: '#/components/schemas/IamInstanceProfileAssociationState'
- - description: The state of the association.
- timestamp:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time the IAM instance profile was associated with the instance.
- description: Describes an association between an IAM instance profile and an instance.
- InstanceEventWindowAssociationRequest:
- type: object
- properties:
- InstanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceIdList'
- - description: 'The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can''t specify the Instance ID parameter; you must use the Dedicated Host ID parameter.'
- InstanceTag:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window.
- DedicatedHostId:
- allOf:
- - $ref: '#/components/schemas/DedicatedHostIdList'
- - description: The IDs of the Dedicated Hosts to associate with the event window.
- description: 'One or more targets associated with the specified event window. Only one type of target (instance ID, instance tag, or Dedicated Host ID) can be associated with an event window.'
- AssociateInstanceEventWindowRequest:
- type: object
- required:
- - InstanceEventWindowId
- - AssociationTarget
- title: AssociateInstanceEventWindowRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowAssociationRequest'
- - description: One or more targets associated with the specified event window.
- InstanceEventWindow:
- type: object
- properties:
- instanceEventWindowId:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowId'
- - description: The ID of the event window.
- timeRangeSet:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowTimeRangeList'
- - description: One or more time ranges defined for the event window.
- name:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the event window.
- cronExpression:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowCronExpression'
- - description: The cron expression defined for the event window.
- associationTarget:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowAssociationTarget'
- - description: One or more targets associated with the event window.
- state:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowState'
- - description: The current state of the event window.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The instance tags associated with the event window.
- description: The event window.
- RouteGatewayId:
- type: string
- AssociateRouteTableRequest:
- type: object
- required:
- - RouteTableId
- title: AssociateRouteTableRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- routeTableId:
- allOf:
- - $ref: '#/components/schemas/RouteTableId'
- - description: The ID of the route table.
- subnetId:
- allOf:
- - $ref: '#/components/schemas/RouteGatewayId'
- - description: The ID of the internet gateway or virtual private gateway.
- RouteTableAssociationState:
- type: object
- properties:
- state:
- allOf:
- - $ref: '#/components/schemas/RouteTableAssociationStateCode'
- - description: The state of the association.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The status message, if applicable.'
- description: Describes the state of an association between a route table and a subnet or gateway.
- AssociateSubnetCidrBlockRequest:
- type: object
- required:
- - Ipv6CidrBlock
- - SubnetId
- title: AssociateSubnetCidrBlockRequest
- properties:
- ipv6CidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.
- subnetId:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - description: The ID of your subnet.
- SubnetIpv6CidrBlockAssociation:
- type: object
- properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/SubnetCidrAssociationId'
- - description: The ID of the association.
- ipv6CidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 CIDR block.
- ipv6CidrBlockState:
- allOf:
- - $ref: '#/components/schemas/SubnetCidrBlockState'
- - description: The state of the CIDR block.
- description: Describes an association between a subnet and an IPv6 CIDR block.
- AssociateTransitGatewayMulticastDomainRequest:
- type: object
- title: AssociateTransitGatewayMulticastDomainRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- AssociateTransitGatewayRouteTableRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- - TransitGatewayAttachmentId
- title: AssociateTransitGatewayRouteTableRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayAssociation:
- type: object
- properties:
- transitGatewayRouteTableId:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableId'
- - description: The ID of the transit gateway route table.
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentId'
- - description: The ID of the attachment.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- - description: The resource type. Note that the tgw-peering resource type has been deprecated.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAssociationState'
- - description: The state of the association.
- description: Describes an association between a resource attachment and a transit gateway route table.
- AssociateTrunkInterfaceRequest:
- type: object
- required:
- - BranchInterfaceId
- - TrunkInterfaceId
- title: AssociateTrunkInterfaceRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TrunkInterfaceAssociation:
- type: object
- properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/TrunkInterfaceAssociationId'
- - description: The ID of the association.
- branchInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the branch network interface.
- trunkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the trunk network interface.
- interfaceProtocol:
- allOf:
- - $ref: '#/components/schemas/InterfaceProtocolType'
- - description: The interface protocol. Valid values are VLAN and GRE.
- vlanId:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The ID of the VLAN when you use the VLAN protocol.
- greKey:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The application key when you use the GRE protocol.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for the trunk interface association.
- description: 'Currently available in limited preview only. If you are interested in using this feature, contact your account manager.
Information about an association between a branch network interface with a trunk network interface.
' - NetmaskLength: - type: integer - AssociateVpcCidrBlockRequest: - type: object - required: - - VpcId - title: AssociateVpcCidrBlockRequest - properties: - amazonProvidedIpv6CidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: An IPv4 CIDR block to associate with the VPC. - vpcId: - allOf: - - $ref: '#/components/schemas/NetmaskLength' - - description: 'The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide. ' - VpcIpv6CidrBlockAssociation: - type: object - properties: - associationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The association ID for the IPv6 CIDR block. - ipv6CidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 CIDR block. - ipv6CidrBlockState: - allOf: - - $ref: '#/components/schemas/VpcCidrBlockState' - - description: Information about the state of the CIDR block. - networkBorderGroup: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example,us-east-1-wl1-bos-wlz-1.'
- ipv6Pool:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
- description: Describes an IPv6 CIDR block associated with a VPC.
- VpcCidrBlockAssociation:
- type: object
- properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The association ID for the IPv4 CIDR block.
- cidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv4 CIDR block.
- cidrBlockState:
- allOf:
- - $ref: '#/components/schemas/VpcCidrBlockState'
- - description: Information about the state of the CIDR block.
- description: Describes an IPv4 CIDR block associated with a VPC.
- AssociatedNetworkType:
- type: string
- enum:
- - vpc
- AssociatedRole:
- type: object
- properties:
- associatedRoleArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The ARN of the associated IAM role.
- certificateS3BucketName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the Amazon S3 bucket in which the Amazon S3 object is stored.
- certificateS3ObjectKey:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle is stored. The object key is formated as follows: role_arn/certificate_arn. '
- encryptionKmsKeyId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the KMS customer master key (CMK) used to encrypt the private key.
- description: Information about the associated IAM roles.
- AssociatedRolesList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AssociatedRole'
- - xml:
- name: item
- AssociatedTargetNetwork:
- type: object
- properties:
- networkId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the subnet.
- networkType:
- allOf:
- - $ref: '#/components/schemas/AssociatedNetworkType'
- - description: The target network type.
- description: Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.
- AssociatedTargetNetworkSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AssociatedTargetNetwork'
- - xml:
- name: item
- AssociationIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IamInstanceProfileAssociationId'
- - xml:
- name: AssociationId
- AssociationStatusCode:
- type: string
- enum:
- - associating
- - associated
- - association-failed
- - disassociating
- - disassociated
- MillisecondDateTime:
- type: string
- format: date-time
- AthenaIntegration:
- type: object
- required:
- - IntegrationResultS3DestinationArn
- - PartitionLoadFrequency
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The end date for the partition.
- description: Describes integration options for Amazon Athena.
- GroupIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: groupId
- AttachClassicLinkVpcRequest:
- type: object
- required:
- - Groups
- - InstanceId
- - VpcId
- title: AttachClassicLinkVpcRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SecurityGroupId:
- allOf:
- - $ref: '#/components/schemas/GroupIdStringList'
- - description: The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of a ClassicLink-enabled VPC.
- AttachInternetGatewayRequest:
- type: object
- required:
- - InternetGatewayId
- - VpcId
- title: AttachInternetGatewayRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- internetGatewayId:
- allOf:
- - $ref: '#/components/schemas/InternetGatewayId'
- - description: The ID of the internet gateway.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- AttachNetworkInterfaceRequest:
- type: object
- required:
- - DeviceIndex
- - InstanceId
- - NetworkInterfaceId
- title: AttachNetworkInterfaceRequest
- properties:
- deviceIndex:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The index of the device for the network interface attachment.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- instanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of the instance.
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
- description: Contains the parameters for AttachNetworkInterface.
- AttachVolumeRequest:
- type: object
- required:
- - Device
- - InstanceId
- - VolumeId
- title: AttachVolumeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VolumeId'
- - description: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- AttachVpnGatewayRequest:
- type: object
- required:
- - VpcId
- - VpnGatewayId
- title: AttachVpnGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpnGatewayId'
- - description: The ID of the virtual private gateway.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for AttachVpnGateway.
- VpcAttachment:
- type: object
- properties:
- state:
- allOf:
- - $ref: '#/components/schemas/AttachmentStatus'
- - description: The current state of the attachment.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- description: Describes an attachment between a virtual private gateway and a VPC.
- AttachmentStatus:
- type: string
- enum:
- - attaching
- - attached
- - detaching
- - detached
- AttributeBooleanValue:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The attribute value. The valid values are true or false.
- description: Describes a value for a resource attribute that is a Boolean value.
- AttributeValue:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The attribute value. The value is case-sensitive.
- description: Describes a value for a resource attribute that is a String.
- ClientVpnAuthorizationRuleStatus:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatusCode'
- - description: The state of the authorization rule.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A message about the status of the authorization rule, if applicable.'
- description: Describes the state of an authorization rule.
- AuthorizationRule:
- type: object
- properties:
- clientVpnEndpointId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Client VPN endpoint with which the authorization rule is associated.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A brief description of the authorization rule.
- groupId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Active Directory group to which the authorization rule grants access.
- accessAll:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the authorization rule grants access to all clients.
- destinationCidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.'
- status:
- allOf:
- - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus'
- - description: The current state of the authorization rule.
- description: Information about an authorization rule.
- AuthorizationRuleSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AuthorizationRule'
- - xml:
- name: item
- AuthorizeClientVpnIngressRequest:
- type: object
- required:
- - ClientVpnEndpointId
- - TargetNetworkCidr
- title: AuthorizeClientVpnIngressRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- IpPermissionList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpPermission'
- - xml:
- name: item
- AuthorizeSecurityGroupEgressRequest:
- type: object
- required:
- - GroupId
- title: AuthorizeSecurityGroupEgressRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- groupId:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - description: The ID of the security group.
- ipPermissions:
- allOf:
- - $ref: '#/components/schemas/IpPermissionList'
- - description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags applied to the security group rule.
- cidrIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Not supported. Use a set of IP permissions to specify the CIDR.
- fromPort:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: Not supported. Use a set of IP permissions to specify the port.
- ipProtocol:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Not supported. Use a set of IP permissions to specify the protocol name or number.
- toPort:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: Not supported. Use a set of IP permissions to specify the port.
- sourceSecurityGroupName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Not supported. Use a set of IP permissions to specify a destination security group.
- sourceSecurityGroupOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Not supported. Use a set of IP permissions to specify a destination security group.
- SecurityGroupRuleList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRule'
- - xml:
- name: item
- AuthorizeSecurityGroupIngressRequest:
- type: object
- title: AuthorizeSecurityGroupIngressRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: '[VPC Only] The tags applied to the security group rule.'
- AutoAcceptSharedAttachmentsValue:
- type: string
- enum:
- - enable
- - disable
- AutoRecoveryFlag:
- type: boolean
- AvailabilityZoneState:
- type: string
- enum:
- - available
- - information
- - impaired
- - unavailable
- AvailabilityZoneOptInStatus:
- type: string
- enum:
- - opt-in-not-required
- - opted-in
- - not-opted-in
- AvailabilityZoneMessageList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AvailabilityZoneMessage'
- - xml:
- name: item
- AvailabilityZone:
- type: object
- properties:
- zoneState:
- allOf:
- - $ref: '#/components/schemas/AvailabilityZoneState'
- - description: 'The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always available.'
- optInStatus:
- allOf:
- - $ref: '#/components/schemas/AvailabilityZoneOptInStatus'
- - description: 'For Availability Zones, this parameter always has the value of opt-in-not-required.
For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are opted-in, and not-opted-in.
For Availability Zones, this parameter has the same value as the Region name.
For Local Zones, the name of the associated group, for example us-west-2-lax-1.
For Wavelength Zones, the name of the associated group, for example us-east-1-wl1-bos-wlz-1.
availability-zone, local-zone, and wavelength-zone.'
- parentZoneName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.'
- parentZoneId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.'
- description: 'Describes Availability Zones, Local Zones, and Wavelength Zones.'
- AvailabilityZoneList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AvailabilityZone'
- - xml:
- name: item
- AvailabilityZoneMessage:
- type: object
- properties:
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The message about the Availability Zone, Local Zone, or Wavelength Zone.'
- description: 'Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.'
- AvailabilityZoneStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: AvailabilityZone
- AvailableInstanceCapacityList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceCapacity'
- - xml:
- name: item
- AvailableCapacity:
- type: object
- properties:
- availableInstanceCapacity:
- allOf:
- - $ref: '#/components/schemas/AvailableInstanceCapacityList'
- - description: 'The number of instances that can be launched onto the Dedicated Host depending on the host''s available capacity. For Dedicated Hosts that support multiple instance types, this parameter represents the number of instances for each instance size that is supported on the host.'
- availableVCpus:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of vCPUs available for launching instances onto the Dedicated Host.
- description: 'The capacity information for instances that can be launched onto the Dedicated Host. '
- InstanceCapacity:
- type: object
- properties:
- availableCapacity:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of instances that can be launched onto the Dedicated Host based on the host's available capacity.
- instanceType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The instance type supported by the Dedicated Host.
- totalCapacity:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The total number of instances that can be launched onto the Dedicated Host if there are no instances running on it.
- description: Information about the number of instances that can be launched onto the Dedicated Host.
- BareMetal:
- type: string
- enum:
- - included
- - required
- - excluded
- BareMetalFlag:
- type: boolean
- BaselineBandwidthInMbps:
- type: integer
- BaselineEbsBandwidthMbps:
- type: object
- properties:
- min:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.'
- max:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.'
- description: 'The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.'
- BaselineIops:
- type: integer
- BaselineThroughputInMBps:
- type: number
- format: double
- BatchState:
- type: string
- enum:
- - submitted
- - active
- - cancelled
- - failed
- - cancelled_running
- - cancelled_terminating
- - modifying
- BgpStatus:
- type: string
- enum:
- - up
- - down
- BillingProductList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- BlobAttributeValue:
- type: object
- properties:
- value:
- $ref: '#/components/schemas/Blob'
- EbsBlockDevice:
- type: object
- properties:
- deleteOnTermination:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.'
- iops:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2 and gp3:1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
' - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ARN of the Outpost on which the snapshot is stored.
This parameter is only supported on BlockDeviceMapping objects called by CreateImage.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
' - description: Describes a block device for an EBS volume. - BlockDeviceMappingRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/BlockDeviceMapping' - - xml: - name: BlockDeviceMapping - BootModeType: - type: string - enum: - - legacy-bios - - uefi - BootModeTypeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/BootModeType' - - xml: - name: item - BootModeValues: - type: string - enum: - - legacy-bios - - uefi - BoxedDouble: - type: number - format: double - BundleIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/BundleId' - - xml: - name: BundleId - Storage: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/S3Storage' - - description: An Amazon S3 storage location. - description: Describes the storage location for an instance store-backed AMI. - BundleInstanceRequest: - type: object - required: - - InstanceId - - Storage - title: BundleInstanceRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Storage' - - description: 'The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for BundleInstance.
- BundleTask:
- type: object
- properties:
- bundleId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the bundle task.
- error:
- allOf:
- - $ref: '#/components/schemas/BundleTaskError'
- - description: 'If the task fails, a description of the error.'
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance associated with this bundle task.
- progress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The level of task completion, as a percent (for example, 20%).'
- startTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time this task started.
- state:
- allOf:
- - $ref: '#/components/schemas/BundleTaskState'
- - description: The state of the task.
- storage:
- allOf:
- - $ref: '#/components/schemas/Storage'
- - description: The Amazon S3 storage locations.
- updateTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time of the most recent update for the task.
- description: Describes a bundle task.
- BundleTaskError:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The error code.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The error message.
- description: Describes an error for BundleInstance.
- BundleTaskState:
- type: string
- enum:
- - pending
- - waiting-for-shutdown
- - bundling
- - storing
- - cancelling
- - complete
- - failed
- BundleTaskList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/BundleTask'
- - xml:
- name: item
- BurstablePerformance:
- type: string
- enum:
- - included
- - required
- - excluded
- BurstablePerformanceFlag:
- type: boolean
- ByoipCidrState:
- type: string
- enum:
- - advertised
- - deprovisioned
- - failed-deprovision
- - failed-provision
- - pending-deprovision
- - pending-provision
- - provisioned
- - provisioned-not-publicly-advertisable
- ByoipCidrSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ByoipCidr'
- - xml:
- name: item
- CancelBatchErrorCode:
- type: string
- enum:
- - fleetRequestIdDoesNotExist
- - fleetRequestIdMalformed
- - fleetRequestNotInCancellableState
- - unexpectedError
- CancelBundleTaskRequest:
- type: object
- required:
- - BundleId
- title: CancelBundleTaskRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/BundleId'
- - description: The ID of the bundle task.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for CancelBundleTask.
- CancelCapacityReservationFleetErrorCode:
- type: string
- CancelCapacityReservationFleetErrorMessage:
- type: string
- CancelCapacityReservationFleetError:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/CancelCapacityReservationFleetErrorCode'
- - description: The error code.
- message:
- allOf:
- - $ref: '#/components/schemas/CancelCapacityReservationFleetErrorMessage'
- - description: The error message.
- description: Describes a Capacity Reservation Fleet cancellation error.
- CapacityReservationFleetIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationFleetId'
- - xml:
- name: item
- CancelCapacityReservationFleetsRequest:
- type: object
- required:
- - CapacityReservationFleetIds
- title: CancelCapacityReservationFleetsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- CapacityReservationFleetId:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationFleetIdSet'
- - description: The IDs of the Capacity Reservation Fleets to cancel.
- CapacityReservationFleetCancellationStateSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationFleetCancellationState'
- - xml:
- name: item
- FailedCapacityReservationFleetCancellationResultSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/FailedCapacityReservationFleetCancellationResult'
- - xml:
- name: item
- CancelCapacityReservationRequest:
- type: object
- required:
- - CapacityReservationId
- title: CancelCapacityReservationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- CancelConversionRequest:
- type: object
- required:
- - ConversionTaskId
- title: CancelConversionRequest
- properties:
- conversionTaskId:
- allOf:
- - $ref: '#/components/schemas/ConversionTaskId'
- - description: The ID of the conversion task.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- reasonMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The reason for canceling the conversion task.
- ExportVmTaskId:
- type: string
- CancelExportTaskRequest:
- type: object
- required:
- - ExportTaskId
- title: CancelExportTaskRequest
- properties:
- exportTaskId:
- allOf:
- - $ref: '#/components/schemas/ExportVmTaskId'
- - description: The ID of the export task. This is the ID returned by CreateInstanceExportTask.
- ImportTaskId:
- type: string
- CancelImportTaskRequest:
- type: object
- title: CancelImportTaskRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ImportTaskId'
- - description: The ID of the import image or import snapshot task to be canceled.
- ReservedInstancesListingId:
- type: string
- CancelReservedInstancesListingRequest:
- type: object
- required:
- - ReservedInstancesListingId
- title: CancelReservedInstancesListingRequest
- properties:
- reservedInstancesListingId:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesListingId'
- - description: The ID of the Reserved Instance listing.
- description: Contains the parameters for CancelReservedInstancesListing.
- ReservedInstancesListingList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesListing'
- - xml:
- name: item
- CancelSpotFleetRequestsError:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/CancelBatchErrorCode'
- - description: The error code.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description for the error code.
- description: Describes a Spot Fleet error.
- CancelSpotFleetRequestsErrorItem:
- type: object
- properties:
- error:
- allOf:
- - $ref: '#/components/schemas/CancelSpotFleetRequestsError'
- - description: The error.
- spotFleetRequestId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Spot Fleet request.
- description: Describes a Spot Fleet request that was not successfully canceled.
- CancelSpotFleetRequestsErrorSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CancelSpotFleetRequestsErrorItem'
- - xml:
- name: item
- SpotFleetRequestIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SpotFleetRequestId'
- - xml:
- name: item
- CancelSpotFleetRequestsRequest:
- type: object
- required:
- - SpotFleetRequestIds
- - TerminateInstances
- title: CancelSpotFleetRequestsRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- spotFleetRequestId:
- allOf:
- - $ref: '#/components/schemas/SpotFleetRequestIdList'
- - description: The IDs of the Spot Fleet requests.
- terminateInstances:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
- description: Contains the parameters for CancelSpotFleetRequests.
- CancelSpotFleetRequestsSuccessSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CancelSpotFleetRequestsSuccessItem'
- - xml:
- name: item
- CancelSpotFleetRequestsSuccessItem:
- type: object
- properties:
- currentSpotFleetRequestState:
- allOf:
- - $ref: '#/components/schemas/BatchState'
- - description: The current state of the Spot Fleet request.
- previousSpotFleetRequestState:
- allOf:
- - $ref: '#/components/schemas/BatchState'
- - description: The previous state of the Spot Fleet request.
- spotFleetRequestId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Spot Fleet request.
- description: Describes a Spot Fleet request that was successfully canceled.
- CancelSpotInstanceRequestState:
- type: string
- enum:
- - active
- - open
- - closed
- - cancelled
- - completed
- SpotInstanceRequestIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SpotInstanceRequestId'
- - xml:
- name: SpotInstanceRequestId
- CancelSpotInstanceRequestsRequest:
- type: object
- required:
- - SpotInstanceRequestIds
- title: CancelSpotInstanceRequestsRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SpotInstanceRequestId:
- allOf:
- - $ref: '#/components/schemas/SpotInstanceRequestIdList'
- - description: One or more Spot Instance request IDs.
- description: Contains the parameters for CancelSpotInstanceRequests.
- CancelledSpotInstanceRequestList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CancelledSpotInstanceRequest'
- - xml:
- name: item
- CancelledSpotInstanceRequest:
- type: object
- properties:
- spotInstanceRequestId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Spot Instance request.
- state:
- allOf:
- - $ref: '#/components/schemas/CancelSpotInstanceRequestState'
- - description: The state of the Spot Instance request.
- description: Describes a request to cancel a Spot Instance.
- CapacityReservationInstancePlatform:
- type: string
- enum:
- - Linux/UNIX
- - Red Hat Enterprise Linux
- - SUSE Linux
- - Windows
- - Windows with SQL Server
- - Windows with SQL Server Enterprise
- - Windows with SQL Server Standard
- - Windows with SQL Server Web
- - Linux with SQL Server Standard
- - Linux with SQL Server Web
- - Linux with SQL Server Enterprise
- - RHEL with SQL Server Standard
- - RHEL with SQL Server Enterprise
- - RHEL with SQL Server Web
- - RHEL with HA
- - RHEL with HA and SQL Server Standard
- - RHEL with HA and SQL Server Enterprise
- CapacityReservationTenancy:
- type: string
- enum:
- - default
- - dedicated
- CapacityReservationState:
- type: string
- enum:
- - active
- - expired
- - cancelled
- - pending
- - failed
- EndDateType:
- type: string
- enum:
- - unlimited
- - limited
- InstanceMatchCriteria:
- type: string
- enum:
- - open
- - targeted
- OutpostArn:
- type: string
- pattern: '^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$'
- PlacementGroupArn:
- type: string
- pattern: '^arn:aws([a-z-]+)?:ec2:[a-z\d-]+:\d{12}:placement-group/([^\s].+[^\s]){1,255}$'
- CapacityReservation:
- type: object
- properties:
- capacityReservationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Capacity Reservation.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the Capacity Reservation.
- capacityReservationArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the Capacity Reservation.
- availabilityZoneId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone ID of the Capacity Reservation.
- instanceType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The type of instance for which the Capacity Reservation reserves capacity.
- instancePlatform:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationInstancePlatform'
- - description: The type of operating system for which the Capacity Reservation reserves capacity.
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone in which the capacity is reserved.
- tenancy:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationTenancy'
- - description: 'Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active - The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
expired when it reaches its end date and time.'
- endDateType:
- allOf:
- - $ref: '#/components/schemas/EndDateType'
- - description: 'Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
The state of the Capacity Reservation Fleet. Possible states include:
submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.
modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.
active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.
partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.
expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.
expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can''t create new Capacity Reservations.
cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.
cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can''t create new Capacity Reservations.
failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.
The tenancy of the Capacity Reservation Fleet. Tenancies include:
default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
' - description: 'Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
This strategy can only be used if the EC2 Fleet is of type instant.
For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.
' - CapacityReservationOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FleetCapacityReservationUsageStrategy' - - description: 'Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
' - description: 'Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
This strategy can only be used if the EC2 Fleet is of type instant.
For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.
' - CapacityReservationPreference: - type: string - enum: - - open - - none - CapacityReservationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CapacityReservation' - - xml: - name: item - CapacityReservationSpecification: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/CapacityReservationTarget' - - description: Information about the target Capacity Reservation or Capacity Reservation group. - description: 'Describes an instance''s Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.
Describes the instance''s Capacity Reservation preferences. Possible preferences include:
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
capacityReservationPreference response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the capacityReservationTarget response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group.'
- CarrierGatewayState:
- type: string
- enum:
- - pending
- - available
- - deleting
- - deleted
- CarrierGateway:
- type: object
- properties:
- carrierGatewayId:
- allOf:
- - $ref: '#/components/schemas/CarrierGatewayId'
- - description: The ID of the carrier gateway.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC associated with the carrier gateway.
- state:
- allOf:
- - $ref: '#/components/schemas/CarrierGatewayState'
- - description: The state of the carrier gateway.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID of the owner of the carrier gateway.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the carrier gateway.
- description: Describes a carrier gateway.
- CarrierGatewayIdSet:
- type: array
- items:
- $ref: '#/components/schemas/CarrierGatewayId'
- CarrierGatewayMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- CarrierGatewaySet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CarrierGateway'
- - xml:
- name: item
- CertificateAuthentication:
- type: object
- properties:
- clientRootCertificateChain:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ARN of the client certificate. '
- description: Information about the client certificate used for authentication.
- CertificateAuthenticationRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in Certificate Manager (ACM).
- description: Information about the client certificate to be used for authentication.
- CidrAuthorizationContext:
- type: object
- required:
- - Message
- - Signature
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The signed authorization message for the prefix and account.
- description: 'Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.'
- CidrBlock:
- type: object
- properties:
- cidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv4 CIDR block.
- description: Describes an IPv4 CIDR block.
- CidrBlockSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CidrBlock'
- - xml:
- name: item
- ClassicLinkDnsSupport:
- type: object
- properties:
- classicLinkDnsSupported:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether ClassicLink DNS support is enabled for the VPC.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- description: Describes the ClassicLink DNS support status of a VPC.
- ClassicLinkDnsSupportList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ClassicLinkDnsSupport'
- - xml:
- name: item
- GroupIdentifierList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/GroupIdentifier'
- - xml:
- name: item
- ClassicLinkInstance:
- type: object
- properties:
- groupSet:
- allOf:
- - $ref: '#/components/schemas/GroupIdentifierList'
- - description: A list of security groups.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the instance.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- description: Describes a linked EC2-Classic instance.
- ClassicLinkInstanceList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ClassicLinkInstance'
- - xml:
- name: item
- ClassicLoadBalancer:
- type: object
- properties:
- name:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the load balancer.
- description: Describes a Classic Load Balancer.
- ClassicLoadBalancers:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ClassicLoadBalancer'
- - xml:
- name: item
- minItems: 1
- maxItems: 5
- ClassicLoadBalancersConfig:
- type: object
- properties:
- classicLoadBalancers:
- allOf:
- - $ref: '#/components/schemas/ClassicLoadBalancers'
- - description: One or more Classic Load Balancers.
- description: Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers.
- ClientCertificateRevocationListStatusCode:
- type: string
- enum:
- - pending
- - active
- ClientCertificateRevocationListStatus:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/ClientCertificateRevocationListStatusCode'
- - description: The state of the client certificate revocation list.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A message about the status of the client certificate revocation list, if applicable.'
- description: Describes the state of a client certificate revocation list.
- ClientConnectOptions:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
- description: The options for managing connection authorization for new client connections.
- ClientVpnEndpointAttributeStatus:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/ClientVpnEndpointAttributeStatusCode'
- - description: The status code.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The status message.
- description: Describes the status of the Client VPN endpoint attribute.
- ClientConnectResponseOptions:
- type: object
- properties:
- enabled:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether client connect options are enabled.
- lambdaFunctionArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
- status:
- allOf:
- - $ref: '#/components/schemas/ClientVpnEndpointAttributeStatus'
- - description: The status of any updates to the client connect options.
- description: The options for managing connection authorization for new client connections.
- ClientData:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time that the disk upload starts.
- description: Describes the client-specific data.
- ClientLoginBannerOptions:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.
- description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
- ClientLoginBannerResponseOptions:
- type: object
- properties:
- enabled:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Current state of text banner feature.
Valid values: true | false
The state of the Client VPN endpoint. Possible states include:
pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.
available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.
deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.
deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
' - vpnProtocol: - allOf: - - $ref: '#/components/schemas/VpnProtocol' - - description: The protocol used by the VPN session. - transportProtocol: - allOf: - - $ref: '#/components/schemas/TransportProtocol' - - description: The transport protocol used by the Client VPN endpoint. - vpnPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The port number for the Client VPN endpoint. - associatedTargetNetwork: - allOf: - - $ref: '#/components/schemas/AssociatedTargetNetworkSet' - - deprecated: true - description: 'Information about the associated target networks. A target network is a subnet in a VPC.This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.' - serverCertificateArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the server certificate. - authenticationOptions: - allOf: - - $ref: '#/components/schemas/ClientVpnAuthenticationList' - - description: Information about the authentication method used by the Client VPN endpoint. - connectionLogOptions: - allOf: - - $ref: '#/components/schemas/ConnectionLogResponseOptions' - - description: Information about the client connection logging options for the Client VPN endpoint. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the Client VPN endpoint. - securityGroupIdSet: - allOf: - - $ref: '#/components/schemas/ClientVpnSecurityGroupIdSet' - - description: The IDs of the security groups for the target network. - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - selfServicePortalUrl: - allOf: - - $ref: '#/components/schemas/String' - - description: The URL of the self-service portal. - clientConnectOptions: - allOf: - - $ref: '#/components/schemas/ClientConnectResponseOptions' - - description: The options for managing connection authorization for new client connections. - sessionTimeoutHours: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action.
- status:
- allOf:
- - $ref: '#/components/schemas/ClientVpnRouteStatus'
- - description: The current state of the route.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A brief description of the route.
- description: Information about a Client VPN endpoint route.
- ClientVpnRouteSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ClientVpnRoute'
- - xml:
- name: item
- ClientVpnRouteStatusCode:
- type: string
- enum:
- - creating
- - active
- - failed
- - deleting
- CoipAddressUsage:
- type: object
- properties:
- allocationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The allocation ID of the address.
- awsAccountId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID.
- awsService:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services service.
- coIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The customer-owned IP address.
- description: Describes address usage for a customer-owned address pool.
- CoipAddressUsageSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CoipAddressUsage'
- - xml:
- name: item
- CoipPool:
- type: object
- properties:
- poolId:
- allOf:
- - $ref: '#/components/schemas/Ipv4PoolCoipId'
- - description: The ID of the address pool.
- poolCidrSet:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The address ranges of the address pool.
- localGatewayRouteTableId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRoutetableId'
- - description: The ID of the local gateway route table.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags.
- poolArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The ARN of the address pool.
- description: Describes a customer-owned address pool.
- CoipPoolId:
- type: string
- CoipPoolIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv4PoolCoipId'
- - xml:
- name: item
- CoipPoolMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- CoipPoolSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CoipPool'
- - xml:
- name: item
- ConfirmProductInstanceRequest:
- type: object
- required:
- - InstanceId
- - ProductCode
- title: ConfirmProductInstanceRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The product code. This must be a product code that you own.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ConnectionLogOptions:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the CloudWatch Logs log stream to which the connection data is published.
- description: Describes the client connection logging options for the Client VPN endpoint.
- ConnectionNotificationType:
- type: string
- enum:
- - Topic
- ConnectionNotificationState:
- type: string
- enum:
- - Enabled
- - Disabled
- ConnectionNotification:
- type: object
- properties:
- connectionNotificationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the notification.
- serviceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the endpoint service.
- vpcEndpointId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC endpoint.
- connectionNotificationType:
- allOf:
- - $ref: '#/components/schemas/ConnectionNotificationType'
- - description: The type of notification.
- connectionNotificationArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ARN of the SNS topic for the notification.
- connectionEvents:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: 'The events for the notification. Valid values are Accept, Connect, Delete, and Reject.'
- connectionNotificationState:
- allOf:
- - $ref: '#/components/schemas/ConnectionNotificationState'
- - description: The state of the notification.
- description: Describes a connection notification for a VPC endpoint or VPC endpoint service.
- ConnectionNotificationIdsList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ConnectionNotificationId'
- - xml:
- name: item
- ConnectionNotificationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ConnectionNotification'
- - xml:
- name: item
- ConnectivityType:
- type: string
- enum:
- - private
- - public
- ConversionIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ConversionTaskId'
- - xml:
- name: item
- ImportInstanceTaskDetails:
- type: object
- properties:
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the task.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance.
- platform:
- allOf:
- - $ref: '#/components/schemas/PlatformValues'
- - description: The instance operating system.
- volumes:
- allOf:
- - $ref: '#/components/schemas/ImportInstanceVolumeDetailSet'
- - description: The volumes.
- description: Describes an import instance task.
- ImportVolumeTaskDetails:
- type: object
- properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone where the resulting volume will reside.
- bytesConverted:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: The number of bytes converted so far.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description you provided when starting the import volume task.
- image:
- allOf:
- - $ref: '#/components/schemas/DiskImageDescription'
- - description: The image.
- volume:
- allOf:
- - $ref: '#/components/schemas/DiskImageVolumeDescription'
- - description: The volume.
- description: Describes an import volume task.
- ConversionTaskState:
- type: string
- enum:
- - active
- - cancelling
- - cancelled
- - completed
- ConversionTask:
- type: object
- properties:
- conversionTaskId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the conversion task.
- expirationTime:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The time when the task expires. If the upload isn''t complete before the expiration time, we automatically cancel the task.'
- importInstance:
- allOf:
- - $ref: '#/components/schemas/ImportInstanceTaskDetails'
- - description: 'If the task is for importing an instance, this contains information about the import instance task.'
- importVolume:
- allOf:
- - $ref: '#/components/schemas/ImportVolumeTaskDetails'
- - description: 'If the task is for importing a volume, this contains information about the import volume task.'
- state:
- allOf:
- - $ref: '#/components/schemas/ConversionTaskState'
- - description: The state of the conversion task.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The status message related to the conversion task.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the task.
- description: Describes a conversion task.
- CopyFpgaImageRequest:
- type: object
- required:
- - SourceFpgaImageId
- - SourceRegion
- title: CopyFpgaImageRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.'
- CopyImageRequest:
- type: object
- required:
- - Name
- - SourceImageId
- - SourceRegion
- title: CopyImageRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description for the new AMI in the destination Region.
- encrypted:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.'
- kmsKeyId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copying AMIs from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for CopyImage.
- KmsKeyId:
- type: string
- CopySnapshotRequest:
- type: object
- required:
- - SourceRegion
- - SourceSnapshotId
- title: CopySnapshotRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
' - destinationRegion: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is specified using the --region parameter or the default Region in your Amazon Web Services configuration file.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
' - presignedUrl: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the EBS snapshot to copy. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the new snapshot. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- CopyTagsFromSource:
- type: string
- enum:
- - volume
- CoreCount:
- type: integer
- CoreCountList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CoreCount'
- - xml:
- name: item
- CoreNetworkArn:
- type: string
- CpuManufacturer:
- type: string
- enum:
- - intel
- - amd
- - amazon-web-services
- CpuManufacturerSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CpuManufacturer'
- - xml:
- name: item
- CpuOptions:
- type: object
- properties:
- coreCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of CPU cores for the instance.
- threadsPerCore:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of threads per CPU core.
- description: The CPU options for the instance.
- CpuOptionsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.'
- description: The CPU options for the instance. Both the core count and threads per core must be specified in the request.
- CreateCapacityReservationFleetRequest:
- type: object
- required:
- - InstanceTypeSpecifications
- - TotalTargetCapacity
- title: CreateCapacityReservationFleetRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.'
- InstanceTypeSpecification:
- allOf:
- - $ref: '#/components/schemas/FleetInstanceMatchCriteria'
- - description: 'Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- CreateCapacityReservationRequest:
- type: object
- required:
- - InstanceType
- - InstancePlatform
- - InstanceCount
- title: CreateCapacityReservationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/PlacementGroupArn'
- - description: 'The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.'
- CreateCarrierGatewayRequest:
- type: object
- required:
- - VpcId
- title: CreateCarrierGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC to associate with the carrier gateway.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- CreateClientVpnEndpointRequest:
- type: object
- required:
- - ClientCidrBlock
- - ServerCertificateArn
- - AuthenticationOptions
- - ConnectionLogOptions
- title: CreateClientVpnEndpointRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ARN of the server certificate. For more information, see the Certificate Manager User Guide.'
- Authentication:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to apply to the Client VPN endpoint during creation.
- SecurityGroupId:
- allOf:
- - $ref: '#/components/schemas/ClientLoginBannerOptions'
- - description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
- CreateClientVpnRouteRequest:
- type: object
- required:
- - ClientVpnEndpointId
- - DestinationCidrBlock
- - TargetVpcSubnetId
- title: CreateClientVpnRouteRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- GatewayType:
- type: string
- enum:
- - ipsec.1
- CreateCustomerGatewayRequest:
- type: object
- required:
- - BgpAsn
- - Type
- title: CreateCustomerGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'For devices that support BGP, the customer gateway''s BGP ASN.
Default: 65000
' - IpAddress: - allOf: - - $ref: '#/components/schemas/GatewayType' - - description: The type of VPN connection that this customer gateway supports (ipsec.1).
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A name for the customer gateway device.
Length Constraints: Up to 255 characters.
' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for CreateCustomerGateway.
- CustomerGateway:
- type: object
- properties:
- bgpAsn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
- customerGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the customer gateway.
- ipAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Internet-routable IP address of the customer gateway's outside interface.
- certificateArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) for the customer gateway certificate.
- state:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The current state of the customer gateway (pending | available | deleting | deleted).
- type:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The type of VPN connection the customer gateway supports (ipsec.1).
- deviceName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of customer gateway device.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the customer gateway.
- description: Describes a customer gateway.
- CreateDefaultSubnetRequest:
- type: object
- required:
- - AvailabilityZone
- title: CreateDefaultSubnetRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.'
- Subnet:
- type: object
- properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone of the subnet.
- availabilityZoneId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The AZ ID of the subnet.
- availableIpAddressCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
- cidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv4 CIDR block assigned to the subnet.
- defaultForAz:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether this is the default subnet for the Availability Zone.
- enableLniAtDeviceIndex:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: ' Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1). '
- mapPublicIpOnLaunch:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether instances launched in this subnet receive a public IPv4 address.
- mapCustomerOwnedIpOnLaunch:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
- customerOwnedIpv4Pool:
- allOf:
- - $ref: '#/components/schemas/CoipPoolId'
- - description: The customer-owned IPv4 address pool associated with the subnet.
- state:
- allOf:
- - $ref: '#/components/schemas/SubnetState'
- - description: The current state of the subnet.
- subnetId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the subnet.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC the subnet is in.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the subnet.
- assignIpv6AddressOnCreation:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
- ipv6CidrBlockAssociationSet:
- allOf:
- - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociationSet'
- - description: Information about the IPv6 CIDR blocks associated with the subnet.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the subnet.
- subnetArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the subnet.
- outpostArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the Outpost.
- enableDns64:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
- ipv6Native:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether this is an IPv6 only subnet.
- privateDnsNameOptionsOnLaunch:
- allOf:
- - $ref: '#/components/schemas/PrivateDnsNameOptionsOnLaunch'
- - description: The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.
- description: Describes a subnet.
- CreateDefaultVpcRequest:
- type: object
- title: CreateDefaultVpcRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Vpc:
- type: object
- properties:
- cidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The primary IPv4 CIDR block for the VPC.
- dhcpOptionsId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the set of DHCP options you've associated with the VPC.
- state:
- allOf:
- - $ref: '#/components/schemas/VpcState'
- - description: The current state of the VPC.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the VPC.
- instanceTenancy:
- allOf:
- - $ref: '#/components/schemas/Tenancy'
- - description: The allowed tenancy of instances launched into the VPC.
- ipv6CidrBlockAssociationSet:
- allOf:
- - $ref: '#/components/schemas/VpcIpv6CidrBlockAssociationSet'
- - description: Information about the IPv6 CIDR blocks associated with the VPC.
- cidrBlockAssociationSet:
- allOf:
- - $ref: '#/components/schemas/VpcCidrBlockAssociationSet'
- - description: Information about the IPv4 CIDR blocks associated with the VPC.
- isDefault:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the VPC is the default VPC.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the VPC.
- description: Describes a VPC.
- NewDhcpConfigurationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NewDhcpConfiguration'
- - xml:
- name: item
- CreateDhcpOptionsRequest:
- type: object
- required:
- - DhcpConfigurations
- title: CreateDhcpOptionsRequest
- properties:
- dhcpConfiguration:
- allOf:
- - $ref: '#/components/schemas/NewDhcpConfigurationList'
- - description: A DHCP configuration option.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to assign to the DHCP option.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DhcpOptions:
- type: object
- properties:
- dhcpConfigurationSet:
- allOf:
- - $ref: '#/components/schemas/DhcpConfigurationList'
- - description: One or more DHCP options in the set.
- dhcpOptionsId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the set of DHCP options.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the DHCP options set.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the DHCP options set.
- description: Describes a set of DHCP options.
- CreateEgressOnlyInternetGatewayRequest:
- type: object
- required:
- - VpcId
- title: CreateEgressOnlyInternetGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC for which to create the egress-only internet gateway.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to assign to the egress-only internet gateway.
- EgressOnlyInternetGateway:
- type: object
- properties:
- attachmentSet:
- allOf:
- - $ref: '#/components/schemas/InternetGatewayAttachmentList'
- - description: Information about the attachment of the egress-only internet gateway.
- egressOnlyInternetGatewayId:
- allOf:
- - $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
- - description: The ID of the egress-only internet gateway.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the egress-only internet gateway.
- description: Describes an egress-only internet gateway.
- LaunchTemplateAndOverridesResponse:
- type: object
- properties:
- launchTemplateSpecification:
- allOf:
- - $ref: '#/components/schemas/FleetLaunchTemplateSpecification'
- - description: The launch template.
- overrides:
- allOf:
- - $ref: '#/components/schemas/FleetLaunchTemplateOverrides'
- - description: Any parameters that you specify override the same parameters in the launch template.
- description: Describes a launch template and overrides.
- InstanceLifecycle:
- type: string
- enum:
- - spot
- - on-demand
- CreateFleetError:
- type: object
- properties:
- launchTemplateAndOverrides:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
- - description: The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
- lifecycle:
- allOf:
- - $ref: '#/components/schemas/InstanceLifecycle'
- - description: Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
- errorCode:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.'
- errorMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.'
- description: Describes the instances that could not be launched by the fleet.
- CreateFleetErrorsSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CreateFleetError'
- - xml:
- name: item
- InstanceIdsSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - xml:
- name: item
- PlatformValues:
- type: string
- enum:
- - Windows
- CreateFleetInstance:
- type: object
- properties:
- launchTemplateAndOverrides:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
- - description: The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
- lifecycle:
- allOf:
- - $ref: '#/components/schemas/InstanceLifecycle'
- - description: Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
- instanceIds:
- allOf:
- - $ref: '#/components/schemas/InstanceIdsSet'
- - description: The IDs of the instances.
- instanceType:
- allOf:
- - $ref: '#/components/schemas/InstanceType'
- - description: The instance type.
- platform:
- allOf:
- - $ref: '#/components/schemas/PlatformValues'
- - description: 'The value is Windows for Windows instances. Otherwise, the value is blank.'
- description: Describes the instances that were launched by the fleet.
- CreateFleetInstancesSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CreateFleetInstance'
- - xml:
- name: item
- CreateFleetRequest:
- type: object
- required:
- - LaunchTemplateConfigs
- - TargetCapacitySpecification
- title: CreateFleetRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Reserved.
- DestinationOptionsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is false.
- description: Describes the destination options for a flow log.
- CreateFlowLogsRequest:
- type: object
- required:
- - ResourceIds
- - ResourceType
- - TrafficType
- title: CreateFlowLogsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow log records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.
Specify the fields using the ${field-id} format, separated by spaces. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- instanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of the instance.
- name:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)
' - noReboot: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can''t guarantee the file system integrity of the created image.
Default: false (follow standard reboot process)
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
To tag the AMI, the value for ResourceType must be image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
' - InstanceEventWindowCronExpression: - type: string - CreateInstanceEventWindowRequest: - type: object - title: CreateInstanceEventWindowRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the event window. - TimeRange: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowCronExpression' - - description: 'The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can''t specify a time range.
Constraints:
Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the event window. - ExportToS3TaskSpecification: - type: object - properties: - containerFormat: - allOf: - - $ref: '#/components/schemas/ContainerFormat' - - description: 'The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.' - diskImageFormat: - allOf: - - $ref: '#/components/schemas/DiskImageFormat' - - description: The format for the exported image. - s3Bucket: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services accountvm-import-export@amazon.com.
- s3Prefix:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
- description: Describes an export instance task.
- ExportEnvironment:
- type: string
- enum:
- - citrix
- - vmware
- - microsoft
- CreateInstanceExportTaskRequest:
- type: object
- required:
- - ExportToS3Task
- - InstanceId
- - TargetEnvironment
- title: CreateInstanceExportTaskRequest
- properties:
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description for the conversion task or the resource being exported. The maximum length is 255 characters.
- exportToS3:
- allOf:
- - $ref: '#/components/schemas/ExportToS3TaskSpecification'
- - description: The format and location for an export instance task.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of the instance.
- targetEnvironment:
- allOf:
- - $ref: '#/components/schemas/ExportEnvironment'
- - description: The target virtualization environment.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to apply to the export instance task during creation.
- ExportTask:
- type: object
- properties:
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the resource being exported.
- exportTaskId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the export task.
- exportToS3:
- allOf:
- - $ref: '#/components/schemas/ExportToS3Task'
- - description: Information about the export task.
- instanceExport:
- allOf:
- - $ref: '#/components/schemas/InstanceExportDetails'
- - description: Information about the instance to export.
- state:
- allOf:
- - $ref: '#/components/schemas/ExportTaskState'
- - description: The state of the export task.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The status message related to the export task.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for the export task.
- description: Describes an export instance task.
- CreateInternetGatewayRequest:
- type: object
- title: CreateInternetGatewayRequest
- properties:
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to assign to the internet gateway.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- InternetGateway:
- type: object
- properties:
- attachmentSet:
- allOf:
- - $ref: '#/components/schemas/InternetGatewayAttachmentList'
- - description: Any VPCs attached to the internet gateway.
- internetGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the internet gateway.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the internet gateway.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the internet gateway.
- description: Describes an internet gateway.
- IpamNetmaskLength:
- type: integer
- minimum: 0
- maximum: 128
- RequestIpamResourceTagList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/RequestIpamResourceTag'
- - xml:
- name: item
- IpamPoolAwsService:
- type: string
- enum:
- - ec2
- CreateIpamPoolRequest:
- type: object
- required:
- - IpamScopeId
- - AddressFamily
- title: CreateIpamPoolRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/IpamNetmaskLength'
- - description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.'
- AllocationResourceTag:
- allOf:
- - $ref: '#/components/schemas/RequestIpamResourceTagList'
- - description: 'Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/IpamPoolAwsService'
- - description: 'Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.'
- IpamPool:
- type: object
- properties:
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID of the owner of the IPAM pool.
- ipamPoolId:
- allOf:
- - $ref: '#/components/schemas/IpamPoolId'
- - description: The ID of the IPAM pool.
- sourceIpamPoolId:
- allOf:
- - $ref: '#/components/schemas/IpamPoolId'
- - description: The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
- ipamPoolArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The ARN of the IPAM pool.
- ipamScopeArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The ARN of the scope of the IPAM pool.
- ipamScopeType:
- allOf:
- - $ref: '#/components/schemas/IpamScopeType'
- - description: 'In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.'
- ipamArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The ARN of the IPAM.
- ipamRegion:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services Region of the IPAM pool.
- locale:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you''ll get an error.'
- poolDepth:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide. '
- state:
- allOf:
- - $ref: '#/components/schemas/IpamPoolState'
- - description: The state of the IPAM pool.
- stateMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A message related to the failed creation of an IPAM pool.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the IPAM pool.
- autoImport:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
' - publiclyAdvertisable: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set toipv4.
- addressFamily:
- allOf:
- - $ref: '#/components/schemas/AddressFamily'
- - description: The address family of the pool.
- allocationMinNetmaskLength:
- allOf:
- - $ref: '#/components/schemas/IpamNetmaskLength'
- - description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
- allocationMaxNetmaskLength:
- allOf:
- - $ref: '#/components/schemas/IpamNetmaskLength'
- - description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
- allocationDefaultNetmaskLength:
- allOf:
- - $ref: '#/components/schemas/IpamNetmaskLength'
- - description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.'
- allocationResourceTagSet:
- allOf:
- - $ref: '#/components/schemas/IpamResourceTagList'
- - description: 'Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.'
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
- awsService:
- allOf:
- - $ref: '#/components/schemas/IpamPoolAwsService'
- - description: 'Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.'
- description: 'In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.'
- CreateIpamRequest:
- type: object
- title: CreateIpamRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description for the IPAM.
- OperatingRegion:
- allOf:
- - $ref: '#/components/schemas/AddIpamOperatingRegionSet'
- - description: 'The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - Ipam: - type: object - properties: - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID of the owner of the IPAM. - ipamId: - allOf: - - $ref: '#/components/schemas/IpamId' - - description: The ID of the IPAM. - ipamArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The ARN of the IPAM. - ipamRegion: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services Region of the IPAM. - publicDefaultScopeId: - allOf: - - $ref: '#/components/schemas/IpamScopeId' - - description: The ID of the IPAM's default public scope. - privateDefaultScopeId: - allOf: - - $ref: '#/components/schemas/IpamScopeId' - - description: The ID of the IPAM's default private scope. - scopeCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide. ' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description for the IPAM. - operatingRegionSet: - allOf: - - $ref: '#/components/schemas/IpamOperatingRegionSet' - - description: 'The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' - state: - allOf: - - $ref: '#/components/schemas/IpamState' - - description: The state of the IPAM. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
- description: 'IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.'
- CreateIpamScopeRequest:
- type: object
- required:
- - IpamId
- title: CreateIpamScopeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description for the scope you're creating.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
- IpamScope:
- type: object
- properties:
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID of the owner of the scope.
- ipamScopeId:
- allOf:
- - $ref: '#/components/schemas/IpamScopeId'
- - description: The ID of the scope.
- ipamScopeArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The ARN of the scope.
- ipamArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The ARN of the IPAM.
- ipamRegion:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services Region of the IPAM scope.
- ipamScopeType:
- allOf:
- - $ref: '#/components/schemas/IpamScopeType'
- - description: The type of the scope.
- isDefault:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Defines if the scope is the default scope or not.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the scope.
- poolCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of pools in the scope.
- state:
- allOf:
- - $ref: '#/components/schemas/IpamScopeState'
- - description: The state of the IPAM scope.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
- description: 'In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see How IPAM works in the Amazon VPC IPAM User Guide.
' - KeyType: - type: string - enum: - - rsa - - ed25519 - KeyFormat: - type: string - enum: - - pem - - ppk - CreateKeyPairRequest: - type: object - required: - - KeyName - title: CreateKeyPairRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A unique name for the key pair.
Constraints: Up to 255 ASCII characters
' - dryRun: - allOf: - - $ref: '#/components/schemas/KeyType' - - description: 'The type of key pair. Note that ED25519 keys are not supported for Windows instances.
Default: rsa
The format of the key pair.
Default: pem
The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance at Launch (Linux) or Adding User Data (Windows).
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
' - TagSpecification: - allOf: - - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequestList' - - description: 'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.' - ElasticGpuSpecification: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecificationList' - - description: An elastic GPU to associate with the instance. - ElasticInferenceAccelerator: - allOf: - - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorList' - - description: ' The elastic inference accelerator for the instance. ' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: 'One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.' - SecurityGroup: - allOf: - - $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationRequest' - - description: 'The Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults toopen, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
- LicenseSpecification:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptionsRequest'
- - description: The maintenance options for the instance.
- description: The information to include in the launch template.
You must specify at least one parameter for the launch template data.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- LocalGatewayRoute:
- type: object
- properties:
- destinationCidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The CIDR block used for destination matches.
- localGatewayVirtualInterfaceGroupId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
- - description: The ID of the virtual interface group.
- type:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteType'
- - description: The route type.
- state:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteState'
- - description: The state of the route.
- localGatewayRouteTableId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRoutetableId'
- - description: The ID of the local gateway route table.
- localGatewayRouteTableArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The Amazon Resource Name (ARN) of the local gateway route table.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the local gateway route.
- description: Describes a route for a local gateway route table.
- CreateLocalGatewayRouteTableVpcAssociationRequest:
- type: object
- required:
- - LocalGatewayRouteTableId
- - VpcId
- title: CreateLocalGatewayRouteTableVpcAssociationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- LocalGatewayRouteTableVpcAssociation:
- type: object
- properties:
- localGatewayRouteTableVpcAssociationId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId'
- - description: The ID of the association.
- localGatewayRouteTableId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the local gateway route table.
- localGatewayRouteTableArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The Amazon Resource Name (ARN) of the local gateway route table for the association.
- localGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the local gateway.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the local gateway route table for the association.
- state:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The state of the association.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the association.
- description: Describes an association between a local gateway route table and a VPC.
- CreateManagedPrefixListRequest:
- type: object
- required:
- - PrefixListName
- - MaxEntries
- - AddressFamily
- title: CreateManagedPrefixListRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Up to 255 UTF-8 characters in length.
' - ManagedPrefixList: - type: object - properties: - prefixListId: - allOf: - - $ref: '#/components/schemas/PrefixListResourceId' - - description: The ID of the prefix list. - addressFamily: - allOf: - - $ref: '#/components/schemas/String' - - description: The IP address version. - state: - allOf: - - $ref: '#/components/schemas/PrefixListState' - - description: The current state of the prefix list. - stateMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The state message. - prefixListArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The Amazon Resource Name (ARN) for the prefix list. - prefixListName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the prefix list. - maxEntries: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The maximum number of entries for the prefix list. - version: - allOf: - - $ref: '#/components/schemas/Long' - - description: The version of the prefix list. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the prefix list. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the owner of the prefix list. - description: Describes a managed prefix list. - CreateNatGatewayRequest: - type: object - required: - - SubnetId - title: CreateNatGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The subnet in which to create the NAT gateway. - TagSpecification: - allOf: - - $ref: '#/components/schemas/ConnectivityType' - - description: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity. - NatGateway: - type: object - properties: - createTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The date and time the NAT gateway was created. - deleteTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The date and time the NAT gateway was deleted, if applicable.' - failureCode: - allOf: - - $ref: '#/components/schemas/String' - - description: 'If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)'
- failureMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
The state of the NAT gateway.
pending: The NAT gateway is being created and is not ready to process traffic.
failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.
available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.
deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.
deleted: The NAT gateway has been terminated and is no longer processing traffic.
172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.'
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- egress:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
- Icmp:
- allOf:
- - $ref: '#/components/schemas/IcmpTypeCode'
- - description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.'
- ipv6CidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).'
- networkAclId:
- allOf:
- - $ref: '#/components/schemas/NetworkAclId'
- - description: The ID of the network ACL.
- portRange:
- allOf:
- - $ref: '#/components/schemas/PortRange'
- - description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).'
- protocol:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.'
- ruleAction:
- allOf:
- - $ref: '#/components/schemas/RuleAction'
- - description: Indicates whether to allow or deny the traffic that matches the rule.
- ruleNumber:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
' - CreateNetworkAclRequest: - type: object - required: - - VpcId - title: CreateNetworkAclRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- vpcId:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to assign to the network ACL.
- NetworkAcl:
- type: object
- properties:
- associationSet:
- allOf:
- - $ref: '#/components/schemas/NetworkAclAssociationList'
- - description: Any associations between the network ACL and one or more subnets
- entrySet:
- allOf:
- - $ref: '#/components/schemas/NetworkAclEntryList'
- - description: One or more entries (rules) in the network ACL.
- default:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether this is the default network ACL for the VPC.
- networkAclId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network ACL.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the network ACL.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC for the network ACL.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the network ACL.
- description: Describes a network ACL.
- CreateNetworkInsightsAccessScopeRequest:
- type: object
- required:
- - ClientToken
- title: CreateNetworkInsightsAccessScopeRequest
- properties:
- MatchPath:
- allOf:
- - $ref: '#/components/schemas/AccessScopePathListRequest'
- - description: The paths to match.
- ExcludePath:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- NetworkInsightsAccessScope:
- type: object
- properties:
- networkInsightsAccessScopeId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- - description: The ID of the Network Access Scope.
- networkInsightsAccessScopeArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The Amazon Resource Name (ARN) of the Network Access Scope.
- createdDate:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The creation date.
- updatedDate:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The last updated date.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags.
- description: Describes a Network Access Scope.
- NetworkInsightsAccessScopeContent:
- type: object
- properties:
- networkInsightsAccessScopeId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- - description: The ID of the Network Access Scope.
- matchPathSet:
- allOf:
- - $ref: '#/components/schemas/AccessScopePathList'
- - description: The paths to match.
- excludePathSet:
- allOf:
- - $ref: '#/components/schemas/AccessScopePathList'
- - description: The paths to exclude.
- description: Describes the Network Access Scope content.
- CreateNetworkInsightsPathRequest:
- type: object
- required:
- - Source
- - Destination
- - Protocol
- - ClientToken
- title: CreateNetworkInsightsPathRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Port'
- - description: The destination port.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- NetworkInsightsPath:
- type: object
- properties:
- networkInsightsPathId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsPathId'
- - description: The ID of the path.
- networkInsightsPathArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The Amazon Resource Name (ARN) of the path.
- createdDate:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time stamp when the path was created.
- source:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services resource that is the source of the path.
- destination:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services resource that is the destination of the path.
- sourceIp:
- allOf:
- - $ref: '#/components/schemas/IpAddress'
- - description: The IP address of the Amazon Web Services resource that is the source of the path.
- destinationIp:
- allOf:
- - $ref: '#/components/schemas/IpAddress'
- - description: The IP address of the Amazon Web Services resource that is the destination of the path.
- protocol:
- allOf:
- - $ref: '#/components/schemas/Protocol'
- - description: The protocol.
- destinationPort:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The destination port.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags associated with the path.
- description: Describes a path.
- CreateNetworkInterfacePermissionRequest:
- type: object
- required:
- - NetworkInterfaceId
- - Permission
- title: CreateNetworkInterfacePermissionRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for CreateNetworkInterfacePermission.
- NetworkInterfacePermission:
- type: object
- properties:
- networkInterfacePermissionId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network interface permission.
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network interface.
- awsAccountId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID.
- awsService:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Service.
- permission:
- allOf:
- - $ref: '#/components/schemas/InterfacePermissionType'
- - description: The type of permission.
- permissionState:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfacePermissionState'
- - description: Information about the state of the permission.
- description: Describes a permission for a network interface.
- InstanceIpv6AddressList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceIpv6Address'
- - xml:
- name: item
- PrivateIpAddressSpecificationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PrivateIpAddressSpecification'
- - xml:
- name: item
- NetworkInterfaceCreationType:
- type: string
- enum:
- - efa
- - branch
- - trunk
- CreateNetworkInterfaceRequest:
- type: object
- required:
- - SubnetId
- title: CreateNetworkInterfaceRequest
- properties:
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description for the network interface.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SecurityGroupId:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupIdStringList'
- - description: The IDs of one or more security groups.
- ipv6AddressCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can''t use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.'
- ipv6Addresses:
- allOf:
- - $ref: '#/components/schemas/InstanceIpv6AddressList'
- - description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
- privateIpAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The primary private IPv4 address of the network interface. If you don''t specify an IPv4 address, Amazon EC2 selects one for you from the subnet''s IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).'
- privateIpAddresses:
- allOf:
- - $ref: '#/components/schemas/PrivateIpAddressSpecificationList'
- - description: One or more private IPv4 addresses.
- secondaryPrivateIpAddressCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet''s IPv4 CIDR range. You can''t specify this option and specify more than one private IP address using privateIpAddresses.
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.
' - Ipv4Prefix: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use theIpv4 Prefixes option.
- Ipv6Prefix:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceCreationType'
- - description: The type of network interface. The default is interface.
The only supported values are efa and trunk.
true, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.'
- ipv6Native:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether this is an IPv6 only network interface.
- ipv6Address:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 globally unique address associated with the network interface.
- description: Describes a network interface.
- CreatePlacementGroupRequest:
- type: object
- title: CreatePlacementGroupRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- groupName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A name for the placement group. Must be unique within the scope of your account for the Region.
Constraints: Up to 255 ASCII characters
' - strategy: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of partitions. Valid only when Strategy is set topartition.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to apply to the new placement group.
- PlacementGroup:
- type: object
- properties:
- groupName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the placement group.
- state:
- allOf:
- - $ref: '#/components/schemas/PlacementGroupState'
- - description: The state of the placement group.
- strategy:
- allOf:
- - $ref: '#/components/schemas/PlacementStrategy'
- - description: The placement strategy.
- partitionCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of partitions. Valid only if strategy is set to partition.
- groupId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the placement group.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags applied to the placement group.
- groupArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the placement group.
- description: Describes a placement group.
- CreatePublicIpv4PoolRequest:
- type: object
- title: CreatePublicIpv4PoolRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
- CreateReplaceRootVolumeTaskRequest:
- type: object
- required:
- - InstanceId
- title: CreateReplaceRootVolumeTaskRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to apply to the root volume replacement task.
- ReplaceRootVolumeTask:
- type: object
- properties:
- replaceRootVolumeTaskId:
- allOf:
- - $ref: '#/components/schemas/ReplaceRootVolumeTaskId'
- - description: The ID of the root volume replacement task.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance for which the root volume replacement task was created.
- taskState:
- allOf:
- - $ref: '#/components/schemas/ReplaceRootVolumeTaskState'
- - description: 'The state of the task. The task can be in one of the following states:
pending - the replacement volume is being created.
in-progress - the original volume is being detached and the replacement volume is being attached.
succeeded - the replacement volume has been successfully attached to the instance and the instance is available.
failing - the replacement task is in the process of failing.
failed - the replacement task has failed but the original root volume is still attached.
failing-detached - the replacement task is in the process of failing. The instance might have no root volume attached.
failed-detached - the replacement task has failed and the instance has no root volume attached.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- CreateRouteRequest:
- type: object
- required:
- - RouteTableId
- title: CreateRouteRequest
- properties:
- destinationCidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.'
- destinationIpv6CidrBlock:
- allOf:
- - $ref: '#/components/schemas/PrefixListResourceId'
- - description: The ID of a prefix list used for the destination match.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointId'
- - description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
- egressOnlyInternetGatewayId:
- allOf:
- - $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
- - description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
- gatewayId:
- allOf:
- - $ref: '#/components/schemas/RouteGatewayId'
- - description: The ID of an internet gateway or virtual private gateway attached to your VPC.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
- natGatewayId:
- allOf:
- - $ref: '#/components/schemas/CarrierGatewayId'
- - description: The ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
- networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of a network interface. - routeTableId: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - description: The ID of the route table for the route. - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/CoreNetworkArn' - - description: The Amazon Resource Name (ARN) of the core network. - CreateRouteTableRequest: - type: object - required: - - VpcId - title: CreateRouteTableRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- vpcId:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to assign to the route table.
- RouteTable:
- type: object
- properties:
- associationSet:
- allOf:
- - $ref: '#/components/schemas/RouteTableAssociationList'
- - description: The associations between the route table and one or more subnets or a gateway.
- propagatingVgwSet:
- allOf:
- - $ref: '#/components/schemas/PropagatingVgwList'
- - description: Any virtual private gateway (VGW) propagating routes.
- routeTableId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the route table.
- routeSet:
- allOf:
- - $ref: '#/components/schemas/RouteList'
- - description: The routes in the route table.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the route table.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the route table.
- description: Describes a route table.
- CreateSecurityGroupRequest:
- type: object
- required:
- - Description
- - GroupName
- title: CreateSecurityGroupRequest
- properties:
- GroupDescription:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: '[EC2-VPC] The ID of the VPC. Required for EC2-VPC.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to assign to the security group.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- CreateSnapshotRequest:
- type: object
- required:
- - VolumeId
- title: CreateSnapshotRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VolumeId'
- - description: The ID of the Amazon EBS volume.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to apply to the snapshot during creation.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- CreateSnapshotsRequest:
- type: object
- required:
- - InstanceSpecification
- title: CreateSnapshotsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.
To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.
To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.
To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.
For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.
' - TagSpecification: - allOf: - - $ref: '#/components/schemas/CopyTagsFromSource' - - description: Copies the tags from the specified volume to corresponding snapshot. - SnapshotSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/SnapshotInfo' - - xml: - name: item - CreateSpotDatafeedSubscriptionRequest: - type: object - required: - - Bucket - title: CreateSpotDatafeedSubscriptionRequest - properties: - bucket: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- prefix:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The prefix for the data feed file names.
- description: Contains the parameters for CreateSpotDatafeedSubscription.
- SpotDatafeedSubscription:
- type: object
- properties:
- bucket:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the Amazon S3 bucket where the Spot Instance data feed is located.
- fault:
- allOf:
- - $ref: '#/components/schemas/SpotInstanceStateFault'
- - description: 'The fault codes for the Spot Instance request, if any.'
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID of the account.
- prefix:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The prefix for the data feed files.
- state:
- allOf:
- - $ref: '#/components/schemas/DatafeedSubscriptionState'
- - description: The state of the Spot Instance data feed subscription.
- description: Describes the data feed for a Spot Instance.
- CreateStoreImageTaskRequest:
- type: object
- required:
- - ImageId
- - Bucket
- title: CreateStoreImageTaskRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed. '
- S3ObjectTag:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- CreateSubnetCidrReservationRequest:
- type: object
- required:
- - SubnetId
- - Cidr
- - ReservationType
- title: CreateSubnetCidrReservationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to assign to the subnet CIDR reservation.
- SubnetCidrReservation:
- type: object
- properties:
- subnetCidrReservationId:
- allOf:
- - $ref: '#/components/schemas/SubnetCidrReservationId'
- - description: The ID of the subnet CIDR reservation.
- subnetId:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - description: The ID of the subnet.
- cidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The CIDR that has been reserved.
- reservationType:
- allOf:
- - $ref: '#/components/schemas/SubnetCidrReservationType'
- - description: 'The type of reservation. '
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ID of the account that owns the subnet CIDR reservation. '
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description assigned to the subnet CIDR reservation.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the subnet CIDR reservation.
- description: Describes a subnet CIDR reservation.
- CreateSubnetRequest:
- type: object
- required:
- - VpcId
- title: CreateSubnetRequest
- properties:
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to create an IPv6 only subnet.
- ResourceIdList:
- type: array
- items:
- $ref: '#/components/schemas/TaggableResourceId'
- CreateTagsRequest:
- type: object
- required:
- - Resources
- - Tags
- title: CreateTagsRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ResourceId:
- allOf:
- - $ref: '#/components/schemas/ResourceIdList'
- - description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' - Tag: - allOf: - - $ref: '#/components/schemas/TagList' - - description: 'The tags. Thevalue parameter is required, but if you don''t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.'
- CreateTrafficMirrorFilterRequest:
- type: object
- title: CreateTrafficMirrorFilterRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the Traffic Mirror filter.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- TrafficMirrorFilter:
- type: object
- properties:
- trafficMirrorFilterId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Traffic Mirror filter.
- ingressFilterRuleSet:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorFilterRuleList'
- - description: Information about the ingress rules that are associated with the Traffic Mirror filter.
- egressFilterRuleSet:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorFilterRuleList'
- - description: Information about the egress rules that are associated with the Traffic Mirror filter.
- networkServiceSet:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorNetworkServiceList'
- - description: The network service traffic that is associated with the Traffic Mirror filter.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the Traffic Mirror filter.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the Traffic Mirror filter.
- description: Describes the Traffic Mirror filter.
- CreateTrafficMirrorFilterRuleRequest:
- type: object
- required:
- - TrafficMirrorFilterId
- - TrafficDirection
- - RuleNumber
- - RuleAction
- - DestinationCidrBlock
- - SourceCidrBlock
- title: CreateTrafficMirrorFilterRuleRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- TrafficMirrorFilterRule:
- type: object
- properties:
- trafficMirrorFilterRuleId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Traffic Mirror rule.
- trafficMirrorFilterId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Traffic Mirror filter that the rule is associated with.
- trafficDirection:
- allOf:
- - $ref: '#/components/schemas/TrafficDirection'
- - description: The traffic direction assigned to the Traffic Mirror rule.
- ruleNumber:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The rule number of the Traffic Mirror rule.
- ruleAction:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorRuleAction'
- - description: The action assigned to the Traffic Mirror rule.
- protocol:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The protocol assigned to the Traffic Mirror rule.
- destinationPortRange:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorPortRange'
- - description: The destination port range assigned to the Traffic Mirror rule.
- sourcePortRange:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorPortRange'
- - description: The source port range assigned to the Traffic Mirror rule.
- destinationCidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The destination CIDR block assigned to the Traffic Mirror rule.
- sourceCidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The source CIDR block assigned to the Traffic Mirror rule.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the Traffic Mirror rule.
- description: Describes the Traffic Mirror rule.
- CreateTrafficMirrorSessionRequest:
- type: object
- required:
- - NetworkInterfaceId
- - TrafficMirrorTargetId
- - TrafficMirrorFilterId
- - SessionNumber
- title: CreateTrafficMirrorSessionRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the Traffic Mirror session.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- TrafficMirrorSession:
- type: object
- properties:
- trafficMirrorSessionId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID for the Traffic Mirror session.
- trafficMirrorTargetId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Traffic Mirror target.
- trafficMirrorFilterId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Traffic Mirror filter.
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Traffic Mirror session's network interface.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the account that owns the Traffic Mirror session.
- packetLength:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet'
- sessionNumber:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
- virtualNetworkId: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The virtual network ID associated with the Traffic Mirror session. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the Traffic Mirror session. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the Traffic Mirror session. - description: Describes a Traffic Mirror session. - CreateTrafficMirrorTargetRequest: - type: object - title: CreateTrafficMirrorTargetRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the Traffic Mirror target. - TagSpecification: - allOf: - - $ref: '#/components/schemas/VpcEndpointId' - - description: The ID of the Gateway Load Balancer endpoint. - TrafficMirrorTarget: - type: object - properties: - trafficMirrorTargetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Traffic Mirror target. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The network interface ID that is attached to the target. - networkLoadBalancerArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Network Load Balancer. - type: - allOf: - - $ref: '#/components/schemas/TrafficMirrorTargetType' - - description: The type of Traffic Mirror target. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: Information about the Traffic Mirror target. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the account that owns the Traffic Mirror target. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the Traffic Mirror target. - gatewayLoadBalancerEndpointId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Gateway Load Balancer endpoint. - description: Describes a Traffic Mirror target. - InsideCidrBlocksStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - CreateTransitGatewayConnectPeerRequest: - type: object - required: - - TransitGatewayAttachmentId - - PeerAddress - - InsideCidrBlocks - title: CreateTransitGatewayConnectPeerRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InsideCidrBlocksStringList' - - description: 'The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayConnectPeer:
- type: object
- properties:
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentId'
- - description: The ID of the Connect attachment.
- transitGatewayConnectPeerId:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnectPeerId'
- - description: The ID of the Connect peer.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnectPeerState'
- - description: The state of the Connect peer.
- creationTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The creation time.
- connectPeerConfiguration:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnectPeerConfiguration'
- - description: The Connect peer details.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for the Connect peer.
- description: Describes a transit gateway Connect peer.
- CreateTransitGatewayConnectRequestOptions:
- type: object
- required:
- - Protocol
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ProtocolValue'
- - description: The tunnel protocol.
- description: The options for a Connect attachment.
- CreateTransitGatewayConnectRequest:
- type: object
- required:
- - TransportTransitGatewayAttachmentId
- - Options
- title: CreateTransitGatewayConnectRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/CreateTransitGatewayConnectRequestOptions'
- - description: The Connect attachment options.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayConnect:
- type: object
- properties:
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentId'
- - description: The ID of the Connect attachment.
- transportTransitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentId'
- - description: The ID of the attachment from which the Connect attachment was created.
- transitGatewayId:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayId'
- - description: The ID of the transit gateway.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentState'
- - description: The state of the attachment.
- creationTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The creation time.
- options:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnectOptions'
- - description: The Connect attachment options.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for the attachment.
- description: Describes a transit gateway Connect attachment.
- CreateTransitGatewayMulticastDomainRequestOptions:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/AutoAcceptSharedAssociationsValue'
- - description: Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.
- description: The options for the transit gateway multicast domain.
- CreateTransitGatewayMulticastDomainRequest:
- type: object
- required:
- - TransitGatewayId
- title: CreateTransitGatewayMulticastDomainRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainRequestOptions'
- - description: The options for the transit gateway multicast domain.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayMulticastDomain:
- type: object
- properties:
- transitGatewayMulticastDomainId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway multicast domain.
- transitGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway.
- transitGatewayMulticastDomainArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the transit gateway multicast domain.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: ' The ID of the Amazon Web Services account that owns the transit gateway multicast domain.'
- options:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomainOptions'
- - description: The options for the transit gateway multicast domain.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomainState'
- - description: The state of the transit gateway multicast domain.
- creationTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time the transit gateway multicast domain was created.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for the transit gateway multicast domain.
- description: Describes the transit gateway multicast domain.
- CreateTransitGatewayPeeringAttachmentRequest:
- type: object
- required:
- - TransitGatewayId
- - PeerTransitGatewayId
- - PeerAccountId
- - PeerRegion
- title: CreateTransitGatewayPeeringAttachmentRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Region where the peer transit gateway is located.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- CreateTransitGatewayPrefixListReferenceRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- - PrefixListId
- title: CreateTransitGatewayPrefixListReferenceRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayPrefixListReference:
- type: object
- properties:
- transitGatewayRouteTableId:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableId'
- - description: The ID of the transit gateway route table.
- prefixListId:
- allOf:
- - $ref: '#/components/schemas/PrefixListResourceId'
- - description: The ID of the prefix list.
- prefixListOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the prefix list owner.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPrefixListReferenceState'
- - description: The state of the prefix list reference.
- blackhole:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether traffic that matches this route is dropped.
- transitGatewayAttachment:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPrefixListAttachment'
- - description: Information about the transit gateway attachment.
- description: Describes a prefix list reference.
- TransitGatewayRequestOptions:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayCidrBlockStringList'
- - description: 'One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.'
- description: Describes the options for a transit gateway.
- CreateTransitGatewayRequest:
- type: object
- title: CreateTransitGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRequestOptions'
- - description: The transit gateway options.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGateway:
- type: object
- properties:
- transitGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway.
- transitGatewayArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the transit gateway.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayState'
- - description: The state of the transit gateway.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the transit gateway.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the transit gateway.
- creationTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The creation time.
- options:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayOptions'
- - description: The transit gateway options.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for the transit gateway.
- description: Describes a transit gateway.
- CreateTransitGatewayRouteRequest:
- type: object
- required:
- - DestinationCidrBlock
- - TransitGatewayRouteTableId
- title: CreateTransitGatewayRouteRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayRoute:
- type: object
- properties:
- destinationCidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The CIDR block used for destination matches.
- prefixListId:
- allOf:
- - $ref: '#/components/schemas/PrefixListResourceId'
- - description: The ID of the prefix list used for destination matches.
- transitGatewayAttachments:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteAttachmentList'
- - description: The attachments.
- type:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteType'
- - description: The route type.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteState'
- - description: The state of the route.
- description: Describes a route for a transit gateway route table.
- CreateTransitGatewayRouteTableRequest:
- type: object
- required:
- - TransitGatewayId
- title: CreateTransitGatewayRouteTableRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayRouteTable:
- type: object
- properties:
- transitGatewayRouteTableId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway route table.
- transitGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableState'
- - description: The state of the transit gateway route table.
- defaultAssociationRouteTable:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether this is the default association route table for the transit gateway.
- defaultPropagationRouteTable:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether this is the default propagation route table for the transit gateway.
- creationTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The creation time.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the route table.
- description: Describes a transit gateway route table.
- CreateTransitGatewayVpcAttachmentRequest:
- type: object
- required:
- - TransitGatewayId
- - VpcId
- - SubnetIds
- title: CreateTransitGatewayVpcAttachmentRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- CreateTransitGatewayVpcAttachmentRequestOptions:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ApplianceModeSupportValue'
- - description: 'Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.'
- description: Describes the options for a VPC attachment.
- PermissionGroup:
- type: string
- enum:
- - all
- CreateVolumePermission:
- type: object
- properties:
- group:
- allOf:
- - $ref: '#/components/schemas/PermissionGroup'
- - description: The group to be added or removed. The possible value is all.
- userId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account to be added or removed.
- description: Describes the user or group to be added or removed from the list of create volume permissions for a volume.
- CreateVolumePermissionModifications:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/CreateVolumePermissionList'
- - description: Removes the specified Amazon Web Services account ID or group from the list.
- description: Describes modifications to the list of create volume permissions for a volume.
- VolumeType:
- type: string
- enum:
- - standard
- - io1
- - io2
- - gp2
- - sc1
- - st1
- - gp3
- CreateVolumeRequest:
- type: object
- required:
- - AvailabilityZone
- title: CreateVolumeRequest
- properties:
- AvailabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone in which to create the volume.
- encrypted:
- allOf:
- - $ref: '#/components/schemas/VolumeType'
- - description: 'The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: gp2
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.'
- CreateVpcEndpointConnectionNotificationRequest:
- type: object
- required:
- - ConnectionNotificationArn
- - ConnectionEvents
- title: CreateVpcEndpointConnectionNotificationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- VpcEndpointRouteTableIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/RouteTableId'
- - xml:
- name: item
- VpcEndpointSubnetIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - xml:
- name: item
- CreateVpcEndpointRequest:
- type: object
- required:
- - VpcId
- - ServiceName
- title: CreateVpcEndpointRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: '(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.'
- RouteTableId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointRouteTableIdList'
- - description: (Gateway endpoint) One or more route table IDs.
- SubnetId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointSubnetIdList'
- - description: '(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.'
- SecurityGroupId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: '(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
Default: true
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- peerOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Amazon Web Services account ID of the owner of the accepter VPC.
Default: Your Amazon Web Services account ID
' - peerVpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to assign to the peering connection. - CreateVpcRequest: - type: object - title: CreateVpcRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 network range for the VPC, in CIDR notation. For example,10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.'
- amazonProvidedIpv6CidrBlock:
- allOf:
- - $ref: '#/components/schemas/NetmaskLength'
- - description: 'The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.'
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- instanceTenancy:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
Indicate whether to enable acceleration for the VPN connection.
Default: false
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- options:
- allOf:
- - $ref: '#/components/schemas/VpnConnectionOptionsSpecification'
- - description: The options for the VPN connection.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to apply to the VPN connection.
- description: Contains the parameters for CreateVpnConnection.
- VpnConnection:
- type: object
- properties:
- customerGatewayConfiguration:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The configuration information for the VPN connection''s customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it''s present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.'
- customerGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the customer gateway at your end of the VPN connection.
- category:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
- state:
- allOf:
- - $ref: '#/components/schemas/VpnState'
- - description: The current state of the VPN connection.
- type:
- allOf:
- - $ref: '#/components/schemas/GatewayType'
- - description: The type of VPN connection.
- vpnConnectionId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPN connection.
- vpnGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
- transitGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway associated with the VPN connection.
- coreNetworkArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ARN of the core network.
- coreNetworkAttachmentArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ARN of the core network attachment.
- gatewayAssociationState:
- allOf:
- - $ref: '#/components/schemas/GatewayAssociationState'
- - description: The current state of the gateway association.
- options:
- allOf:
- - $ref: '#/components/schemas/VpnConnectionOptions'
- - description: The VPN connection options.
- routes:
- allOf:
- - $ref: '#/components/schemas/VpnStaticRouteList'
- - description: The static routes associated with the VPN connection.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the VPN connection.
- vgwTelemetry:
- allOf:
- - $ref: '#/components/schemas/VgwTelemetryList'
- - description: Information about the VPN tunnel.
- description: Describes a VPN connection.
- CreateVpnConnectionRouteRequest:
- type: object
- required:
- - DestinationCidrBlock
- - VpnConnectionId
- title: CreateVpnConnectionRouteRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpnConnectionId'
- - description: The ID of the VPN connection.
- description: Contains the parameters for CreateVpnConnectionRoute.
- CreateVpnGatewayRequest:
- type: object
- required:
- - Type
- title: CreateVpnGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/GatewayType'
- - description: The type of VPN connection this virtual private gateway supports.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: 'A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you''re using a 16-bit ASN, it must be in the 64512 to 65534 range. If you''re using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
Default: 64512
' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for CreateVpnGateway.
- VpnGateway:
- type: object
- properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.'
- state:
- allOf:
- - $ref: '#/components/schemas/VpnState'
- - description: The current state of the virtual private gateway.
- type:
- allOf:
- - $ref: '#/components/schemas/GatewayType'
- - description: The type of VPN connection the virtual private gateway supports.
- attachments:
- allOf:
- - $ref: '#/components/schemas/VpcAttachmentList'
- - description: Any VPCs attached to the virtual private gateway.
- vpnGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the virtual private gateway.
- amazonSideAsn:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the virtual private gateway.
- description: Describes a virtual private gateway.
- CreditSpecification:
- type: object
- properties:
- cpuCredits:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited.'
- description: 'Describes the credit option for CPU usage of a T2, T3, or T3a instance.'
- CreditSpecificationRequest:
- type: object
- required:
- - CpuCredits
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited.'
- description: 'The credit option for CPU usage of a T2, T3, or T3a instance.'
- CurrentGenerationFlag:
- type: boolean
- CustomerGatewayIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CustomerGatewayId'
- - xml:
- name: CustomerGatewayId
- CustomerGatewayList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/CustomerGateway'
- - xml:
- name: item
- DITMaxResults:
- type: integer
- minimum: 5
- maximum: 100
- DITOMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- DatafeedSubscriptionState:
- type: string
- enum:
- - Active
- - Inactive
- DedicatedHostFlag:
- type: boolean
- DefaultNetworkCardIndex:
- type: integer
- DefaultRouteTableAssociationValue:
- type: string
- enum:
- - enable
- - disable
- DefaultRouteTablePropagationValue:
- type: string
- enum:
- - enable
- - disable
- DefaultTargetCapacityType:
- type: string
- enum:
- - spot
- - on-demand
- DefaultingDhcpOptionsId:
- type: string
- DeleteCarrierGatewayRequest:
- type: object
- required:
- - CarrierGatewayId
- title: DeleteCarrierGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteClientVpnEndpointRequest:
- type: object
- required:
- - ClientVpnEndpointId
- title: DeleteClientVpnEndpointRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteClientVpnRouteRequest:
- type: object
- required:
- - ClientVpnEndpointId
- - DestinationCidrBlock
- title: DeleteClientVpnRouteRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteCustomerGatewayRequest:
- type: object
- required:
- - CustomerGatewayId
- title: DeleteCustomerGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/CustomerGatewayId'
- - description: The ID of the customer gateway.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DeleteCustomerGateway.
- DeleteDhcpOptionsRequest:
- type: object
- required:
- - DhcpOptionsId
- title: DeleteDhcpOptionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/DhcpOptionsId'
- - description: The ID of the DHCP options set.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteEgressOnlyInternetGatewayRequest:
- type: object
- required:
- - EgressOnlyInternetGatewayId
- title: DeleteEgressOnlyInternetGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
- - description: The ID of the egress-only internet gateway.
- DeleteFleetErrorCode:
- type: string
- enum:
- - fleetIdDoesNotExist
- - fleetIdMalformed
- - fleetNotInDeletableState
- - unexpectedError
- DeleteFleetError:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/DeleteFleetErrorCode'
- - description: The error code.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description for the error code.
- description: Describes an EC2 Fleet error.
- DeleteFleetErrorItem:
- type: object
- properties:
- error:
- allOf:
- - $ref: '#/components/schemas/DeleteFleetError'
- - description: The error.
- fleetId:
- allOf:
- - $ref: '#/components/schemas/FleetId'
- - description: The ID of the EC2 Fleet.
- description: Describes an EC2 Fleet that was not successfully deleted.
- DeleteFleetErrorSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DeleteFleetErrorItem'
- - xml:
- name: item
- FleetStateCode:
- type: string
- enum:
- - submitted
- - active
- - deleted
- - failed
- - deleted_running
- - deleted_terminating
- - modifying
- DeleteFleetSuccessItem:
- type: object
- properties:
- currentFleetState:
- allOf:
- - $ref: '#/components/schemas/FleetStateCode'
- - description: The current state of the EC2 Fleet.
- previousFleetState:
- allOf:
- - $ref: '#/components/schemas/FleetStateCode'
- - description: The previous state of the EC2 Fleet.
- fleetId:
- allOf:
- - $ref: '#/components/schemas/FleetId'
- - description: The ID of the EC2 Fleet.
- description: Describes an EC2 Fleet that was successfully deleted.
- DeleteFleetSuccessSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DeleteFleetSuccessItem'
- - xml:
- name: item
- DeleteFleetsRequest:
- type: object
- required:
- - FleetIds
- - TerminateInstances
- title: DeleteFleetsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- FleetId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to terminate the instances.
To let the instances continue to run after the EC2 Fleet is deleted, specify NoTerminateInstances. Supported only for fleets of type maintain and request.
For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- FlowLogId:
- allOf:
- - $ref: '#/components/schemas/FlowLogIdList'
- - description: 'One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
' - DeleteFpgaImageRequest: - type: object - required: - - FpgaImageId - title: DeleteFpgaImageRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FpgaImageId' - - description: The ID of the AFI. - DeleteInstanceEventWindowRequest: - type: object - required: - - InstanceEventWindowId - title: DeleteInstanceEventWindowRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowId' - - description: The ID of the event window. - InstanceEventWindowStateChange: - type: object - properties: - instanceEventWindowId: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowId' - - description: The ID of the event window. - state: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowState' - - description: The current state of the event window. - description: The state of the event window. - DeleteInternetGatewayRequest: - type: object - required: - - InternetGatewayId - title: DeleteInternetGatewayRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- internetGatewayId:
- allOf:
- - $ref: '#/components/schemas/InternetGatewayId'
- - description: The ID of the internet gateway.
- IpamPoolId:
- type: string
- DeleteIpamPoolRequest:
- type: object
- required:
- - IpamPoolId
- title: DeleteIpamPoolRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/IpamPoolId'
- - description: The ID of the pool to delete.
- DeleteIpamRequest:
- type: object
- required:
- - IpamId
- title: DeleteIpamRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:
Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.
No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.
Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.
Deletes all IPAM pools in private scopes.
Deletes all non-default private scopes in the IPAM.
Deletes the default public and private scopes and the IPAM.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteLaunchTemplateRequest:
- type: object
- title: DeleteLaunchTemplateRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateName'
- - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
- VersionStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- DeleteLaunchTemplateVersionsRequest:
- type: object
- required:
- - Versions
- title: DeleteLaunchTemplateVersionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateName'
- - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
- LaunchTemplateVersion:
- allOf:
- - $ref: '#/components/schemas/VersionStringList'
- - description: The version numbers of one or more launch template versions to delete.
- ResponseError:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateErrorCode'
- - description: The error code.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The error message, if applicable.'
- description: Describes the error that's returned when you cannot delete a launch template version.
- DeleteLaunchTemplateVersionsResponseErrorItem:
- type: object
- properties:
- launchTemplateId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the launch template.
- launchTemplateName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the launch template.
- versionNumber:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: The version number of the launch template.
- responseError:
- allOf:
- - $ref: '#/components/schemas/ResponseError'
- - description: Information about the error.
- description: Describes a launch template version that could not be deleted.
- DeleteLaunchTemplateVersionsResponseErrorSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseErrorItem'
- - xml:
- name: item
- DeleteLaunchTemplateVersionsResponseSuccessItem:
- type: object
- properties:
- launchTemplateId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the launch template.
- launchTemplateName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the launch template.
- versionNumber:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: The version number of the launch template.
- description: Describes a launch template version that was successfully deleted.
- DeleteLaunchTemplateVersionsResponseSuccessSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseSuccessItem'
- - xml:
- name: item
- DeleteLocalGatewayRouteRequest:
- type: object
- required:
- - DestinationCidrBlock
- - LocalGatewayRouteTableId
- title: DeleteLocalGatewayRouteRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteLocalGatewayRouteTableVpcAssociationRequest:
- type: object
- required:
- - LocalGatewayRouteTableVpcAssociationId
- title: DeleteLocalGatewayRouteTableVpcAssociationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteManagedPrefixListRequest:
- type: object
- required:
- - PrefixListId
- title: DeleteManagedPrefixListRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/PrefixListResourceId'
- - description: The ID of the prefix list.
- DeleteNatGatewayRequest:
- type: object
- required:
- - NatGatewayId
- title: DeleteNatGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/NatGatewayId'
- - description: The ID of the NAT gateway.
- DeleteNetworkAclEntryRequest:
- type: object
- required:
- - Egress
- - NetworkAclId
- - RuleNumber
- title: DeleteNetworkAclEntryRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- egress:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the rule is an egress rule.
- networkAclId:
- allOf:
- - $ref: '#/components/schemas/NetworkAclId'
- - description: The ID of the network ACL.
- ruleNumber:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The rule number of the entry to delete.
- DeleteNetworkAclRequest:
- type: object
- required:
- - NetworkAclId
- title: DeleteNetworkAclRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- networkAclId:
- allOf:
- - $ref: '#/components/schemas/NetworkAclId'
- - description: The ID of the network ACL.
- DeleteNetworkInsightsAccessScopeAnalysisRequest:
- type: object
- required:
- - NetworkInsightsAccessScopeAnalysisId
- title: DeleteNetworkInsightsAccessScopeAnalysisRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteNetworkInsightsAccessScopeRequest:
- type: object
- required:
- - NetworkInsightsAccessScopeId
- title: DeleteNetworkInsightsAccessScopeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- - description: The ID of the Network Access Scope.
- DeleteNetworkInsightsAnalysisRequest:
- type: object
- required:
- - NetworkInsightsAnalysisId
- title: DeleteNetworkInsightsAnalysisRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAnalysisId'
- - description: The ID of the network insights analysis.
- DeleteNetworkInsightsPathRequest:
- type: object
- required:
- - NetworkInsightsPathId
- title: DeleteNetworkInsightsPathRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsPathId'
- - description: The ID of the path.
- DeleteNetworkInterfacePermissionRequest:
- type: object
- required:
- - NetworkInterfacePermissionId
- title: DeleteNetworkInterfacePermissionRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DeleteNetworkInterfacePermission.
- DeleteNetworkInterfaceRequest:
- type: object
- required:
- - NetworkInterfaceId
- title: DeleteNetworkInterfaceRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceId'
- - description: The ID of the network interface.
- description: Contains the parameters for DeleteNetworkInterface.
- DeletePlacementGroupRequest:
- type: object
- required:
- - GroupName
- title: DeletePlacementGroupRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- groupName:
- allOf:
- - $ref: '#/components/schemas/PlacementGroupName'
- - description: The name of the placement group.
- DeletePublicIpv4PoolRequest:
- type: object
- required:
- - PoolId
- title: DeletePublicIpv4PoolRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Ipv4PoolEc2Id'
- - description: The ID of the public IPv4 pool you want to delete.
- DeleteQueuedReservedInstancesErrorCode:
- type: string
- enum:
- - reserved-instances-id-invalid
- - reserved-instances-not-in-queued-state
- - unexpected-error
- DeleteQueuedReservedInstancesError:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/DeleteQueuedReservedInstancesErrorCode'
- - description: The error code.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The error message.
- description: Describes the error for a Reserved Instance whose queued purchase could not be deleted.
- DeleteQueuedReservedInstancesIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservationId'
- - xml:
- name: item
- minItems: 1
- maxItems: 100
- DeleteQueuedReservedInstancesRequest:
- type: object
- required:
- - ReservedInstancesIds
- title: DeleteQueuedReservedInstancesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ReservedInstancesId:
- allOf:
- - $ref: '#/components/schemas/DeleteQueuedReservedInstancesIdList'
- - description: The IDs of the Reserved Instances.
- SuccessfulQueuedPurchaseDeletionSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SuccessfulQueuedPurchaseDeletion'
- - xml:
- name: item
- FailedQueuedPurchaseDeletionSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/FailedQueuedPurchaseDeletion'
- - xml:
- name: item
- DeleteRouteRequest:
- type: object
- required:
- - RouteTableId
- title: DeleteRouteRequest
- properties:
- destinationCidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
- destinationIpv6CidrBlock:
- allOf:
- - $ref: '#/components/schemas/PrefixListResourceId'
- - description: The ID of the prefix list for the route.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- routeTableId:
- allOf:
- - $ref: '#/components/schemas/RouteTableId'
- - description: The ID of the route table.
- DeleteRouteTableRequest:
- type: object
- required:
- - RouteTableId
- title: DeleteRouteTableRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- routeTableId:
- allOf:
- - $ref: '#/components/schemas/RouteTableId'
- - description: The ID of the route table.
- DeleteSecurityGroupRequest:
- type: object
- title: DeleteSecurityGroupRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupName'
- - description: '[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.'
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteSnapshotRequest:
- type: object
- required:
- - SnapshotId
- title: DeleteSnapshotRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/SnapshotId'
- - description: The ID of the EBS snapshot.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteSpotDatafeedSubscriptionRequest:
- type: object
- title: DeleteSpotDatafeedSubscriptionRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DeleteSpotDatafeedSubscription.
- DeleteSubnetCidrReservationRequest:
- type: object
- required:
- - SubnetCidrReservationId
- title: DeleteSubnetCidrReservationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteSubnetRequest:
- type: object
- required:
- - SubnetId
- title: DeleteSubnetRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - description: The ID of the subnet.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTagsRequest:
- type: object
- required:
- - Resources
- title: DeleteTagsRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- resourceId:
- allOf:
- - $ref: '#/components/schemas/ResourceIdList'
- - description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' - tag: - allOf: - - $ref: '#/components/schemas/TagList' - - description: 'The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.
If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).
Constraints: Up to 1000 tags.
' - DeleteTrafficMirrorFilterRequest: - type: object - required: - - TrafficMirrorFilterId - title: DeleteTrafficMirrorFilterRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTrafficMirrorFilterRuleRequest:
- type: object
- required:
- - TrafficMirrorFilterRuleId
- title: DeleteTrafficMirrorFilterRuleRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTrafficMirrorSessionRequest:
- type: object
- required:
- - TrafficMirrorSessionId
- title: DeleteTrafficMirrorSessionRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTrafficMirrorTargetRequest:
- type: object
- required:
- - TrafficMirrorTargetId
- title: DeleteTrafficMirrorTargetRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTransitGatewayConnectPeerRequest:
- type: object
- required:
- - TransitGatewayConnectPeerId
- title: DeleteTransitGatewayConnectPeerRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTransitGatewayConnectRequest:
- type: object
- required:
- - TransitGatewayAttachmentId
- title: DeleteTransitGatewayConnectRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTransitGatewayMulticastDomainRequest:
- type: object
- required:
- - TransitGatewayMulticastDomainId
- title: DeleteTransitGatewayMulticastDomainRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTransitGatewayPeeringAttachmentRequest:
- type: object
- required:
- - TransitGatewayAttachmentId
- title: DeleteTransitGatewayPeeringAttachmentRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTransitGatewayPrefixListReferenceRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- - PrefixListId
- title: DeleteTransitGatewayPrefixListReferenceRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTransitGatewayRequest:
- type: object
- required:
- - TransitGatewayId
- title: DeleteTransitGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTransitGatewayRouteRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- - DestinationCidrBlock
- title: DeleteTransitGatewayRouteRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTransitGatewayRouteTableRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- title: DeleteTransitGatewayRouteTableRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteTransitGatewayVpcAttachmentRequest:
- type: object
- required:
- - TransitGatewayAttachmentId
- title: DeleteTransitGatewayVpcAttachmentRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteVolumeRequest:
- type: object
- required:
- - VolumeId
- title: DeleteVolumeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VolumeId'
- - description: The ID of the volume.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteVpcEndpointConnectionNotificationsRequest:
- type: object
- required:
- - ConnectionNotificationIds
- title: DeleteVpcEndpointConnectionNotificationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ConnectionNotificationId:
- allOf:
- - $ref: '#/components/schemas/ConnectionNotificationIdsList'
- - description: One or more notification IDs.
- VpcEndpointServiceIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointServiceId'
- - xml:
- name: item
- DeleteVpcEndpointServiceConfigurationsRequest:
- type: object
- required:
- - ServiceIds
- title: DeleteVpcEndpointServiceConfigurationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ServiceId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointServiceIdList'
- - description: The IDs of one or more services.
- DeleteVpcEndpointsRequest:
- type: object
- required:
- - VpcEndpointIds
- title: DeleteVpcEndpointsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- VpcEndpointId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointIdList'
- - description: One or more VPC endpoint IDs.
- description: Contains the parameters for DeleteVpcEndpoints.
- DeleteVpcPeeringConnectionRequest:
- type: object
- required:
- - VpcPeeringConnectionId
- title: DeleteVpcPeeringConnectionRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- vpcPeeringConnectionId:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnectionId'
- - description: The ID of the VPC peering connection.
- DeleteVpcRequest:
- type: object
- required:
- - VpcId
- title: DeleteVpcRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeleteVpnConnectionRequest:
- type: object
- required:
- - VpnConnectionId
- title: DeleteVpnConnectionRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpnConnectionId'
- - description: The ID of the VPN connection.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DeleteVpnConnection.
- DeleteVpnConnectionRouteRequest:
- type: object
- required:
- - DestinationCidrBlock
- - VpnConnectionId
- title: DeleteVpnConnectionRouteRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpnConnectionId'
- - description: The ID of the VPN connection.
- description: Contains the parameters for DeleteVpnConnectionRoute.
- DeleteVpnGatewayRequest:
- type: object
- required:
- - VpnGatewayId
- title: DeleteVpnGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpnGatewayId'
- - description: The ID of the virtual private gateway.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DeleteVpnGateway.
- DeprovisionByoipCidrRequest:
- type: object
- required:
- - Cidr
- title: DeprovisionByoipCidrRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DeprovisionIpamPoolCidrRequest:
- type: object
- required:
- - IpamPoolId
- title: DeprovisionIpamPoolCidrRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The CIDR which you want to deprovision from the pool.
- IpamPoolCidr:
- type: object
- properties:
- cidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.'
- state:
- allOf:
- - $ref: '#/components/schemas/IpamPoolCidrState'
- - description: The state of the CIDR.
- failureReason:
- allOf:
- - $ref: '#/components/schemas/IpamPoolCidrFailureReason'
- - description: Details related to why an IPAM pool CIDR failed to be provisioned.
- description: A CIDR provisioned to an IPAM pool.
- DeprovisionPublicIpv4PoolCidrRequest:
- type: object
- required:
- - PoolId
- - Cidr
- title: DeprovisionPublicIpv4PoolCidrRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The CIDR you want to deprovision from the pool.
- DeprovisionedAddressSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- DeregisterImageRequest:
- type: object
- required:
- - ImageId
- title: DeregisterImageRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ImageId'
- - description: The ID of the AMI.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DeregisterImage.
- DeregisterInstanceTagAttributeRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to deregister all tag keys in the current Region. Specify false to deregister all tag keys.
- InstanceTagKey:
- allOf:
- - $ref: '#/components/schemas/InstanceTagKeySet'
- - description: Information about the tag keys to deregister.
- description: Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
- DeregisterInstanceEventNotificationAttributesRequest:
- type: object
- title: DeregisterInstanceEventNotificationAttributesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/DeregisterInstanceTagAttributeRequest'
- - description: Information about the tag keys to deregister.
- InstanceTagNotificationAttribute:
- type: object
- properties:
- instanceTagKeySet:
- allOf:
- - $ref: '#/components/schemas/InstanceTagKeySet'
- - description: The registered tag keys.
- includeAllTagsOfInstance:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. true indicates that all tag keys in the current Region are registered.
- description: Describes the registered tag keys for the current Region.
- DeregisterTransitGatewayMulticastGroupMembersRequest:
- type: object
- title: DeregisterTransitGatewayMulticastGroupMembersRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayMulticastDeregisteredGroupMembers:
- type: object
- properties:
- transitGatewayMulticastDomainId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway multicast domain.
- deregisteredNetworkInterfaceIds:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The network interface IDs of the deregistered members.
- groupIpAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IP address assigned to the transit gateway multicast group.
- description: Describes the deregistered transit gateway multicast group members.
- DeregisterTransitGatewayMulticastGroupSourcesRequest:
- type: object
- title: DeregisterTransitGatewayMulticastGroupSourcesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayMulticastDeregisteredGroupSources:
- type: object
- properties:
- transitGatewayMulticastDomainId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway multicast domain.
- deregisteredNetworkInterfaceIds:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The network interface IDs of the non-registered members.
- groupIpAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IP address assigned to the transit gateway multicast group.
- description: Describes the deregistered transit gateway multicast group sources.
- DescribeAccountAttributesRequest:
- type: object
- title: DescribeAccountAttributesRequest
- properties:
- attributeName:
- allOf:
- - $ref: '#/components/schemas/AccountAttributeNameStringList'
- - description: The account attribute names.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeAddressesAttributeRequest:
- type: object
- title: DescribeAddressesAttributeRequest
- properties:
- AllocationId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- NextToken:
- type: string
- FilterList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Filter'
- - xml:
- name: Filter
- PublicIpStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: PublicIp
- DescribeAddressesRequest:
- type: object
- title: DescribeAddressesRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters. Filter names and values are case-sensitive.
allocation-id - [EC2-VPC] The allocation ID for the address.
association-id - [EC2-VPC] The association ID for the address.
domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).
instance-id - The ID of the instance the address is associated with, if any.
network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The Amazon Web Services account ID of the owner.
private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
' - AllocationId: - allOf: - - $ref: '#/components/schemas/AllocationIdList' - - description: '[EC2-VPC] Information about the allocation IDs.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeAggregateIdFormatRequest:
- type: object
- title: DescribeAggregateIdFormatRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- IdFormatList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IdFormat'
- - xml:
- name: item
- ZoneNameStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: ZoneName
- DescribeAvailabilityZonesRequest:
- type: object
- title: DescribeAvailabilityZonesRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'The filters.
group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
message - The Zone message.
opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required).
parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name - The name of the Region for the Zone (for example, us-east-1).
state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available).
zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeBundleTasksRequest:
- type: object
- title: DescribeBundleTasksRequest
- properties:
- BundleId:
- allOf:
- - $ref: '#/components/schemas/BundleIdStringList'
- - description: 'The bundle task IDs.
Default: Describes all your bundle tasks.
' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: 'The filters.
bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeByoipCidrsMaxResults:
- type: integer
- minimum: 1
- maximum: 100
- DescribeByoipCidrsRequest:
- type: object
- required:
- - MaxResults
- title: DescribeByoipCidrsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- DescribeCapacityReservationFleetsMaxResults:
- type: integer
- minimum: 1
- maximum: 100
- DescribeCapacityReservationFleetsRequest:
- type: object
- title: DescribeCapacityReservationFleetsRequest
- properties:
- CapacityReservationFleetId:
- allOf:
- - $ref: '#/components/schemas/DescribeCapacityReservationFleetsMaxResults'
- - description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeCapacityReservationsMaxResults:
- type: integer
- minimum: 1
- maximum: 1000
- DescribeCapacityReservationsRequest:
- type: object
- title: DescribeCapacityReservationsRequest
- properties:
- CapacityReservationId:
- allOf:
- - $ref: '#/components/schemas/DescribeCapacityReservationsMaxResults'
- - description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeCarrierGatewaysRequest:
- type: object
- title: DescribeCarrierGatewaysRequest
- properties:
- CarrierGatewayId:
- allOf:
- - $ref: '#/components/schemas/CarrierGatewayIdSet'
- - description: One or more carrier gateway IDs.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeClassicLinkInstancesMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- InstanceIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - xml:
- name: InstanceId
- DescribeClassicLinkInstancesRequest:
- type: object
- title: DescribeClassicLinkInstancesRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
group-id - The ID of a VPC security group that''s associated with the instance.
instance-id - The ID of the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
vpc-id - The ID of the VPC that the instance is linked to.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- InstanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceIdStringList'
- - description: One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
- maxResults:
- allOf:
- - $ref: '#/components/schemas/DescribeClassicLinkInstancesMaxResults'
- - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Constraint: If the value is greater than 1000, we return only 1000 items.
' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next page of results. - DescribeClientVpnAuthorizationRulesMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeClientVpnAuthorizationRulesRequest: - type: object - required: - - ClientVpnEndpointId - title: DescribeClientVpnAuthorizationRulesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to retrieve the next page of results. - Filter: - allOf: - - $ref: '#/components/schemas/DescribeClientVpnAuthorizationRulesMaxResults' - - description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. - DescribeClientVpnConnectionsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeClientVpnConnectionsRequest: - type: object - required: - - ClientVpnEndpointId - title: DescribeClientVpnConnectionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ClientVpnEndpointId' - - description: The ID of the Client VPN endpoint. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeClientVpnEndpointMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- DescribeClientVpnEndpointsRequest:
- type: object
- title: DescribeClientVpnEndpointsRequest
- properties:
- ClientVpnEndpointId:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to retrieve the next page of results.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- EndpointSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ClientVpnEndpoint'
- - xml:
- name: item
- DescribeClientVpnRoutesMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- DescribeClientVpnRoutesRequest:
- type: object
- required:
- - ClientVpnEndpointId
- title: DescribeClientVpnRoutesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ClientVpnEndpointId'
- - description: The ID of the Client VPN endpoint.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeClientVpnTargetNetworksMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- DescribeClientVpnTargetNetworksRequest:
- type: object
- required:
- - ClientVpnEndpointId
- title: DescribeClientVpnTargetNetworksRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to retrieve the next page of results.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TargetNetworkSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TargetNetwork'
- - xml:
- name: item
- DescribeCoipPoolsRequest:
- type: object
- title: DescribeCoipPoolsRequest
- properties:
- PoolId:
- allOf:
- - $ref: '#/components/schemas/CoipPoolIdSet'
- - description: The IDs of the address pools.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeConversionTaskList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ConversionTask'
- - xml:
- name: item
- DescribeConversionTasksRequest:
- type: object
- title: DescribeConversionTasksRequest
- properties:
- conversionTaskId:
- allOf:
- - $ref: '#/components/schemas/ConversionIdStringList'
- - description: The conversion task IDs.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeCustomerGatewaysRequest:
- type: object
- title: DescribeCustomerGatewaysRequest
- properties:
- CustomerGatewayId:
- allOf:
- - $ref: '#/components/schemas/CustomerGatewayIdStringList'
- - description: 'One or more customer gateway IDs.
Default: Describes all your customer gateways.
' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: 'One or more filters.
bgp-asn - The customer gateway''s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway''s Internet-routable external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DescribeCustomerGateways.
- DescribeDhcpOptionsMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- DhcpOptionsIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DhcpOptionsId'
- - xml:
- name: DhcpOptionsId
- DescribeDhcpOptionsRequest:
- type: object
- title: DescribeDhcpOptionsRequest
- properties:
- DhcpOptionsId:
- allOf:
- - $ref: '#/components/schemas/DhcpOptionsIdStringList'
- - description: 'The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: 'One or more filters.
dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
nextToken value.'
- DhcpOptionsList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DhcpOptions'
- - xml:
- name: item
- DescribeEgressOnlyInternetGatewaysMaxResults:
- type: integer
- minimum: 5
- maximum: 255
- DescribeEgressOnlyInternetGatewaysRequest:
- type: object
- title: DescribeEgressOnlyInternetGatewaysRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- EgressOnlyInternetGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next page of results.
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to request the next page of results.
- ElasticGpuSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ElasticGpus'
- - xml:
- name: item
- DescribeExportImageTasksMaxResults:
- type: integer
- minimum: 1
- maximum: 500
- DescribeExportImageTasksRequest:
- type: object
- title: DescribeExportImageTasksRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
- ExportImageTaskId:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: A token that indicates the next page of results.
- ExportImageTaskList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ExportImageTask'
- - xml:
- name: item
- ExportTaskIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ExportTaskId'
- - xml:
- name: ExportTaskId
- DescribeExportTasksRequest:
- type: object
- title: DescribeExportTasksRequest
- properties:
- exportTaskId:
- allOf:
- - $ref: '#/components/schemas/ExportTaskIdStringList'
- - description: The export task IDs.
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: the filters for the export tasks.
- ExportTaskList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ExportTask'
- - xml:
- name: item
- FastLaunchImageIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImageId'
- - xml:
- name: ImageId
- DescribeFastLaunchImagesRequest:
- type: object
- title: DescribeFastLaunchImagesRequest
- properties:
- ImageId:
- allOf:
- - $ref: '#/components/schemas/FastLaunchImageIdList'
- - description: Details for one or more Windows AMI image IDs.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeFastLaunchImagesRequestMaxResults:
- type: integer
- minimum: 0
- maximum: 200
- DescribeFastLaunchImagesSuccessSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DescribeFastLaunchImagesSuccessItem'
- - xml:
- name: item
- FastLaunchResourceType:
- type: string
- enum:
- - snapshot
- FastLaunchSnapshotConfigurationResponse:
- type: object
- properties:
- targetResourceCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of pre-provisioned snapshots requested to keep on hand for a fast-launch enabled Windows AMI.
- description: Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
- FastLaunchLaunchTemplateSpecificationResponse:
- type: object
- properties:
- launchTemplateId:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateId'
- - description: The ID of the launch template for faster launching of the associated Windows AMI.
- launchTemplateName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the launch template for faster launching of the associated Windows AMI.
- version:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The version of the launch template for faster launching of the associated Windows AMI.
- description: Identifies the launch template to use for faster launching of the Windows AMI.
- FastLaunchStateCode:
- type: string
- enum:
- - enabling
- - enabling-failed
- - enabled
- - enabled-failed
- - disabling
- - disabling-failed
- DescribeFastLaunchImagesSuccessItem:
- type: object
- properties:
- imageId:
- allOf:
- - $ref: '#/components/schemas/ImageId'
- - description: The image ID that identifies the fast-launch enabled Windows image.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/FastLaunchResourceType'
- - description: 'The resource type that is used for pre-provisioning the Windows AMI. Supported values include: snapshot.'
- snapshotConfiguration:
- allOf:
- - $ref: '#/components/schemas/FastLaunchSnapshotConfigurationResponse'
- - description: A group of parameters that are used for pre-provisioning the associated Windows AMI using snapshots.
- launchTemplate:
- allOf:
- - $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationResponse'
- - description: The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances from pre-provisioned snapshots.
- maxParallelLaunches:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The maximum number of parallel instances that are launched for creating resources.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The owner ID for the fast-launch enabled Windows AMI.
- state:
- allOf:
- - $ref: '#/components/schemas/FastLaunchStateCode'
- - description: The current state of faster launching for the specified Windows AMI.
- stateTransitionReason:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The reason that faster launching for the Windows AMI changed to the current state.
- stateTransitionTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time that faster launching for the Windows AMI changed to the current state.
- description: Describe details about a fast-launch enabled Windows image that meets the requested criteria. Criteria are defined by the DescribeFastLaunchImages action filters.
- FastSnapshotRestoreStateCode:
- type: string
- enum:
- - enabling
- - optimizing
- - enabled
- - disabling
- - disabled
- DescribeFastSnapshotRestoreSuccessItem:
- type: object
- properties:
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the snapshot.
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone.
- state:
- allOf:
- - $ref: '#/components/schemas/FastSnapshotRestoreStateCode'
- - description: The state of fast snapshot restores.
- stateTransitionReason:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
enabling state.
- optimizingTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time at which fast snapshot restores entered the optimizing state.
- enabledTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time at which fast snapshot restores entered the enabled state.
- disablingTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time at which fast snapshot restores entered the disabling state.
- disabledTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time at which fast snapshot restores entered the disabled state.
- description: Describes fast snapshot restores for a snapshot.
- DescribeFastSnapshotRestoreSuccessSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DescribeFastSnapshotRestoreSuccessItem'
- - xml:
- name: item
- DescribeFastSnapshotRestoresMaxResults:
- type: integer
- minimum: 0
- maximum: 200
- DescribeFastSnapshotRestoresRequest:
- type: object
- title: DescribeFastSnapshotRestoresRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeFleetError:
- type: object
- properties:
- launchTemplateAndOverrides:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
- - description: The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
- lifecycle:
- allOf:
- - $ref: '#/components/schemas/InstanceLifecycle'
- - description: Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
- errorCode:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.'
- errorMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.'
- description: Describes the instances that could not be launched by the fleet.
- DescribeFleetHistoryRequest:
- type: object
- required:
- - FleetId
- - StartTime
- title: DescribeFleetHistoryRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- HistoryRecordSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/HistoryRecordEntry'
- - xml:
- name: item
- DescribeFleetInstancesRequest:
- type: object
- required:
- - FleetId
- title: DescribeFleetInstancesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/FleetId'
- - description: The ID of the EC2 Fleet.
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: The filters.
instance-type - The instance type.
Windows for Windows instances. Otherwise, the value is blank.'
- description: Describes the instances that were launched by the fleet.
- DescribeFleetsInstancesSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DescribeFleetsInstances'
- - xml:
- name: item
- FleetIdSet:
- type: array
- items:
- $ref: '#/components/schemas/FleetId'
- DescribeFleetsRequest:
- type: object
- title: DescribeFleetsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next set of results.
- FleetId:
- allOf:
- - $ref: '#/components/schemas/FleetIdSet'
- - description: 'The IDs of the EC2 Fleets.
If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.
The filters.
activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).
excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).
fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).
replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).
type - The type of request (instant | request | maintain).
One or more filters.
deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).
log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and s3.
flow-log-id - The ID of the flow log.
log-group-name - The name of the log group.
resource-id - The ID of the VPC, subnet, or network interface.
traffic-type - The type of traffic (ACCEPT | REJECT | ALL).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- FpgaImageId:
- allOf:
- - $ref: '#/components/schemas/FpgaImageIdList'
- - description: The AFI IDs.
- Owner:
- allOf:
- - $ref: '#/components/schemas/OwnerStringList'
- - description: 'Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).'
- Filter:
- allOf:
- - $ref: '#/components/schemas/DescribeFpgaImagesMaxResults'
- - description: The maximum number of results to return in a single call.
- FpgaImageList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/FpgaImage'
- - xml:
- name: item
- OfferingId:
- type: string
- DescribeHostReservationOfferingsRequest:
- type: object
- title: DescribeHostReservationOfferingsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/OfferingId'
- - description: The ID of the reservation offering.
- HostOfferingSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/HostOffering'
- - xml:
- name: item
- DescribeHostReservationsMaxResults:
- type: integer
- minimum: 5
- maximum: 500
- DescribeHostReservationsRequest:
- type: object
- title: DescribeHostReservationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to use to retrieve the next page of results.
- HostReservationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/HostReservation'
- - xml:
- name: item
- RequestHostIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DedicatedHostId'
- - xml:
- name: item
- DescribeHostsRequest:
- type: object
- title: DescribeHostsRequest
- properties:
- filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'The filters.
auto-placement - Whether auto-placement is enabled or disabled (on | off).
availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you allocated the host.
host-reservation-id - The ID of the reservation assigned to this host.
instance-type - The instance type size that the Dedicated Host is configured to support.
state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. - HostList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Host' - - xml: - name: item - DescribeIamInstanceProfileAssociationsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeIamInstanceProfileAssociationsRequest: - type: object - title: DescribeIamInstanceProfileAssociationsRequest - properties: - AssociationId: - allOf: - - $ref: '#/components/schemas/AssociationIdList' - - description: The IAM instance profile associations. - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to request the next page of results. - IamInstanceProfileAssociationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileAssociation' - - xml: - name: item - DescribeIdFormatRequest: - type: object - title: DescribeIdFormatRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The type of resource:bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
- DescribeIdentityIdFormatRequest:
- type: object
- required:
- - PrincipalArn
- title: DescribeIdentityIdFormatRequest
- properties:
- principalArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ARN of the principal, which can be an IAM role, IAM user, or the root user.'
- resource:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
- DescribeImageAttributeRequest:
- type: object
- required:
- - Attribute
- - ImageId
- title: DescribeImageAttributeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ImageId'
- - description: The ID of the AMI.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DescribeImageAttribute.
- ExecutableByStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: ExecutableBy
- ImageIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImageId'
- - xml:
- name: ImageId
- DescribeImagesRequest:
- type: object
- title: DescribeImagesRequest
- properties:
- ExecutableBy:
- allOf:
- - $ref: '#/components/schemas/ExecutableByStringList'
- - description: 'Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).
If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.
If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.
If you specify all, all public AMIs are returned.
The filters.
architecture - The image architecture (i386 | x86_64 | arm64).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
description - The description of the image (provided during image creation).
ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
platform - The platform. To only list Windows-based AMIs, use windows.
product-code - The product code.
product-code.type - The type of the product code (marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
virtualization-type - The virtualization type (paravirtual | hvm).
The image IDs.
Default: Describes all images available to you.
' - Owner: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ImageList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Image'
- - xml:
- name: item
- DescribeImportImageTasksRequest:
- type: object
- title: DescribeImportImageTasksRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
- ImportTaskId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A token that indicates the next page of results.
- ImportImageTaskList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImportImageTask'
- - xml:
- name: item
- DescribeImportSnapshotTasksRequest:
- type: object
- title: DescribeImportSnapshotTasksRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: The filters.
- ImportTaskId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A token that indicates the next page of results.
- ImportSnapshotTaskList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImportSnapshotTask'
- - xml:
- name: item
- InstanceAttributeName:
- type: string
- enum:
- - instanceType
- - kernel
- - ramdisk
- - userData
- - disableApiTermination
- - instanceInitiatedShutdownBehavior
- - rootDeviceName
- - blockDeviceMapping
- - productCodes
- - sourceDestCheck
- - groupSet
- - ebsOptimized
- - sriovNetSupport
- - enaSupport
- - enclaveOptions
- DescribeInstanceAttributeRequest:
- type: object
- required:
- - Attribute
- - InstanceId
- title: DescribeInstanceAttributeRequest
- properties:
- attribute:
- allOf:
- - $ref: '#/components/schemas/InstanceAttributeName'
- - description: 'The instance attribute.
Note: The enaSupport attribute is not supported at this time.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- instanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of the instance.
- DescribeInstanceCreditSpecificationsMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- DescribeInstanceCreditSpecificationsRequest:
- type: object
- title: DescribeInstanceCreditSpecificationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: The filters.
instance-id - The ID of the instance.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- InstanceEventWindowIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowId'
- - xml:
- name: InstanceEventWindowId
- DescribeInstanceEventWindowsRequest:
- type: object
- title: DescribeInstanceEventWindowsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- InstanceEventWindowId:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowIdSet'
- - description: The IDs of the event windows.
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to request the next page of results.
- description: The filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- includeAllInstances:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- InstanceType:
- allOf:
- - $ref: '#/components/schemas/RequestInstanceTypeList'
- - description: 'The instance types. For more information, see Instance types in the Amazon EC2 User Guide.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token to retrieve the next page of results.
- InstanceTypeInfoList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceTypeInfo'
- - xml:
- name: item
- DescribeInstancesRequest:
- type: object
- title: DescribeInstancesRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. EC2-Classic only.
group-name - The name of the security group for the instance. EC2-Classic only.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (enabled | disabled)
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance''s reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The instance IDs.
Default: Describes all your instances.
' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- maxResults:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.'
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to request the next page of results.
- ReservationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Reservation'
- - xml:
- name: item
- DescribeInternetGatewaysMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- DescribeInternetGatewaysRequest:
- type: object
- title: DescribeInternetGatewaysRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- internetGatewayId:
- allOf:
- - $ref: '#/components/schemas/DescribeInternetGatewaysMaxResults'
- - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- InternetGatewayList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InternetGateway'
- - xml:
- name: item
- DescribeIpamPoolsRequest:
- type: object
- title: DescribeIpamPoolsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- IpamPoolId:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The IDs of the IPAM pools you would like information on.
- IpamPoolSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpamPool'
- - xml:
- name: item
- DescribeIpamScopesRequest:
- type: object
- title: DescribeIpamScopesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- IpamScopeId:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The IDs of the scopes you want information on.
- IpamScopeSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpamScope'
- - xml:
- name: item
- DescribeIpamsRequest:
- type: object
- title: DescribeIpamsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- IpamId:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The IDs of the IPAMs you want information on.
- IpamSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipam'
- - xml:
- name: item
- DescribeIpv6PoolsRequest:
- type: object
- title: DescribeIpv6PoolsRequest
- properties:
- PoolId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The key pair names.
Default: Describes all of your key pairs.
' - KeyPairId: - allOf: - - $ref: '#/components/schemas/KeyPairIdStringList' - - description: The IDs of the key pairs. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, the public key material is included in the response.
Default: false
NextToken value. This value can be between 1 and 200.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: One or more filters.
create-time - The time the launch template version was created.
ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).
http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).
host-resource-group-arn - The ARN of the host resource group in which to launch the instances.
http-tokens - The state of token usage for your instance metadata requests (optional | required).
iam-instance-profile - The ARN of the IAM instance profile.
image-id - The ID of the AMI.
instance-type - The instance type.
is-default-version - A boolean that indicates whether the launch template version is the default version.
kernel-id - The kernel ID.
license-configuration-arn - The ARN of the license configuration.
network-card-index - The index of the network card.
ram-disk-id - The RAM disk ID.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- LaunchTemplateId:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateIdStringList'
- - description: One or more launch template IDs.
- LaunchTemplateName:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateNameStringList'
- - description: One or more launch template names.
- Filter:
- allOf:
- - $ref: '#/components/schemas/DescribeLaunchTemplatesMaxResults'
- - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.'
- LaunchTemplateSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplate'
- - xml:
- name: item
- LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId'
- - xml:
- name: item
- DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest:
- type: object
- title: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest
- properties:
- LocalGatewayRouteTableVirtualInterfaceGroupAssociationId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet'
- - description: The IDs of the associations.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociation'
- - xml:
- name: item
- LocalGatewayRouteTableVpcAssociationIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId'
- - xml:
- name: item
- DescribeLocalGatewayRouteTableVpcAssociationsRequest:
- type: object
- title: DescribeLocalGatewayRouteTableVpcAssociationsRequest
- properties:
- LocalGatewayRouteTableVpcAssociationId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationIdSet'
- - description: The IDs of the associations.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- LocalGatewayRouteTableVpcAssociationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociation'
- - xml:
- name: item
- LocalGatewayRouteTableIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRoutetableId'
- - xml:
- name: item
- DescribeLocalGatewayRouteTablesRequest:
- type: object
- title: DescribeLocalGatewayRouteTablesRequest
- properties:
- LocalGatewayRouteTableId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableIdSet'
- - description: The IDs of the local gateway route tables.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- LocalGatewayRouteTableSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTable'
- - xml:
- name: item
- LocalGatewayVirtualInterfaceGroupIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
- - xml:
- name: item
- DescribeLocalGatewayVirtualInterfaceGroupsRequest:
- type: object
- title: DescribeLocalGatewayVirtualInterfaceGroupsRequest
- properties:
- LocalGatewayVirtualInterfaceGroupId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupIdSet'
- - description: The IDs of the virtual interface groups.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- LocalGatewayVirtualInterfaceGroupSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroup'
- - xml:
- name: item
- LocalGatewayVirtualInterfaceIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceId'
- - xml:
- name: item
- DescribeLocalGatewayVirtualInterfacesRequest:
- type: object
- title: DescribeLocalGatewayVirtualInterfacesRequest
- properties:
- LocalGatewayVirtualInterfaceId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceIdSet'
- - description: The IDs of the virtual interfaces.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- LocalGatewayVirtualInterfaceSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterface'
- - xml:
- name: item
- LocalGatewayIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayId'
- - xml:
- name: item
- DescribeLocalGatewaysRequest:
- type: object
- title: DescribeLocalGatewaysRequest
- properties:
- LocalGatewayId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayIdSet'
- - description: The IDs of the local gateways.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- LocalGatewaySet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGateway'
- - xml:
- name: item
- DescribeManagedPrefixListsRequest:
- type: object
- title: DescribeManagedPrefixListsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- PrefixListId:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: One or more prefix list IDs.
- ManagedPrefixListSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ManagedPrefixList'
- - xml:
- name: item
- DescribeMovingAddressesMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- DescribeMovingAddressesRequest:
- type: object
- title: DescribeMovingAddressesRequest
- properties:
- filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- maxResults:
- allOf:
- - $ref: '#/components/schemas/DescribeMovingAddressesMaxResults'
- - description: 'The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next page of results. - publicIp: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: One or more Elastic IP addresses. - MovingAddressStatusSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/MovingAddressStatus' - - xml: - name: item - DescribeNatGatewaysMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeNatGatewaysRequest: - type: object - title: DescribeNatGatewaysRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DescribeNatGatewaysMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
- NatGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next page of results.
- NatGatewayList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NatGateway'
- - xml:
- name: item
- DescribeNetworkAclsMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- DescribeNetworkAclsRequest:
- type: object
- title: DescribeNetworkAclsRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the Amazon Web Services account that owns the network ACL.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network ACL.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- NetworkAclId:
- allOf:
- - $ref: '#/components/schemas/DescribeNetworkAclsMaxResults'
- - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- NetworkAclList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkAcl'
- - xml:
- name: item
- DescribeNetworkInsightsAccessScopeAnalysesRequest:
- type: object
- title: DescribeNetworkInsightsAccessScopeAnalysesRequest
- properties:
- NetworkInsightsAccessScopeAnalysisId:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: Filters the results based on the start time. The analysis must have started on or before this time.
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- NetworkInsightsAccessScopeAnalysisList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysis'
- - xml:
- name: item
- NetworkInsightsAccessScopeIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- - xml:
- name: item
- DescribeNetworkInsightsAccessScopesRequest:
- type: object
- title: DescribeNetworkInsightsAccessScopesRequest
- properties:
- NetworkInsightsAccessScopeId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeIdList'
- - description: The IDs of the Network Access Scopes.
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- NetworkInsightsAccessScopeList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScope'
- - xml:
- name: item
- DescribeNetworkInsightsAnalysesRequest:
- type: object
- title: DescribeNetworkInsightsAnalysesRequest
- properties:
- NetworkInsightsAnalysisId:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time when the network insights analyses ended.
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- NetworkInsightsAnalysisList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAnalysis'
- - xml:
- name: item
- NetworkInsightsPathIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsPathId'
- - xml:
- name: item
- DescribeNetworkInsightsPathsRequest:
- type: object
- title: DescribeNetworkInsightsPathsRequest
- properties:
- NetworkInsightsPathId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsPathIdList'
- - description: The IDs of the paths.
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- NetworkInsightsPathList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsPath'
- - xml:
- name: item
- NetworkInterfaceAttribute:
- type: string
- enum:
- - description
- - groupSet
- - sourceDestCheck
- - attachment
- DescribeNetworkInterfaceAttributeRequest:
- type: object
- required:
- - NetworkInterfaceId
- title: DescribeNetworkInterfaceAttributeRequest
- properties:
- attribute:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceAttribute'
- - description: The attribute of the network interface. This parameter is required.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceId'
- - description: The ID of the network interface.
- description: Contains the parameters for DescribeNetworkInterfaceAttribute.
- NetworkInterfaceAttachment:
- type: object
- properties:
- attachTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The timestamp indicating when the attachment initiated.
- attachmentId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network interface attachment.
- deleteOnTermination:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the network interface is deleted when the instance is terminated.
- deviceIndex:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The device index of the network interface attachment on the instance.
- networkCardIndex:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The index of the network card.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance.
- instanceOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID of the owner of the instance.
- status:
- allOf:
- - $ref: '#/components/schemas/AttachmentStatus'
- - description: The attachment state.
- description: Describes a network interface attachment.
- DescribeNetworkInterfacePermissionsMaxResults:
- type: integer
- minimum: 5
- maximum: 255
- NetworkInterfacePermissionIdList:
- type: array
- items:
- $ref: '#/components/schemas/NetworkInterfacePermissionId'
- DescribeNetworkInterfacePermissionsRequest:
- type: object
- title: DescribeNetworkInterfacePermissionsRequest
- properties:
- NetworkInterfacePermissionId:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfacePermissionIdList'
- - description: One or more network interface permission IDs.
- Filter:
- allOf:
- - $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsMaxResults'
- - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.'
- description: Contains the parameters for DescribeNetworkInterfacePermissions.
- NetworkInterfacePermissionList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfacePermission'
- - xml:
- name: item
- DescribeNetworkInterfacesMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- DescribeNetworkInterfacesRequest:
- type: object
- title: DescribeNetworkInterfacesRequest
- properties:
- filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attachment-id - The ID of the interface attachment.
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | efa | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- NetworkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/DescribeNetworkInterfacesMaxResults'
- - description: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request.
- description: Contains the parameters for DescribeNetworkInterfaces.
- NetworkInterfaceList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInterface'
- - xml:
- name: item
- PlacementGroupStringList:
- type: array
- items:
- $ref: '#/components/schemas/PlacementGroupName'
- PlacementGroupIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PlacementGroupId'
- - xml:
- name: GroupId
- DescribePlacementGroupsRequest:
- type: object
- title: DescribePlacementGroupsRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'The filters.
group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- groupName:
- allOf:
- - $ref: '#/components/schemas/PlacementGroupStringList'
- - description: 'The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
' - GroupId: - allOf: - - $ref: '#/components/schemas/PlacementGroupIdStringList' - - description: The IDs of the placement groups. - PlacementGroupList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PlacementGroup' - - xml: - name: item - PrefixListResourceIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PrefixListResourceId' - - xml: - name: item - DescribePrefixListsRequest: - type: object - title: DescribePrefixListsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next page of results.
- PrefixListId:
- allOf:
- - $ref: '#/components/schemas/PrefixListResourceIdStringList'
- - description: One or more prefix list IDs.
- PrefixListSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PrefixList'
- - xml:
- name: item
- DescribePrincipalIdFormatMaxResults:
- type: integer
- minimum: 1
- maximum: 1000
- DescribePrincipalIdFormatRequest:
- type: object
- title: DescribePrincipalIdFormatRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Resource:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to request the next page of results.
- PrincipalIdFormatList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PrincipalIdFormat'
- - xml:
- name: item
- PoolMaxResults:
- type: integer
- minimum: 1
- maximum: 10
- DescribePublicIpv4PoolsRequest:
- type: object
- title: DescribePublicIpv4PoolsRequest
- properties:
- PoolId:
- allOf:
- - $ref: '#/components/schemas/PoolMaxResults'
- - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).
region-name - The name of the Region (for example, us-east-1).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ReplaceRootVolumeTasks:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReplaceRootVolumeTask'
- - xml:
- name: item
- DescribeReservedInstancesListingsRequest:
- type: object
- title: DescribeReservedInstancesListingsRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: One or more filters.
reserved-instances-id - The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active | cancelled | closed).
status-message - The reason for the status.
One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
(Amazon VPC) in the description are for use with Amazon VPC.
- ReservedInstancesOfferingId:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesOfferingIdStringList'
- - description: One or more Reserved Instances offering IDs.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- instanceTenancy:
- allOf:
- - $ref: '#/components/schemas/Tenancy'
- - description: 'The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.
Default: 100
' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to retrieve the next page of results. - offeringType: - allOf: - - $ref: '#/components/schemas/OfferingTypeValues' - - description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to theMedium Utilization Reserved Instance offering type. '
- description: Contains the parameters for DescribeReservedInstancesOfferings.
- ReservedInstancesOfferingList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesOffering'
- - xml:
- name: item
- OfferingClassType:
- type: string
- enum:
- - standard
- - convertible
- ReservedInstancesIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservationId'
- - xml:
- name: ReservedInstancesId
- DescribeReservedInstancesRequest:
- type: object
- title: DescribeReservedInstancesRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/OfferingClassType'
- - description: Describes whether the Reserved Instance is Standard or Convertible.
- ReservedInstancesId:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesIdStringList'
- - description: 'One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- offeringType:
- allOf:
- - $ref: '#/components/schemas/OfferingTypeValues'
- - description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.'
- description: Contains the parameters for DescribeReservedInstances.
- ReservedInstancesList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservedInstances'
- - xml:
- name: item
- DescribeRouteTablesMaxResults:
- type: integer
- minimum: 5
- maximum: 100
- DescribeRouteTablesRequest:
- type: object
- title: DescribeRouteTablesRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.
owner-id - The ID of the Amazon Web Services account that owns the route table.
route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service specified in a route in the table.
route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.transit-gateway-id - The ID of a transit gateway.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route''s target isn''t available (for example, the specified gateway isn''t attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the route table.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- RouteTableId:
- allOf:
- - $ref: '#/components/schemas/DescribeRouteTablesMaxResults'
- - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- RouteTableList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/RouteTable'
- - xml:
- name: item
- DescribeScheduledInstanceAvailabilityMaxResults:
- type: integer
- minimum: 5
- maximum: 300
- ScheduledInstanceRecurrenceRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.'
- OccurrenceDay:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
- description: Describes the recurring schedule for a Scheduled Instance.
- DescribeScheduledInstanceAvailabilityRequest:
- type: object
- required:
- - FirstSlotStartTimeRange
- - Recurrence
- title: DescribeScheduledInstanceAvailabilityRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/ScheduledInstanceRecurrenceRequest'
- - description: The schedule recurrence.
- description: Contains the parameters for DescribeScheduledInstanceAvailability.
- ScheduledInstanceAvailabilitySet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ScheduledInstanceAvailability'
- - xml:
- name: item
- SlotStartTimeRangeRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The latest date and time, in UTC, for the Scheduled Instance to start.'
- description: Describes the time period for a Scheduled Instance to start its first schedule.
- DescribeScheduledInstancesRequest:
- type: object
- title: DescribeScheduledInstancesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next set of results.
- ScheduledInstanceId:
- allOf:
- - $ref: '#/components/schemas/SlotStartTimeRangeRequest'
- - description: The time period for the first schedule to start.
- description: Contains the parameters for DescribeScheduledInstances.
- ScheduledInstanceSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ScheduledInstance'
- - xml:
- name: item
- GroupIds:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: item
- DescribeSecurityGroupReferencesRequest:
- type: object
- required:
- - GroupId
- title: DescribeSecurityGroupReferencesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/GroupIds'
- - description: The IDs of the security groups in your account.
- SecurityGroupReferences:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupReference'
- - xml:
- name: item
- DescribeSecurityGroupRulesMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- DescribeSecurityGroupRulesRequest:
- type: object
- title: DescribeSecurityGroupRulesRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
group-id - The ID of the security group.
security-group-rule-id - The ID of the security group rule.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.'
- DescribeSecurityGroupsMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- GroupNameStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupName'
- - xml:
- name: GroupName
- DescribeSecurityGroupsRequest:
- type: object
- title: DescribeSecurityGroupsRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
description - The description of the security group.
egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.
egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.
egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule.
egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an outbound security group rule.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.
ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule.
ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an inbound security group rule.
owner-id - The Amazon Web Services account ID of the owner of the security group.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC specified when the security group was created.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
' - GroupName: - allOf: - - $ref: '#/components/schemas/GroupNameStringList' - - description: '[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
' - dryRun: - allOf: - - $ref: '#/components/schemas/DescribeSecurityGroupsMaxResults' - - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returnedNextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.'
- SecurityGroupList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroup'
- - xml:
- name: item
- DescribeSnapshotAttributeRequest:
- type: object
- required:
- - Attribute
- - SnapshotId
- title: DescribeSnapshotAttributeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/SnapshotId'
- - description: The ID of the EBS snapshot.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ProductCodeList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ProductCode'
- - xml:
- name: item
- DescribeSnapshotTierStatusMaxResults:
- type: integer
- DescribeSnapshotTierStatusRequest:
- type: object
- title: DescribeSnapshotTierStatusRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/DescribeSnapshotTierStatusMaxResults'
- - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- snapshotTierStatusSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SnapshotTierStatus'
- - xml:
- name: item
- RestorableByStringList:
- type: array
- items:
- $ref: '#/components/schemas/String'
- SnapshotIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SnapshotId'
- - xml:
- name: SnapshotId
- DescribeSnapshotsRequest:
- type: object
- title: DescribeSnapshotsRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
- Owner:
- allOf:
- - $ref: '#/components/schemas/OwnerStringList'
- - description: 'Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.'
- RestorableBy:
- allOf:
- - $ref: '#/components/schemas/RestorableByStringList'
- - description: The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
- SnapshotId:
- allOf:
- - $ref: '#/components/schemas/SnapshotIdStringList'
- - description: 'The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SnapshotList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Snapshot'
- - xml:
- name: item
- DescribeSpotDatafeedSubscriptionRequest:
- type: object
- title: DescribeSpotDatafeedSubscriptionRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DescribeSpotDatafeedSubscription.
- DescribeSpotFleetInstancesMaxResults:
- type: integer
- minimum: 1
- maximum: 1000
- DescribeSpotFleetInstancesRequest:
- type: object
- required:
- - SpotFleetRequestId
- title: DescribeSpotFleetInstancesRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- maxResults:
- allOf:
- - $ref: '#/components/schemas/DescribeSpotFleetInstancesMaxResults'
- - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next set of results.
- spotFleetRequestId:
- allOf:
- - $ref: '#/components/schemas/SpotFleetRequestId'
- - description: The ID of the Spot Fleet request.
- description: Contains the parameters for DescribeSpotFleetInstances.
- DescribeSpotFleetRequestHistoryMaxResults:
- type: integer
- minimum: 1
- maximum: 1000
- EventType:
- type: string
- enum:
- - instanceChange
- - fleetRequestChange
- - error
- - information
- DescribeSpotFleetRequestHistoryRequest:
- type: object
- required:
- - SpotFleetRequestId
- - StartTime
- title: DescribeSpotFleetRequestHistoryRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- eventType:
- allOf:
- - $ref: '#/components/schemas/EventType'
- - description: 'The type of events to describe. By default, all events are described.'
- maxResults:
- allOf:
- - $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryMaxResults'
- - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next set of results.
- spotFleetRequestId:
- allOf:
- - $ref: '#/components/schemas/SpotFleetRequestId'
- - description: The ID of the Spot Fleet request.
- startTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- description: Contains the parameters for DescribeSpotFleetRequestHistory.
- HistoryRecords:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/HistoryRecord'
- - xml:
- name: item
- DescribeSpotFleetRequestsRequest:
- type: object
- title: DescribeSpotFleetRequestsRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- maxResults:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next set of results.
- spotFleetRequestId:
- allOf:
- - $ref: '#/components/schemas/SpotFleetRequestIdList'
- - description: The IDs of the Spot Fleet requests.
- description: Contains the parameters for DescribeSpotFleetRequests.
- SpotFleetRequestConfigSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SpotFleetRequestConfig'
- - xml:
- name: item
- DescribeSpotInstanceRequestsRequest:
- type: object
- title: DescribeSpotInstanceRequestsRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.
launch.group-id - The ID of the security group for the instance.
launch.group-name - The name of the security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m3.medium).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
launched-availability-zone - The Availability Zone in which the request is launched.
network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
network-interface.description - A description of the network interface.
network-interface.device-index - The index of the device for the network interface attachment on the instance.
network-interface.group-id - The ID of the security group associated with the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.private-ip-address - The primary private IP address of the network interface.
network-interface.subnet-id - The ID of the subnet for the instance.
product-description - The product description associated with the instance (Linux/UNIX | Windows).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of Spot Instance request (one-time | persistent).
valid-from - The start date of the request.
valid-until - The end date of the request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SpotInstanceRequestId:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- description: Contains the parameters for DescribeSpotInstanceRequests.
- SpotInstanceRequestList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SpotInstanceRequest'
- - xml:
- name: item
- InstanceTypeList:
- type: array
- items:
- $ref: '#/components/schemas/InstanceType'
- ProductDescriptionList:
- type: array
- items:
- $ref: '#/components/schemas/String'
- DescribeSpotPriceHistoryRequest:
- type: object
- title: DescribeSpotPriceHistoryRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m3.medium).
product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- endTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- InstanceType:
- allOf:
- - $ref: '#/components/schemas/InstanceTypeList'
- - description: Filters the results by the specified instance types.
- maxResults:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next set of results.
- ProductDescription:
- allOf:
- - $ref: '#/components/schemas/ProductDescriptionList'
- - description: Filters the results by the specified basic product descriptions.
- startTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- description: Contains the parameters for DescribeSpotPriceHistory.
- SpotPriceHistoryList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SpotPrice'
- - xml:
- name: item
- DescribeStaleSecurityGroupsMaxResults:
- type: integer
- minimum: 5
- maximum: 255
- DescribeStaleSecurityGroupsNextToken:
- type: string
- minLength: 1
- maxLength: 1024
- DescribeStaleSecurityGroupsRequest:
- type: object
- required:
- - VpcId
- title: DescribeStaleSecurityGroupsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- StaleSecurityGroupSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/StaleSecurityGroup'
- - xml:
- name: item
- DescribeStoreImageTasksRequestMaxResults:
- type: integer
- minimum: 1
- maximum: 200
- DescribeStoreImageTasksRequest:
- type: object
- title: DescribeStoreImageTasksRequest
- properties:
- ImageId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/DescribeStoreImageTasksRequestMaxResults'
- - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200. You cannot specify this parameter and the ImageIDs parameter in the same call.'
- StoreImageTaskResultSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/StoreImageTaskResult'
- - xml:
- name: item
- DescribeSubnetsMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- SubnetIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - xml:
- name: SubnetId
- DescribeSubnetsRequest:
- type: object
- title: DescribeSubnetsRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.
availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.
available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet''s CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.
default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the subnet.
state - The state of the subnet (pending | available).
subnet-arn - The Amazon Resource Name (ARN) of the subnet.
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the subnet.
One or more subnet IDs.
Default: Describes all your subnets.
' - dryRun: - allOf: - - $ref: '#/components/schemas/DescribeSubnetsMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
- SubnetList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Subnet'
- - xml:
- name: item
- DescribeTagsRequest:
- type: object
- title: DescribeTagsRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.
NextToken value.'
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to retrieve the next page of results.
- TagDescriptionList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TagDescription'
- - xml:
- name: item
- DescribeTrafficMirrorFiltersRequest:
- type: object
- title: DescribeTrafficMirrorFiltersRequest
- properties:
- TrafficMirrorFilterId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- TrafficMirrorFilterSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorFilter'
- - xml:
- name: item
- DescribeTrafficMirrorSessionsRequest:
- type: object
- title: DescribeTrafficMirrorSessionsRequest
- properties:
- TrafficMirrorSessionId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- TrafficMirrorSessionSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorSession'
- - xml:
- name: item
- DescribeTrafficMirrorTargetsRequest:
- type: object
- title: DescribeTrafficMirrorTargetsRequest
- properties:
- TrafficMirrorTargetId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- TrafficMirrorTargetSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorTarget'
- - xml:
- name: item
- TransitGatewayAttachmentIdStringList:
- type: array
- items:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- DescribeTransitGatewayAttachmentsRequest:
- type: object
- title: DescribeTransitGatewayAttachmentsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList'
- - description: The IDs of the attachments.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayAttachmentList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachment'
- - xml:
- name: item
- TransitGatewayConnectPeerIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnectPeerId'
- - xml:
- name: item
- DescribeTransitGatewayConnectPeersRequest:
- type: object
- title: DescribeTransitGatewayConnectPeersRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnectPeerIdStringList'
- - description: The IDs of the Connect peers.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayConnectPeerList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnectPeer'
- - xml:
- name: item
- DescribeTransitGatewayConnectsRequest:
- type: object
- title: DescribeTransitGatewayConnectsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList'
- - description: The IDs of the attachments.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayConnectList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayConnect'
- - xml:
- name: item
- TransitGatewayMulticastDomainIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- - xml:
- name: item
- DescribeTransitGatewayMulticastDomainsRequest:
- type: object
- title: DescribeTransitGatewayMulticastDomainsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomainIdStringList'
- - description: The ID of the transit gateway multicast domain.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayMulticastDomainList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomain'
- - xml:
- name: item
- DescribeTransitGatewayPeeringAttachmentsRequest:
- type: object
- title: DescribeTransitGatewayPeeringAttachmentsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList'
- - description: One or more IDs of the transit gateway peering attachments.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayPeeringAttachmentList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
- - xml:
- name: item
- TransitGatewayRouteTableIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableId'
- - xml:
- name: item
- DescribeTransitGatewayRouteTablesRequest:
- type: object
- title: DescribeTransitGatewayRouteTablesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableIdStringList'
- - description: The IDs of the transit gateway route tables.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayRouteTableList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTable'
- - xml:
- name: item
- DescribeTransitGatewayVpcAttachmentsRequest:
- type: object
- title: DescribeTransitGatewayVpcAttachmentsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList'
- - description: The IDs of the attachments.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayVpcAttachmentList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- - xml:
- name: item
- TransitGatewayIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayId'
- - xml:
- name: item
- DescribeTransitGatewaysRequest:
- type: object
- title: DescribeTransitGatewaysRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayIdStringList'
- - description: The IDs of the transit gateways.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGateway'
- - xml:
- name: item
- DescribeTrunkInterfaceAssociationsMaxResults:
- type: integer
- minimum: 5
- maximum: 255
- DescribeTrunkInterfaceAssociationsRequest:
- type: object
- title: DescribeTrunkInterfaceAssociationsRequest
- properties:
- AssociationId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsMaxResults'
- - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- TrunkInterfaceAssociationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TrunkInterfaceAssociation'
- - xml:
- name: item
- DescribeVolumeAttributeRequest:
- type: object
- required:
- - Attribute
- - VolumeId
- title: DescribeVolumeAttributeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VolumeId'
- - description: The ID of the volume.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- VolumeIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VolumeId'
- - xml:
- name: VolumeId
- DescribeVolumeStatusRequest:
- type: object
- title: DescribeVolumeStatusRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.'
- VolumeId:
- allOf:
- - $ref: '#/components/schemas/VolumeIdStringList'
- - description: 'The IDs of the volumes.
Default: Describes all your volumes.
' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- VolumeStatusList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusItem'
- - xml:
- name: item
- DescribeVolumesModificationsRequest:
- type: object
- title: DescribeVolumesModificationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- VolumeId:
- allOf:
- - $ref: '#/components/schemas/VolumeIdStringList'
- - description: The IDs of the volumes.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The maximum number of results (up to a limit of 500) to be returned in a paginated request.
- VolumeModificationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VolumeModification'
- - xml:
- name: item
- DescribeVolumesRequest:
- type: object
- title: DescribeVolumesRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true | false)
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available | in-use | deleting | deleted | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- maxResults:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.'
- nextToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
- VolumeList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Volume'
- - xml:
- name: item
- DescribeVpcAttributeRequest:
- type: object
- required:
- - Attribute
- - VpcId
- title: DescribeVpcAttributeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DescribeVpcClassicLinkDnsSupportMaxResults:
- type: integer
- minimum: 5
- maximum: 255
- DescribeVpcClassicLinkDnsSupportNextToken:
- type: string
- minLength: 1
- maxLength: 1024
- VpcClassicLinkIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - xml:
- name: VpcId
- DescribeVpcClassicLinkDnsSupportRequest:
- type: object
- title: DescribeVpcClassicLinkDnsSupportRequest
- properties:
- maxResults:
- allOf:
- - $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportMaxResults'
- - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- nextToken:
- allOf:
- - $ref: '#/components/schemas/VpcClassicLinkIdList'
- - description: One or more VPC IDs.
- DescribeVpcClassicLinkRequest:
- type: object
- title: DescribeVpcClassicLinkRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- VpcId:
- allOf:
- - $ref: '#/components/schemas/VpcClassicLinkIdList'
- - description: One or more VPCs for which you want to describe the ClassicLink status.
- VpcClassicLinkList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcClassicLink'
- - xml:
- name: item
- DescribeVpcEndpointConnectionNotificationsRequest:
- type: object
- title: DescribeVpcEndpointConnectionNotificationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ConnectionNotificationId'
- - description: The ID of the notification.
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to request the next page of results.
- DescribeVpcEndpointConnectionsRequest:
- type: object
- title: DescribeVpcEndpointConnectionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to retrieve the next page of results.
- VpcEndpointConnectionSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointConnection'
- - xml:
- name: item
- DescribeVpcEndpointServiceConfigurationsRequest:
- type: object
- title: DescribeVpcEndpointServiceConfigurationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ServiceId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointServiceIdList'
- - description: The IDs of one or more services.
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to retrieve the next page of results.
- ServiceConfigurationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ServiceConfiguration'
- - xml:
- name: item
- DescribeVpcEndpointServicePermissionsRequest:
- type: object
- required:
- - ServiceId
- title: DescribeVpcEndpointServicePermissionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointServiceId'
- - description: The ID of the service.
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token to retrieve the next page of results.
- DescribeVpcEndpointServicesRequest:
- type: object
- title: DescribeVpcEndpointServicesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ServiceName:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: One or more service names.
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next set of items to return. (You received this token from a prior call.)
- description: Contains the parameters for DescribeVpcEndpointServices.
- ServiceDetailSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ServiceDetail'
- - xml:
- name: item
- DescribeVpcEndpointsRequest:
- type: object
- title: DescribeVpcEndpointsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- VpcEndpointId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointIdList'
- - description: One or more endpoint IDs.
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next set of items to return. (You received this token from a prior call.)
- description: Contains the parameters for DescribeVpcEndpoints.
- VpcEndpointSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcEndpoint'
- - xml:
- name: item
- DescribeVpcPeeringConnectionsMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- DescribeVpcPeeringConnectionsRequest:
- type: object
- title: DescribeVpcPeeringConnectionsRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester''s VPC.
requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-peering-connection-id - The ID of the VPC peering connection.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- VpcPeeringConnectionId:
- allOf:
- - $ref: '#/components/schemas/DescribeVpcPeeringConnectionsMaxResults'
- - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
- VpcPeeringConnectionList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnection'
- - xml:
- name: item
- DescribeVpcsMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- VpcIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - xml:
- name: VpcId
- DescribeVpcsRequest:
- type: object
- title: DescribeVpcsRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC''s CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
is-default - Indicates whether the VPC is the default VPC.
owner-id - The ID of the Amazon Web Services account that owns the VPC.
state - The state of the VPC (pending | available).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC.
One or more VPC IDs.
Default: Describes all your VPCs.
' - dryRun: - allOf: - - $ref: '#/components/schemas/DescribeVpcsMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
- VpcList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Vpc'
- - xml:
- name: item
- VpnConnectionIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpnConnectionId'
- - xml:
- name: VpnConnectionId
- DescribeVpnConnectionsRequest:
- type: object
- title: DescribeVpnConnectionsRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
One or more VPN connection IDs.
Default: Describes your VPN connections.
' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DescribeVpnConnections.
- VpnConnectionList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpnConnection'
- - xml:
- name: item
- VpnGatewayIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpnGatewayId'
- - xml:
- name: VpnGatewayId
- DescribeVpnGatewaysRequest:
- type: object
- title: DescribeVpnGatewaysRequest
- properties:
- Filter:
- allOf:
- - $ref: '#/components/schemas/FilterList'
- - description: 'One or more filters.
amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway (if applicable).
state - The state of the virtual private gateway (pending | available | deleting | deleted).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DescribeVpnGateways.
- VpnGatewayList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpnGateway'
- - xml:
- name: item
- DestinationFileFormat:
- type: string
- enum:
- - plain-text
- - parquet
- DestinationOptionsResponse:
- type: object
- properties:
- fileFormat:
- allOf:
- - $ref: '#/components/schemas/DestinationFileFormat'
- - description: The format for the flow log.
- hiveCompatiblePartitions:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.
- perHourPartition:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to partition the flow log per hour.
- description: Describes the destination options for a flow log.
- DetachClassicLinkVpcRequest:
- type: object
- required:
- - InstanceId
- - VpcId
- title: DetachClassicLinkVpcRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- instanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of the instance to unlink from the VPC.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC to which the instance is linked.
- DetachInternetGatewayRequest:
- type: object
- required:
- - InternetGatewayId
- - VpcId
- title: DetachInternetGatewayRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- internetGatewayId:
- allOf:
- - $ref: '#/components/schemas/InternetGatewayId'
- - description: The ID of the internet gateway.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- DetachNetworkInterfaceRequest:
- type: object
- required:
- - AttachmentId
- title: DetachNetworkInterfaceRequest
- properties:
- attachmentId:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceAttachmentId'
- - description: The ID of the attachment.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- force:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Specifies whether to force a detachment.
Use the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DetachVpnGatewayRequest:
- type: object
- required:
- - VpcId
- - VpnGatewayId
- title: DetachVpnGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpnGatewayId'
- - description: The ID of the virtual private gateway.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DetachVpnGateway.
- DeviceType:
- type: string
- enum:
- - ebs
- - instance-store
- DhcpConfigurationValueList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - xml:
- name: item
- DhcpConfiguration:
- type: object
- properties:
- key:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of a DHCP option.
- valueSet:
- allOf:
- - $ref: '#/components/schemas/DhcpConfigurationValueList'
- - description: One or more values for the DHCP option.
- description: Describes a DHCP configuration option.
- DhcpConfigurationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DhcpConfiguration'
- - xml:
- name: item
- DirectoryServiceAuthenticationRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Active Directory to be used for authentication.
- description: Describes the Active Directory to be used for client authentication.
- DisableEbsEncryptionByDefaultRequest:
- type: object
- title: DisableEbsEncryptionByDefaultRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DisableFastLaunchRequest:
- type: object
- required:
- - ImageId
- title: DisableFastLaunchRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DisableFastSnapshotRestoreStateErrorSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DisableFastSnapshotRestoreStateErrorItem'
- - xml:
- name: item
- DisableFastSnapshotRestoreErrorItem:
- type: object
- properties:
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the snapshot.
- fastSnapshotRestoreStateErrorSet:
- allOf:
- - $ref: '#/components/schemas/DisableFastSnapshotRestoreStateErrorSet'
- - description: The errors.
- description: Contains information about the errors that occurred when disabling fast snapshot restores.
- DisableFastSnapshotRestoreErrorSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DisableFastSnapshotRestoreErrorItem'
- - xml:
- name: item
- DisableFastSnapshotRestoreStateError:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The error code.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The error message.
- description: Describes an error that occurred when disabling fast snapshot restores.
- DisableFastSnapshotRestoreStateErrorItem:
- type: object
- properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone.
- error:
- allOf:
- - $ref: '#/components/schemas/DisableFastSnapshotRestoreStateError'
- - description: The error.
- description: Contains information about an error that occurred when disabling fast snapshot restores.
- DisableFastSnapshotRestoreSuccessItem:
- type: object
- properties:
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the snapshot.
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone.
- state:
- allOf:
- - $ref: '#/components/schemas/FastSnapshotRestoreStateCode'
- - description: The state of fast snapshot restores for the snapshot.
- stateTransitionReason:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
enabling state.
- optimizingTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time at which fast snapshot restores entered the optimizing state.
- enabledTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time at which fast snapshot restores entered the enabled state.
- disablingTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time at which fast snapshot restores entered the disabling state.
- disabledTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time at which fast snapshot restores entered the disabled state.
- description: Describes fast snapshot restores that were successfully disabled.
- DisableFastSnapshotRestoreSuccessSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/DisableFastSnapshotRestoreSuccessItem'
- - xml:
- name: item
- DisableFastSnapshotRestoresRequest:
- type: object
- required:
- - AvailabilityZones
- - SourceSnapshotIds
- title: DisableFastSnapshotRestoresRequest
- properties:
- AvailabilityZone:
- allOf:
- - $ref: '#/components/schemas/AvailabilityZoneStringList'
- - description: 'One or more Availability Zones. For example, us-east-2a.'
- SourceSnapshotId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DisableImageDeprecationRequest:
- type: object
- required:
- - ImageId
- title: DisableImageDeprecationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DisableIpamOrganizationAdminAccountRequest:
- type: object
- required:
- - DelegatedAdminAccountId
- title: DisableIpamOrganizationAdminAccountRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Organizations member account ID that you want to disable as IPAM account.
- DisableSerialConsoleAccessRequest:
- type: object
- title: DisableSerialConsoleAccessRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DisableTransitGatewayRouteTablePropagationRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- - TransitGatewayAttachmentId
- title: DisableTransitGatewayRouteTablePropagationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayPropagation:
- type: object
- properties:
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentId'
- - description: The ID of the attachment.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- - description: The resource type. Note that the tgw-peering resource type has been deprecated.
- transitGatewayRouteTableId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway route table.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPropagationState'
- - description: The state.
- description: Describes route propagation.
- DisableVgwRoutePropagationRequest:
- type: object
- required:
- - GatewayId
- - RouteTableId
- title: DisableVgwRoutePropagationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for DisableVgwRoutePropagation.
- DisableVpcClassicLinkDnsSupportRequest:
- type: object
- title: DisableVpcClassicLinkDnsSupportRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- DisableVpcClassicLinkRequest:
- type: object
- required:
- - VpcId
- title: DisableVpcClassicLinkRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- vpcId:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- DisassociateAddressRequest:
- type: object
- title: DisassociateAddressRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.'
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DisassociateClientVpnTargetNetworkRequest:
- type: object
- required:
- - ClientVpnEndpointId
- - AssociationId
- title: DisassociateClientVpnTargetNetworkRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DisassociateEnclaveCertificateIamRoleRequest:
- type: object
- title: DisassociateEnclaveCertificateIamRoleRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DisassociateIamInstanceProfileRequest:
- type: object
- required:
- - AssociationId
- title: DisassociateIamInstanceProfileRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/IamInstanceProfileAssociationId'
- - description: The ID of the IAM instance profile association.
- InstanceEventWindowDisassociationRequest:
- type: object
- properties:
- InstanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceIdList'
- - description: The IDs of the instances to disassociate from the event window.
- InstanceTag:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window.
- DedicatedHostId:
- allOf:
- - $ref: '#/components/schemas/DedicatedHostIdList'
- - description: The IDs of the Dedicated Hosts to disassociate from the event window.
- description: The targets to disassociate from the specified event window.
- DisassociateInstanceEventWindowRequest:
- type: object
- required:
- - InstanceEventWindowId
- - AssociationTarget
- title: DisassociateInstanceEventWindowRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowDisassociationRequest'
- - description: One or more targets to disassociate from the specified event window.
- RouteTableAssociationId:
- type: string
- DisassociateRouteTableRequest:
- type: object
- required:
- - AssociationId
- title: DisassociateRouteTableRequest
- properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/RouteTableAssociationId'
- - description: The association ID representing the current association between the route table and subnet or gateway.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SubnetCidrAssociationId:
- type: string
- DisassociateSubnetCidrBlockRequest:
- type: object
- required:
- - AssociationId
- title: DisassociateSubnetCidrBlockRequest
- properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/SubnetCidrAssociationId'
- - description: The association ID for the CIDR block.
- DisassociateTransitGatewayMulticastDomainRequest:
- type: object
- title: DisassociateTransitGatewayMulticastDomainRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DisassociateTransitGatewayRouteTableRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- - TransitGatewayAttachmentId
- title: DisassociateTransitGatewayRouteTableRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- DisassociateTrunkInterfaceRequest:
- type: object
- required:
- - AssociationId
- title: DisassociateTrunkInterfaceRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- VpcCidrAssociationId:
- type: string
- DisassociateVpcCidrBlockRequest:
- type: object
- required:
- - AssociationId
- title: DisassociateVpcCidrBlockRequest
- properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/VpcCidrAssociationId'
- - description: The association ID for the CIDR block.
- DiskCount:
- type: integer
- VolumeDetail:
- type: object
- required:
- - Size
- properties:
- size:
- # allOf:
- # - $ref: '#/components/schemas/Long'
- # - description: 'The size of the volume, in GiB.'
- type: integer
- description: 'The size of the volume, in GiB.'
- description: Describes an EBS volume.
- DiskImageDescription:
- type: object
- properties:
- checksum:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The checksum computed for the disk image.
- format:
- allOf:
- - $ref: '#/components/schemas/DiskImageFormat'
- - description: The disk image format.
- importManifestUrl:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' - size: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The size of the disk image, in GiB.' - description: Describes a disk image. - DiskImageDetail: - type: object - required: - - Bytes - - Format - - ImportManifestUrl - properties: - bytes: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The size of the disk image, in GiB.' - format: - allOf: - - $ref: '#/components/schemas/DiskImageFormat' - - description: The disk image format. - importManifestUrl: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' - description: Describes a disk image. - DiskImageList: - type: array - items: - $ref: '#/components/schemas/DiskImage' - DiskImageVolumeDescription: - type: object - properties: - id: - allOf: - - $ref: '#/components/schemas/String' - - description: The volume identifier. - size: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The size of the volume, in GiB.' - description: Describes a disk image volume. - DiskSize: - type: integer - DiskType: - type: string - enum: - - hdd - - ssd - DiskInfo: - type: object - properties: - sizeInGB: - allOf: - - $ref: '#/components/schemas/DiskSize' - - description: The size of the disk in GB. - count: - allOf: - - $ref: '#/components/schemas/DiskCount' - - description: The number of disks with this configuration. - type: - allOf: - - $ref: '#/components/schemas/DiskType' - - description: The type of disk. - description: Describes a disk. - DiskInfoList: - type: array - items: - allOf: - - $ref: '#/components/schemas/DiskInfo' - - xml: - name: item - DnsEntry: - type: object - properties: - dnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The DNS name. - hostedZoneId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the private hosted zone. - description: Describes a DNS entry. - DnsEntrySet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DnsEntry' - - xml: - name: item - DnsNameState: - type: string - enum: - - pendingVerification - - verified - - failed - DnsOptions: - type: object - properties: - dnsRecordIpType: - allOf: - - $ref: '#/components/schemas/DnsRecordIpType' - - description: The DNS records created for the endpoint. - description: Describes the DNS options for an endpoint. - DnsOptionsSpecification: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DnsRecordIpType' - - description: The DNS records created for the endpoint. - description: Describes the DNS options for an endpoint. - DnsServersOptionsModifyStructure: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether DNS servers should be used. SpecifyFalse to delete the existing DNS servers.
- description: Information about the DNS server to be used.
- DnsSupportValue:
- type: string
- enum:
- - enable
- - disable
- DoubleWithConstraints:
- type: number
- format: double
- minimum: 0.001
- maximum: 99.999
- EbsEncryptionSupport:
- type: string
- enum:
- - unsupported
- - supported
- EbsOptimizedSupport:
- type: string
- enum:
- - unsupported
- - supported
- - default
- EbsOptimizedInfo:
- type: object
- properties:
- baselineBandwidthInMbps:
- allOf:
- - $ref: '#/components/schemas/BaselineBandwidthInMbps'
- - description: 'The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.'
- baselineThroughputInMBps:
- allOf:
- - $ref: '#/components/schemas/BaselineThroughputInMBps'
- - description: 'The baseline throughput performance for an EBS-optimized instance type, in MB/s.'
- baselineIops:
- allOf:
- - $ref: '#/components/schemas/BaselineIops'
- - description: The baseline input/output storage operations per seconds for an EBS-optimized instance type.
- maximumBandwidthInMbps:
- allOf:
- - $ref: '#/components/schemas/MaximumBandwidthInMbps'
- - description: 'The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.'
- maximumThroughputInMBps:
- allOf:
- - $ref: '#/components/schemas/MaximumThroughputInMBps'
- - description: 'The maximum throughput performance for an EBS-optimized instance type, in MB/s.'
- maximumIops:
- allOf:
- - $ref: '#/components/schemas/MaximumIops'
- - description: The maximum input/output storage operations per second for an EBS-optimized instance type.
- description: Describes the optimized EBS performance for supported instance types.
- EbsNvmeSupport:
- type: string
- enum:
- - unsupported
- - supported
- - required
- EbsInfo:
- type: object
- properties:
- ebsOptimizedSupport:
- allOf:
- - $ref: '#/components/schemas/EbsOptimizedSupport'
- - description: 'Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized instances in Amazon EC2 User Guide.'
- encryptionSupport:
- allOf:
- - $ref: '#/components/schemas/EbsEncryptionSupport'
- - description: Indicates whether Amazon EBS encryption is supported.
- ebsOptimizedInfo:
- allOf:
- - $ref: '#/components/schemas/EbsOptimizedInfo'
- - description: Describes the optimized EBS performance for the instance type.
- nvmeSupport:
- allOf:
- - $ref: '#/components/schemas/EbsNvmeSupport'
- - description: Indicates whether non-volatile memory express (NVMe) is supported.
- description: Describes the Amazon EBS features supported by the instance type.
- EbsInstanceBlockDevice:
- type: object
- properties:
- attachTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time stamp when the attachment initiated.
- deleteOnTermination:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the volume is deleted on instance termination.
- status:
- allOf:
- - $ref: '#/components/schemas/AttachmentStatus'
- - description: The attachment state.
- volumeId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the EBS volume.
- description: Describes a parameter used to set up an EBS volume in a block device mapping.
- EbsInstanceBlockDeviceSpecification:
- type: object
- properties:
- deleteOnTermination:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the volume is deleted on instance termination.
- volumeId:
- allOf:
- - $ref: '#/components/schemas/VolumeId'
- - description: The ID of the EBS volume.
- description: Describes information used to set up an EBS volume specified in a block device mapping.
- MaximumBandwidthInMbps:
- type: integer
- MaximumThroughputInMBps:
- type: number
- format: double
- MaximumIops:
- type: integer
- MaximumEfaInterfaces:
- type: integer
- EfaInfo:
- type: object
- properties:
- maximumEfaInterfaces:
- allOf:
- - $ref: '#/components/schemas/MaximumEfaInterfaces'
- - description: The maximum number of Elastic Fabric Adapters for the instance type.
- description: Describes the Elastic Fabric Adapters for the instance type.
- EfaSupportedFlag:
- type: boolean
- InternetGatewayAttachmentList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InternetGatewayAttachment'
- - xml:
- name: item
- EgressOnlyInternetGatewayIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
- - xml:
- name: item
- ElasticGpuAssociation:
- type: object
- properties:
- elasticGpuId:
- allOf:
- - $ref: '#/components/schemas/ElasticGpuId'
- - description: The ID of the Elastic Graphics accelerator.
- elasticGpuAssociationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the association.
- elasticGpuAssociationState:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The state of the association between the instance and the Elastic Graphics accelerator.
- elasticGpuAssociationTime:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The time the Elastic Graphics accelerator was associated with the instance.
- description: Describes the association between an instance and an Elastic Graphics accelerator.
- ElasticGpuAssociationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ElasticGpuAssociation'
- - xml:
- name: item
- ElasticGpuStatus:
- type: string
- enum:
- - OK
- - IMPAIRED
- ElasticGpuHealth:
- type: object
- properties:
- status:
- allOf:
- - $ref: '#/components/schemas/ElasticGpuStatus'
- - description: The health status.
- description: Describes the status of an Elastic Graphics accelerator.
- ElasticGpuIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ElasticGpuId'
- - xml:
- name: item
- ElasticGpus:
- type: object
- properties:
- elasticGpuId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Elastic Graphics accelerator.
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone in the which the Elastic Graphics accelerator resides.
- elasticGpuType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The type of Elastic Graphics accelerator.
- elasticGpuHealth:
- allOf:
- - $ref: '#/components/schemas/ElasticGpuHealth'
- - description: The status of the Elastic Graphics accelerator.
- elasticGpuState:
- allOf:
- - $ref: '#/components/schemas/ElasticGpuState'
- - description: The state of the Elastic Graphics accelerator.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance to which the Elastic Graphics accelerator is attached.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the Elastic Graphics accelerator.
- description: Describes an Elastic Graphics accelerator.
- ElasticGpuSpecificationResponse:
- type: object
- properties:
- type:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The elastic GPU type.
- description: Describes an elastic GPU.
- ElasticGpuSpecificationResponseList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ElasticGpuSpecificationResponse'
- - xml:
- name: item
- ElasticGpuSpecifications:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ElasticGpuSpecification'
- - xml:
- name: item
- ElasticGpuState:
- type: string
- enum:
- - ATTACHED
- ElasticInferenceAcceleratorCount:
- type: integer
- minimum: 1
- ElasticInferenceAcceleratorAssociation:
- type: object
- properties:
- elasticInferenceAcceleratorArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: ' The Amazon Resource Name (ARN) of the elastic inference accelerator. '
- elasticInferenceAcceleratorAssociationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: ' The ID of the association. '
- elasticInferenceAcceleratorAssociationState:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: ' The state of the elastic inference accelerator. '
- elasticInferenceAcceleratorAssociationTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: ' The time at which the elastic inference accelerator is associated with an instance. '
- description: ' Describes the association between an instance and an elastic inference accelerator. '
- ElasticInferenceAcceleratorAssociationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ElasticInferenceAcceleratorAssociation'
- - xml:
- name: item
- ElasticInferenceAccelerators:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ElasticInferenceAccelerator'
- - xml:
- name: item
- ElasticIpAssociationId:
- type: string
- EnaSupport:
- type: string
- enum:
- - unsupported
- - supported
- - required
- EnableEbsEncryptionByDefaultRequest:
- type: object
- title: EnableEbsEncryptionByDefaultRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- EnableFastLaunchRequest:
- type: object
- required:
- - ImageId
- title: EnableFastLaunchRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- EnableFastSnapshotRestoreStateErrorSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/EnableFastSnapshotRestoreStateErrorItem'
- - xml:
- name: item
- EnableFastSnapshotRestoreErrorItem:
- type: object
- properties:
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the snapshot.
- fastSnapshotRestoreStateErrorSet:
- allOf:
- - $ref: '#/components/schemas/EnableFastSnapshotRestoreStateErrorSet'
- - description: The errors.
- description: Contains information about the errors that occurred when enabling fast snapshot restores.
- EnableFastSnapshotRestoreErrorSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/EnableFastSnapshotRestoreErrorItem'
- - xml:
- name: item
- EnableFastSnapshotRestoreStateError:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The error code.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The error message.
- description: Describes an error that occurred when enabling fast snapshot restores.
- EnableFastSnapshotRestoreStateErrorItem:
- type: object
- properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone.
- error:
- allOf:
- - $ref: '#/components/schemas/EnableFastSnapshotRestoreStateError'
- - description: The error.
- description: Contains information about an error that occurred when enabling fast snapshot restores.
- EnableFastSnapshotRestoreSuccessItem:
- type: object
- properties:
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the snapshot.
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone.
- state:
- allOf:
- - $ref: '#/components/schemas/FastSnapshotRestoreStateCode'
- - description: The state of fast snapshot restores.
- stateTransitionReason:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
enabling state.
- optimizingTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time at which fast snapshot restores entered the optimizing state.
- enabledTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time at which fast snapshot restores entered the enabled state.
- disablingTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time at which fast snapshot restores entered the disabling state.
- disabledTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time at which fast snapshot restores entered the disabled state.
- description: Describes fast snapshot restores that were successfully enabled.
- EnableFastSnapshotRestoreSuccessSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/EnableFastSnapshotRestoreSuccessItem'
- - xml:
- name: item
- EnableFastSnapshotRestoresRequest:
- type: object
- required:
- - AvailabilityZones
- - SourceSnapshotIds
- title: EnableFastSnapshotRestoresRequest
- properties:
- AvailabilityZone:
- allOf:
- - $ref: '#/components/schemas/AvailabilityZoneStringList'
- - description: 'One or more Availability Zones. For example, us-east-2a.'
- SourceSnapshotId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- EnableImageDeprecationRequest:
- type: object
- required:
- - ImageId
- - DeprecateAt
- title: EnableImageDeprecationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- EnableIpamOrganizationAdminAccountRequest:
- type: object
- required:
- - DelegatedAdminAccountId
- title: EnableIpamOrganizationAdminAccountRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Organizations member account ID that you want to enable as the IPAM account.
- EnableSerialConsoleAccessRequest:
- type: object
- title: EnableSerialConsoleAccessRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- EnableTransitGatewayRouteTablePropagationRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- - TransitGatewayAttachmentId
- title: EnableTransitGatewayRouteTablePropagationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- EnableVgwRoutePropagationRequest:
- type: object
- required:
- - GatewayId
- - RouteTableId
- title: EnableVgwRoutePropagationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for EnableVgwRoutePropagation.
- EnableVolumeIORequest:
- type: object
- required:
- - VolumeId
- title: EnableVolumeIORequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- volumeId:
- allOf:
- - $ref: '#/components/schemas/VolumeId'
- - description: The ID of the volume.
- EnableVpcClassicLinkDnsSupportRequest:
- type: object
- title: EnableVpcClassicLinkDnsSupportRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- EnableVpcClassicLinkRequest:
- type: object
- required:
- - VpcId
- title: EnableVpcClassicLinkRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- vpcId:
- allOf:
- - $ref: '#/components/schemas/VpcId'
- - description: The ID of the VPC.
- EnclaveOptions:
- type: object
- properties:
- enabled:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.'
- description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
- EnclaveOptionsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.'
- description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.'
- EncryptionInTransitSupported:
- type: boolean
- EphemeralNvmeSupport:
- type: string
- enum:
- - unsupported
- - supported
- - required
- ValidationError:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes.'
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error Codes.'
- description: The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.
- ErrorSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ValidationError'
- - xml:
- name: item
- EventCode:
- type: string
- enum:
- - instance-reboot
- - system-reboot
- - system-maintenance
- - instance-retirement
- - instance-stop
- EventInformation:
- type: object
- properties:
- eventDescription:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the event.
- eventSubType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The event.
error events:
iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.
allLaunchSpecsTemporarilyBlacklisted - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.
spotInstanceCountLimitExceeded - You''ve reached the limit on the number of Spot Instances that you can launch.
spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.
fleetRequestChange events:
active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.
cancelled - The EC2 Fleet or Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.
cancelled_running - The EC2 Fleet or Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.
cancelled_terminating - The EC2 Fleet or Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.
expired - The EC2 Fleet or Spot Fleet request has expired. If the request was created with TerminateInstancesWithExpiration set, a subsequent terminated event indicates that the instances are terminated.
modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.
modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.
submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.
progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.
instanceChange events:
launched - A new instance was launched.
terminated - An instance was terminated by the user.
termination_notified - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.
Information events:
fleetProgressHalted - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced launchSpecUnusable events). A launch specification might become valid if the Spot price changes.
launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.
launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot price.
registerWithLoadBalancersFailed - An attempt to register instances with load balancers failed. For more information, see the description of the event.
instanceChange events.
- description: Describes an EC2 Fleet or Spot Fleet event.
- ExcludedInstanceType:
- type: string
- pattern: '[a-zA-Z0-9\.\*]+'
- minLength: 1
- maxLength: 30
- StringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- TransitGatewayRouteTableRoute:
- type: object
- properties:
- destinationCidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The CIDR block used for destination matches.
- state:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The state of the route.
- routeOrigin:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The route origin. The following are the possible values:
static
propagated
The direction. The following are the possible values:
egress
ingress
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ExportClientVpnClientConfigurationRequest:
- type: object
- required:
- - ClientVpnEndpointId
- title: ExportClientVpnClientConfigurationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ExportImageRequest:
- type: object
- required:
- - DiskImageFormat
- - ImageId
- - S3ExportLocation
- title: ExportImageRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named ''vmimport''.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to apply to the export image task during creation.
- ExportTaskS3Location:
- type: object
- properties:
- s3Bucket:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The destination Amazon S3 bucket.
- s3Prefix:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The prefix (logical hierarchy) in the bucket.
- description: Describes the destination for an export image task.
- ExportImageTask:
- type: object
- properties:
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the image being exported.
- exportImageTaskId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the export image task.
- imageId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the image.
- progress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The percent complete of the export image task.
- s3ExportLocation:
- allOf:
- - $ref: '#/components/schemas/ExportTaskS3Location'
- - description: Information about the destination Amazon S3 bucket.
- status:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The status of the export image task. The possible values are active, completed, deleting, and deleted.'
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The status message for the export image task.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the export image task.
- description: Describes an export image task.
- ExportImageTaskIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ExportImageTaskId'
- - xml:
- name: ExportImageTaskId
- ExportToS3Task:
- type: object
- properties:
- containerFormat:
- allOf:
- - $ref: '#/components/schemas/ContainerFormat'
- - description: 'The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.'
- diskImageFormat:
- allOf:
- - $ref: '#/components/schemas/DiskImageFormat'
- - description: The format for the exported image.
- s3Bucket:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.
- s3Key:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The encryption key for your S3 bucket.
- description: Describes the format and location for the export task.
- InstanceExportDetails:
- type: object
- properties:
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource being exported.
- targetEnvironment:
- allOf:
- - $ref: '#/components/schemas/ExportEnvironment'
- - description: The target virtualization environment.
- description: Describes an instance to export.
- ExportTaskState:
- type: string
- enum:
- - active
- - cancelling
- - cancelled
- - completed
- ExportTaskS3LocationRequest:
- type: object
- required:
- - S3Bucket
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The prefix (logical hierarchy) in the bucket.
- description: Describes the destination for an export image task.
- ExportTransitGatewayRoutesRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- - S3Bucket
- title: ExportTransitGatewayRoutesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableId'
- - description: The ID of the route table.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- FailedCapacityReservationFleetCancellationResult:
- type: object
- properties:
- capacityReservationFleetId:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationFleetId'
- - description: The ID of the Capacity Reservation Fleet that could not be cancelled.
- cancelCapacityReservationFleetError:
- allOf:
- - $ref: '#/components/schemas/CancelCapacityReservationFleetError'
- - description: Information about the Capacity Reservation Fleet cancellation error.
- description: Describes a Capacity Reservation Fleet that could not be cancelled.
- FailedQueuedPurchaseDeletion:
- type: object
- properties:
- error:
- allOf:
- - $ref: '#/components/schemas/DeleteQueuedReservedInstancesError'
- - description: The error.
- reservedInstancesId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Reserved Instance.
- description: Describes a Reserved Instance whose queued purchase was not deleted.
- FastLaunchLaunchTemplateSpecificationRequest:
- type: object
- required:
- - Version
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The version of the launch template to use for faster launching for a Windows AMI.
- description: 'Request to create a launch template for a fast-launch enabled Windows AMI.
Note - You can specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
DefaultTargetCapacityType.'
- onDemandTargetCapacity:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.'
- spotTargetCapacity:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.'
- defaultTargetCapacityType:
- allOf:
- - $ref: '#/components/schemas/DefaultTargetCapacityType'
- - description: 'The default TotalTargetCapacity, which is either Spot or On-Demand.'
- targetCapacityUnitType:
- allOf:
- - $ref: '#/components/schemas/TargetCapacityUnitType'
- - description: 'The unit for the target capacity.
Default: units (translates to number of instances)
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptions and SpotOptions.
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
lowest-price - EC2 Fleet launches instances from the Spot Instance pools with the lowest price.
diversified - EC2 Fleet launches instances from all of the Spot Instance pools that you specify.
capacity-optimized (recommended) - EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
Default: lowest-price
The behavior when a Spot Instance is interrupted.
Default: terminate
The number of Spot pools across which to allocate your target Spot capacity. Supported only when AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
' - singleInstanceType: - allOf: - - $ref: '#/components/schemas/Boolean' - - description:Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant.
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.
lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.
prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.
Default: lowest-price
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
Supported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
Supported only for fleets of type instant.
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.'
- createTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The creation date and time of the EC2 Fleet.
- fleetId:
- allOf:
- - $ref: '#/components/schemas/FleetId'
- - description: The ID of the EC2 Fleet.
- fleetState:
- allOf:
- - $ref: '#/components/schemas/FleetStateCode'
- - description: The state of the EC2 Fleet.
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraints: Maximum 64 ASCII characters
' - excessCapacityTerminationPolicy: - allOf: - - $ref: '#/components/schemas/FleetExcessCapacityTerminationPolicy' - - description: Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. - fulfilledCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: The number of units fulfilled by this request compared to the set target capacity. - fulfilledOnDemandCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: The number of units fulfilled by this request compared to the set target On-Demand capacity. - launchTemplateConfigs: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateConfigList' - - description: The launch template and overrides. - targetCapacitySpecification: - allOf: - - $ref: '#/components/schemas/TargetCapacitySpecification' - - description: 'The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type ismaintain, you can specify a target capacity of 0 and add capacity later.'
- terminateInstancesWithExpiration:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether running instances should be terminated when the EC2 Fleet expires. '
- type:
- allOf:
- - $ref: '#/components/schemas/FleetType'
- - description: 'The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.'
- validFrom:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately. '
- validUntil:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date. '
- replaceUnhealthyInstances:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.'
- spotOptions:
- allOf:
- - $ref: '#/components/schemas/SpotOptions'
- - description: The configuration of Spot Instances in an EC2 Fleet.
- onDemandOptions:
- allOf:
- - $ref: '#/components/schemas/OnDemandOptions'
- - description: The allocation strategy of On-Demand Instances in an EC2 Fleet.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for an EC2 Fleet resource.
- errorSet:
- allOf:
- - $ref: '#/components/schemas/DescribeFleetsErrorSet'
- - description: Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.
- fleetInstanceSet:
- allOf:
- - $ref: '#/components/schemas/DescribeFleetsInstancesSet'
- - description: Information about the instances that were launched by the fleet. Valid only when Type is set to instant.
- context:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Reserved.
- description: Describes an EC2 Fleet.
- FleetEventType:
- type: string
- enum:
- - instance-change
- - fleet-change
- - service-error
- FleetLaunchTemplateSpecification:
- type: object
- properties:
- launchTemplateId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ID of the launch template. If you specify the template ID, you can''t specify the template name.'
- launchTemplateName:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateName'
- - description: 'The name of the launch template. If you specify the template name, you can''t specify the template ID.'
- version:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
The CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don''t confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
' - memoryGiBPerVCpu: - allOf: - - $ref: '#/components/schemas/MemoryGiBPerVCpu' - - description: 'The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
' - excludedInstanceTypeSet: - allOf: - - $ref: '#/components/schemas/ExcludedInstanceTypeSet' - - description: 'The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
Default: No excluded instance types
' - instanceGenerationSet: - allOf: - - $ref: '#/components/schemas/InstanceGenerationSet' - - description: 'Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.
For current generation instance types, specify current.
For previous generation instance types, specify previous.
Default: Current and previous generation instance types
' - spotMaxPricePercentageOverLowestPrice: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 100
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20
Indicates whether bare metal instance types must be included, excluded, or required.
To include bare metal instance types, specify included.
To require only bare metal instance types, specify required.
To exclude bare metal instance types, specify excluded.
Default: excluded
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
To include burstable performance instance types, specify included.
To require only burstable performance instance types, specify required.
To exclude burstable performance instance types, specify excluded.
Default: excluded
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default: false
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
' - localStorage: - allOf: - - $ref: '#/components/schemas/LocalStorage' - - description: 'Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
To include instance types with instance store volumes, specify included.
To require only instance types with instance store volumes, specify required.
To exclude instance types with instance store volumes, specify excluded.
Default: included
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SDD) storage, specify sdd.
Default: hdd and sdd
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
' - baselineEbsBandwidthMbps: - allOf: - - $ref: '#/components/schemas/BaselineEbsBandwidthMbps' - - description: 'The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
' - acceleratorTypeSet: - allOf: - - $ref: '#/components/schemas/AcceleratorTypeSet' - - description: 'The accelerator types that must be on the instance type.
For instance types with GPU accelerators, specify gpu.
For instance types with FPGA accelerators, specify fpga.
For instance types with inference accelerators, specify inference.
Default: Any accelerator type
' - acceleratorCount: - allOf: - - $ref: '#/components/schemas/AcceleratorCount' - - description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
' - acceleratorManufacturerSet: - allOf: - - $ref: '#/components/schemas/AcceleratorManufacturerSet' - - description: 'Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
' - acceleratorNameSet: - allOf: - - $ref: '#/components/schemas/AcceleratorNameSet' - - description: 'The accelerators that must be on the instance type.
For instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
Default: Any accelerator
' - acceleratorTotalMemoryMiB: - allOf: - - $ref: '#/components/schemas/AcceleratorTotalMemoryMiB' - - description: 'The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
' - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
You must specify VCpuCount and MemoryMiB. All other parameters are optional. Any unspecified optional parameter is set to its default.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
' - FleetLaunchTemplateOverrides: - type: object - properties: - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: 'The instance type.
If you specify InstanceTypes, you can''t specify InstanceRequirements.
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can''t specify InstanceTypes.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can''t specify InstanceTypes.
The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
The replacement strategy to use. Only available for fleets of type maintain.
launch - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay), terminates the instances that received a rebalance notification.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you''ve reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.'
- deliverLogsPermissionArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ARN of the IAM role that posts logs to CloudWatch Logs.
- deliverLogsStatus:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The status of the logs delivery (SUCCESS | FAILED).
- flowLogId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The flow log ID.
- flowLogStatus:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The status of the flow log (ACTIVE).
- logGroupName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the flow log group.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource on which the flow log was created.
- trafficType:
- allOf:
- - $ref: '#/components/schemas/TrafficType'
- - description: The type of traffic captured for the flow log.
- logDestinationType:
- allOf:
- - $ref: '#/components/schemas/LogDestinationType'
- - description: The type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3.
- logDestination:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published.'
- logFormat:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The format of the flow log record.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for the flow log.
- maxAggregationInterval:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.
Valid Values: 60 | 600
The state. The following are the possible values:
pending - AFI bitstream generation is in progress.
available - The AFI is available for use.
failed - AFI bitstream generation failed.
unavailable - The AFI is no longer available for use.
failed, this is the error message.'
- description: Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).
- FpgaImage:
- type: object
- properties:
- fpgaImageId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The FPGA image identifier (AFI ID).
- fpgaImageGlobalId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The global FPGA image identifier (AGFI ID).
- name:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the AFI.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the AFI.
- shellVersion:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The version of the Amazon Web Services Shell that was used to create the bitstream.
- pciId:
- allOf:
- - $ref: '#/components/schemas/PciId'
- - description: Information about the PCI bus.
- state:
- allOf:
- - $ref: '#/components/schemas/FpgaImageState'
- - description: Information about the state of the AFI.
- createTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The date and time the AFI was created.
- updateTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time of the most recent update to the AFI.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the AFI.
- ownerAlias:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.'
- productCodes:
- allOf:
- - $ref: '#/components/schemas/ProductCodeList'
- - description: The product codes for the AFI.
- tags:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the AFI.
- public:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the AFI is public.
- dataRetentionSupport:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether data retention support is enabled for the AFI.
- description: Describes an Amazon FPGA image (AFI).
- LoadPermissionList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LoadPermission'
- - xml:
- name: item
- FpgaImageStateCode:
- type: string
- enum:
- - pending
- - failed
- - available
- - unavailable
- totalFpgaMemory:
- type: integer
- FpgaInfo:
- type: object
- properties:
- fpgas:
- allOf:
- - $ref: '#/components/schemas/FpgaDeviceInfoList'
- - description: Describes the FPGAs for the instance type.
- totalFpgaMemoryInMiB:
- allOf:
- - $ref: '#/components/schemas/totalFpgaMemory'
- - description: The total memory of all FPGA accelerators for the instance type.
- description: Describes the FPGAs for the instance type.
- FreeTierEligibleFlag:
- type: boolean
- GVCDMaxResults:
- type: integer
- minimum: 200
- maximum: 1000
- GatewayAssociationState:
- type: string
- enum:
- - associated
- - not-associated
- - associating
- - disassociating
- GetAssociatedEnclaveCertificateIamRolesRequest:
- type: object
- title: GetAssociatedEnclaveCertificateIamRolesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- GetAssociatedIpv6PoolCidrsRequest:
- type: object
- required:
- - PoolId
- title: GetAssociatedIpv6PoolCidrsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Ipv6CidrAssociationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv6CidrAssociation'
- - xml:
- name: item
- GetCapacityReservationUsageRequest:
- type: object
- required:
- - CapacityReservationId
- title: GetCapacityReservationUsageRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- GetCapacityReservationUsageRequestMaxResults:
- type: integer
- minimum: 1
- maximum: 1000
- InstanceUsageSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceUsage'
- - xml:
- name: item
- GetCoipPoolUsageRequest:
- type: object
- required:
- - PoolId
- title: GetCoipPoolUsageRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Ipv4PoolCoipId'
- - description: The ID of the address pool.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- GetConsoleOutputRequest:
- type: object
- required:
- - InstanceId
- title: GetConsoleOutputRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of the instance.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'When enabled, retrieves the latest console output for the instance.
Default: disabled (false)
true, acts as keystroke input and wakes up an instance that''s in standby or "sleep" mode.'
- UnlimitedSupportedInstanceFamily:
- type: string
- enum:
- - t2
- - t3
- - t3a
- - t4g
- GetDefaultCreditSpecificationRequest:
- type: object
- required:
- - InstanceFamily
- title: GetDefaultCreditSpecificationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/UnlimitedSupportedInstanceFamily'
- - description: The instance family.
- InstanceFamilyCreditSpecification:
- type: object
- properties:
- instanceFamily:
- allOf:
- - $ref: '#/components/schemas/UnlimitedSupportedInstanceFamily'
- - description: The instance family.
- cpuCredits:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The default credit option for CPU usage of the instance family. Valid values are standard and unlimited.
- description: Describes the default credit option for CPU usage of a burstable performance instance family.
- GetEbsDefaultKmsKeyIdRequest:
- type: object
- title: GetEbsDefaultKmsKeyIdRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- GetEbsEncryptionByDefaultRequest:
- type: object
- title: GetEbsEncryptionByDefaultRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- IntegrateServices:
- type: object
- properties:
- AthenaIntegration:
- allOf:
- - $ref: '#/components/schemas/AthenaIntegrationsSet'
- - description: Information about the integration with Amazon Athena.
- description: Describes service integrations with VPC Flow logs.
- GetFlowLogsIntegrationTemplateRequest:
- type: object
- required:
- - FlowLogId
- - ConfigDeliveryS3DestinationArn
- - IntegrateServices
- title: GetFlowLogsIntegrationTemplateRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.'
- IntegrateService:
- allOf:
- - $ref: '#/components/schemas/IntegrateServices'
- - description: Information about the service integration.
- GetGroupsForCapacityReservationRequest:
- type: object
- required:
- - CapacityReservationId
- title: GetGroupsForCapacityReservationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- GetGroupsForCapacityReservationRequestMaxResults:
- type: integer
- minimum: 1
- maximum: 1000
- GetHostReservationPurchasePreviewRequest:
- type: object
- required:
- - HostIdSet
- - OfferingId
- title: GetHostReservationPurchasePreviewRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/OfferingId'
- - description: The offering ID of the reservation.
- PurchaseSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Purchase'
- - xml:
- name: item
- GetInstanceTypesFromInstanceRequirementsRequest:
- type: object
- required:
- - ArchitectureTypes
- - VirtualizationTypes
- - InstanceRequirements
- title: GetInstanceTypesFromInstanceRequirementsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ArchitectureType:
- allOf:
- - $ref: '#/components/schemas/ArchitectureTypeSet'
- - description: The processor architecture type.
- VirtualizationType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next set of results.
- InstanceTypeInfoFromInstanceRequirementsSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceTypeInfoFromInstanceRequirements'
- - xml:
- name: item
- GetInstanceUefiDataRequest:
- type: object
- required:
- - InstanceId
- title: GetInstanceUefiDataRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- GetIpamAddressHistoryRequest:
- type: object
- required:
- - Cidr
- - IpamScopeId
- title: GetIpamAddressHistoryRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- IpamAddressHistoryRecordSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpamAddressHistoryRecord'
- - xml:
- name: item
- GetIpamPoolAllocationsMaxResults:
- type: integer
- minimum: 1000
- maximum: 100000
- IpamPoolAllocationId:
- type: string
- GetIpamPoolAllocationsRequest:
- type: object
- required:
- - IpamPoolId
- title: GetIpamPoolAllocationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/IpamPoolAllocationId'
- - description: The ID of the allocation.
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- IpamPoolAllocationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpamPoolAllocation'
- - xml:
- name: item
- GetIpamPoolCidrsRequest:
- type: object
- required:
- - IpamPoolId
- title: GetIpamPoolCidrsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/IpamPoolId'
- - description: The ID of the IPAM pool you want the CIDR for.
- Filter:
- allOf:
- - $ref: '#/components/schemas/NextToken'
- - description: The token for the next page of results.
- IpamPoolCidrSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpamPoolCidr'
- - xml:
- name: item
- GetIpamResourceCidrsRequest:
- type: object
- required:
- - IpamScopeId
- title: GetIpamResourceCidrsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- Filter:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the resource.
- IpamResourceCidrSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpamResourceCidr'
- - xml:
- name: item
- GetLaunchTemplateDataRequest:
- type: object
- required:
- - InstanceId
- title: GetLaunchTemplateDataRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of the instance.
- ResponseLaunchTemplateData:
- type: object
- properties:
- kernelId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ID of the kernel, if applicable.'
- ebsOptimized:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether the instance is optimized for Amazon EBS I/O. '
- iamInstanceProfile:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecification'
- - description: The IAM instance profile.
- blockDeviceMappingSet:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingList'
- - description: The block device mappings.
- networkInterfaceSet:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecificationList'
- - description: The network interfaces.
- imageId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the AMI that was used to launch the instance.
- instanceType:
- allOf:
- - $ref: '#/components/schemas/InstanceType'
- - description: The instance type.
- keyName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the key pair.
- monitoring:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplatesMonitoring'
- - description: The monitoring for the instance.
- placement:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplatePlacement'
- - description: The placement of the instance.
- ramDiskId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ID of the RAM disk, if applicable.'
- disableApiTermination:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.'
- instanceInitiatedShutdownBehavior:
- allOf:
- - $ref: '#/components/schemas/ShutdownBehavior'
- - description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
- userData:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The user data for the instance. '
- tagSpecificationSet:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateTagSpecificationList'
- - description: The tags.
- elasticGpuSpecificationSet:
- allOf:
- - $ref: '#/components/schemas/ElasticGpuSpecificationResponseList'
- - description: The elastic GPU specification.
- elasticInferenceAcceleratorSet:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorResponseList'
- - description: ' The elastic inference accelerator for the instance. '
- securityGroupIdSet:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The security group IDs.
- securityGroupSet:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The security group names.
- instanceMarketOptions:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateInstanceMarketOptions'
- - description: The market (purchasing) option for the instances.
- creditSpecification:
- allOf:
- - $ref: '#/components/schemas/CreditSpecification'
- - description: The credit option for CPU usage of the instance.
- cpuOptions:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateCpuOptions'
- - description: 'The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide.'
- capacityReservationSpecification:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationResponse'
- - description: Information about the Capacity Reservation targeting option.
- licenseSet:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateLicenseList'
- - description: The license configurations.
- hibernationOptions:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateHibernationOptions'
- - description: 'Indicates whether an instance is configured for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.'
- metadataOptions:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataOptions'
- - description: 'The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.'
- enclaveOptions:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateEnclaveOptions'
- - description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
- instanceRequirements:
- allOf:
- - $ref: '#/components/schemas/InstanceRequirements'
- - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
If you specify InstanceRequirements, you can''t specify InstanceTypes.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- GetNetworkInsightsAccessScopeContentRequest:
- type: object
- required:
- - NetworkInsightsAccessScopeId
- title: GetNetworkInsightsAccessScopeContentRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- GetPasswordDataRequest:
- type: object
- required:
- - InstanceId
- title: GetPasswordDataRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of the Windows instance.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- GetReservedInstancesExchangeQuoteRequest:
- type: object
- required:
- - ReservedInstanceIds
- title: GetReservedInstancesExchangeQuoteRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ReservedInstanceId:
- allOf:
- - $ref: '#/components/schemas/ReservedInstanceIdSet'
- - description: The IDs of the Convertible Reserved Instances to exchange.
- TargetConfiguration:
- allOf:
- - $ref: '#/components/schemas/TargetConfigurationRequestSet'
- - description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
- description: Contains the parameters for GetReservedInstanceExchangeQuote.
- ReservationValue:
- type: object
- properties:
- hourlyPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The hourly rate of the reservation.
- remainingTotalValue:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
- remainingUpfrontValue:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The remaining upfront cost of the reservation.
- description: The cost associated with the Reserved Instance.
- ReservedInstanceReservationValueSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservedInstanceReservationValue'
- - xml:
- name: item
- TargetReservationValueSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TargetReservationValue'
- - xml:
- name: item
- GetSerialConsoleAccessStatusRequest:
- type: object
- title: GetSerialConsoleAccessStatusRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- GetSpotPlacementScoresRequest:
- type: object
- required:
- - TargetCapacity
- title: GetSpotPlacementScoresRequest
- properties:
- InstanceType:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Specify true so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions.
A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone.
' - RegionName: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - SpotPlacementScores: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotPlacementScore' - - xml: - name: item - GetSubnetCidrReservationsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - GetSubnetCidrReservationsRequest: - type: object - required: - - SubnetId - title: GetSubnetCidrReservationsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/GetSubnetCidrReservationsMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
- SubnetCidrReservationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SubnetCidrReservation'
- - xml:
- name: item
- GetTransitGatewayAttachmentPropagationsRequest:
- type: object
- required:
- - TransitGatewayAttachmentId
- title: GetTransitGatewayAttachmentPropagationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentId'
- - description: The ID of the attachment.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayAttachmentPropagationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentPropagation'
- - xml:
- name: item
- GetTransitGatewayMulticastDomainAssociationsRequest:
- type: object
- title: GetTransitGatewayMulticastDomainAssociationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- - description: The ID of the transit gateway multicast domain.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayMulticastDomainAssociationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociation'
- - xml:
- name: item
- GetTransitGatewayPrefixListReferencesRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- title: GetTransitGatewayPrefixListReferencesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableId'
- - description: The ID of the transit gateway route table.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayPrefixListReferenceSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPrefixListReference'
- - xml:
- name: item
- GetTransitGatewayRouteTableAssociationsRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- title: GetTransitGatewayRouteTableAssociationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableId'
- - description: The ID of the transit gateway route table.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayRouteTableAssociationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableAssociation'
- - xml:
- name: item
- GetTransitGatewayRouteTablePropagationsRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- title: GetTransitGatewayRouteTablePropagationsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableId'
- - description: The ID of the transit gateway route table.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayRouteTablePropagationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTablePropagation'
- - xml:
- name: item
- GetVpnConnectionDeviceSampleConfigurationRequest:
- type: object
- required:
- - VpnConnectionId
- - VpnConnectionDeviceTypeId
- title: GetVpnConnectionDeviceSampleConfigurationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- VpnConnectionDeviceSampleConfiguration:
- type: string
- format: password
- GetVpnConnectionDeviceTypesRequest:
- type: object
- title: GetVpnConnectionDeviceTypesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- VpnConnectionDeviceTypeList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpnConnectionDeviceType'
- - xml:
- name: item
- GpuDeviceCount:
- type: integer
- GpuDeviceName:
- type: string
- GpuDeviceManufacturerName:
- type: string
- GpuDeviceMemoryInfo:
- type: object
- properties:
- sizeInMiB:
- allOf:
- - $ref: '#/components/schemas/GpuDeviceMemorySize'
- - description: 'The size of the memory available to the GPU accelerator, in MiB.'
- description: Describes the memory available to the GPU accelerator.
- GpuDeviceInfo:
- type: object
- properties:
- name:
- allOf:
- - $ref: '#/components/schemas/GpuDeviceName'
- - description: The name of the GPU accelerator.
- manufacturer:
- allOf:
- - $ref: '#/components/schemas/GpuDeviceManufacturerName'
- - description: The manufacturer of the GPU accelerator.
- count:
- allOf:
- - $ref: '#/components/schemas/GpuDeviceCount'
- - description: The number of GPUs for the instance type.
- memoryInfo:
- allOf:
- - $ref: '#/components/schemas/GpuDeviceMemoryInfo'
- - description: Describes the memory available to the GPU accelerator.
- description: Describes the GPU accelerators for the instance type.
- GpuDeviceInfoList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/GpuDeviceInfo'
- - xml:
- name: item
- GpuDeviceMemorySize:
- type: integer
- totalGpuMemory:
- type: integer
- GpuInfo:
- type: object
- properties:
- gpus:
- allOf:
- - $ref: '#/components/schemas/GpuDeviceInfoList'
- - description: Describes the GPU accelerators for the instance type.
- totalGpuMemoryInMiB:
- allOf:
- - $ref: '#/components/schemas/totalGpuMemory'
- - description: 'The total size of the memory for the GPU accelerators for the instance type, in MiB.'
- description: Describes the GPU accelerators for the instance type.
- GroupIdentifier:
- type: object
- properties:
- groupName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the security group.
- groupId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the security group.
- description: Describes a security group.
- SecurityGroupIdentifier:
- type: object
- properties:
- groupId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the security group.
- groupName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the security group.
- description: Describes a security group.
- GroupIdentifierSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupIdentifier'
- - xml:
- name: item
- HibernationFlag:
- type: boolean
- HibernationOptions:
- type: object
- properties:
- configured:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If this parameter is set to true, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.'
- description: 'Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.'
- HibernationOptionsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If you set this parameter to true, your instance is enabled for hibernation.
Default: false
The event type.
error - An error with the Spot Fleet request.
fleetRequestChange - A change in the status or configuration of the Spot Fleet request.
instanceChange - An instance was launched or terminated.
Information - An informational event.
m5.large. If the host supports multiple instance types, no instanceType is returned.'
- instanceFamily:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The instance family supported by the Dedicated Host. For example, m5.'
- sockets:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of sockets on the Dedicated Host.
- totalVCpus:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The total number of vCPUs on the Dedicated Host.
- description: Describes the properties of a Dedicated Host.
- HostInstanceList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/HostInstance'
- - xml:
- name: item
- HostRecovery:
- type: string
- enum:
- - 'on'
- - 'off'
- Host:
- type: object
- properties:
- autoPlacement:
- allOf:
- - $ref: '#/components/schemas/AutoPlacement'
- - description: Whether auto-placement is on or off.
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone of the Dedicated Host.
- availableCapacity:
- allOf:
- - $ref: '#/components/schemas/AvailableCapacity'
- - description: Information about the instances running on the Dedicated Host.
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
- hostId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Dedicated Host.
- hostProperties:
- allOf:
- - $ref: '#/components/schemas/HostProperties'
- - description: The hardware specifications of the Dedicated Host.
- hostReservationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.
- instances:
- allOf:
- - $ref: '#/components/schemas/HostInstanceList'
- - description: The IDs and instance type that are currently running on the Dedicated Host.
- state:
- allOf:
- - $ref: '#/components/schemas/AllocationState'
- - description: The Dedicated Host's state.
- allocationTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time that the Dedicated Host was allocated.
- releaseTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time that the Dedicated Host was released.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the Dedicated Host.
- hostRecovery:
- allOf:
- - $ref: '#/components/schemas/HostRecovery'
- - description: Indicates whether host recovery is enabled or disabled for the Dedicated Host.
- allowsMultipleInstanceTypes:
- allOf:
- - $ref: '#/components/schemas/AllowsMultipleInstanceTypes'
- - description: 'Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.'
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the Dedicated Host.
- availabilityZoneId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Availability Zone in which the Dedicated Host is allocated.
- memberOfServiceLinkedResourceGroup:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the host is in a host resource group; otherwise, it is not.'
- outpostArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.
- description: Describes the properties of the Dedicated Host.
- HostInstance:
- type: object
- properties:
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of instance that is running on the Dedicated Host.
- instanceType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The instance type (for example, m3.medium) of the running instance.'
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the instance.
- description: Describes an instance running on a Dedicated Host.
- PaymentOption:
- type: string
- enum:
- - AllUpfront
- - PartialUpfront
- - NoUpfront
- HostOffering:
- type: object
- properties:
- currencyCode:
- allOf:
- - $ref: '#/components/schemas/CurrencyCodeValues'
- - description: The currency of the offering.
- duration:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The duration of the offering (in seconds).
- hourlyPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The hourly price of the offering.
- instanceFamily:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The instance family of the offering.
- offeringId:
- allOf:
- - $ref: '#/components/schemas/OfferingId'
- - description: The ID of the offering.
- paymentOption:
- allOf:
- - $ref: '#/components/schemas/PaymentOption'
- - description: The available payment option.
- upfrontPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The upfront price of the offering. Does not apply to No Upfront offerings.
- description: Details about the Dedicated Host Reservation offering.
- ResponseHostIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- ReservationState:
- type: string
- enum:
- - payment-pending
- - payment-failed
- - active
- - retired
- HostReservation:
- type: object
- properties:
- count:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of Dedicated Hosts the reservation is associated with.
- currencyCode:
- allOf:
- - $ref: '#/components/schemas/CurrencyCodeValues'
- - description: 'The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.'
- duration:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The length of the reservation''s term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).'
- end:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The date and time that the reservation ends.
- hostIdSet:
- allOf:
- - $ref: '#/components/schemas/ResponseHostIdSet'
- - description: The IDs of the Dedicated Hosts associated with the reservation.
- hostReservationId:
- allOf:
- - $ref: '#/components/schemas/HostReservationId'
- - description: The ID of the reservation that specifies the associated Dedicated Hosts.
- hourlyPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The hourly price of the reservation.
- instanceFamily:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.
- offeringId:
- allOf:
- - $ref: '#/components/schemas/OfferingId'
- - description: The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
- paymentOption:
- allOf:
- - $ref: '#/components/schemas/PaymentOption'
- - description: The payment option selected for this reservation.
- start:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The date and time that the reservation started.
- state:
- allOf:
- - $ref: '#/components/schemas/ReservationState'
- - description: The state of the reservation.
- upfrontPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The upfront price of the reservation.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the Dedicated Host Reservation.
- description: Details about the Dedicated Host Reservation and associated Dedicated Hosts.
- HostReservationIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/HostReservationId'
- - xml:
- name: item
- HostTenancy:
- type: string
- enum:
- - dedicated
- - host
- HostnameType:
- type: string
- enum:
- - ip-name
- - resource-name
- Hour:
- type: integer
- minimum: 0
- maximum: 23
- HttpTokensState:
- type: string
- enum:
- - optional
- - required
- HypervisorType:
- type: string
- enum:
- - ovm
- - xen
- IKEVersionsListValue:
- type: object
- properties:
- value:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IKE version.
- description: The internet key exchange (IKE) version permitted for the VPN tunnel.
- IKEVersionsList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IKEVersionsListValue'
- - xml:
- name: item
- IKEVersionsRequestListValue:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IKE version.
- description: The IKE version that is permitted for the VPN tunnel.
- IKEVersionsRequestList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IKEVersionsRequestListValue'
- - xml:
- name: item
- IamInstanceProfile:
- type: object
- properties:
- arn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the instance profile.
- id:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance profile.
- description: Describes an IAM instance profile.
- IamInstanceProfileAssociationState:
- type: string
- enum:
- - associating
- - associated
- - disassociating
- - disassociated
- IdFormat:
- type: object
- properties:
- deadline:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.'
- resource:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The type of resource.
- useLongIds:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether longer IDs (17-character IDs) are enabled for the resource.
- description: Describes the ID format for a resource.
- Igmpv2SupportValue:
- type: string
- enum:
- - enable
- - disable
- ImageTypeValues:
- type: string
- enum:
- - machine
- - kernel
- - ramdisk
- ImageState:
- type: string
- enum:
- - pending
- - available
- - invalid
- - deregistered
- - transient
- - failed
- - error
- StateReason:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The reason code for the state change.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The message for the state change.
Server.InsufficientInstanceCapacity: There was insufficient capacity available to satisfy the launch request.
Server.InternalError: An internal error caused the instance to terminate during launch.
Server.ScheduledStop: The instance was stopped due to a scheduled retirement.
Server.SpotInstanceShutdown: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
Server.SpotInstanceTermination: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.
Client.InstanceTerminated: The instance was terminated or rebooted during AMI creation.
Client.InternalError: A client error caused the instance to terminate during launch.
Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
Client.UserInitiatedHibernate: Hibernation was initiated on the instance.
Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.
true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
- kernelId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The kernel associated with the image, if any. Only applicable for machine images.'
- imageOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the image.
- platform:
- allOf:
- - $ref: '#/components/schemas/PlatformValues'
- - description: 'This value is set to windows for Windows AMIs; otherwise, it is blank.'
- platformDetails:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The platform details associated with the billing code of the AMI. For more information, see Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide.'
- usageOperation:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.'
- productCodes:
- allOf:
- - $ref: '#/components/schemas/ProductCodeList'
- - description: Any product codes associated with the AMI.
- ramdiskId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The RAM disk associated with the image, if any. Only applicable for machine images.'
- imageState:
- allOf:
- - $ref: '#/components/schemas/ImageState'
- - description: 'The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.'
- blockDeviceMapping:
- allOf:
- - $ref: '#/components/schemas/BlockDeviceMappingList'
- - description: Any block device mapping entries.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the AMI that was provided during image creation.
- enaSupport:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Specifies whether enhanced networking with ENA is enabled.
- hypervisor:
- allOf:
- - $ref: '#/components/schemas/HypervisorType'
- - description: The hypervisor type of the image.
- imageOwnerAlias:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Amazon Web Services account alias (for example, amazon, self) or the Amazon Web Services account ID of the AMI owner.'
- name:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the AMI that was provided during image creation.
- rootDeviceName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The device name of the root device volume (for example, /dev/sda1).'
- rootDeviceType:
- allOf:
- - $ref: '#/components/schemas/DeviceType'
- - description: The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
- sriovNetSupport:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
- stateReason:
- allOf:
- - $ref: '#/components/schemas/StateReason'
- - description: The reason for the state change.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the image.
- virtualizationType:
- allOf:
- - $ref: '#/components/schemas/VirtualizationType'
- - description: The type of virtualization of the AMI.
- bootMode:
- allOf:
- - $ref: '#/components/schemas/BootModeValues'
- - description: 'The boot mode of the image. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.'
- tpmSupport:
- allOf:
- - $ref: '#/components/schemas/TpmSupportValues'
- - description: 'If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.'
- deprecationTime:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.'
- description: Describes an image.
- ImageAttributeName:
- type: string
- enum:
- - description
- - kernel
- - ramdisk
- - launchPermission
- - productCodes
- - blockDeviceMapping
- - sriovNetSupport
- - bootMode
- - tpmSupport
- - uefiData
- - lastLaunchedTime
- ImageDiskContainerList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImageDiskContainer'
- - xml:
- name: item
- ImageIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImageId'
- - xml:
- name: item
- ImageRecycleBinInfo:
- type: object
- properties:
- imageId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the AMI.
- name:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the AMI.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the AMI.
- recycleBinEnterTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The date and time when the AMI entered the Recycle Bin.
- recycleBinExitTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The date and time when the AMI is to be permanently deleted from the Recycle Bin.
- description: Information about an AMI that is currently in the Recycle Bin.
- ImageRecycleBinInfoList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImageRecycleBinInfo'
- - xml:
- name: item
- ImportClientVpnClientCertificateRevocationListRequest:
- type: object
- required:
- - ClientVpnEndpointId
- - CertificateRevocationList
- title: ImportClientVpnClientCertificateRevocationListRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ImportImageLicenseConfigurationResponse:
- type: object
- properties:
- licenseConfigurationArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ARN of a license configuration.
- description: ' The response information for license configurations.'
- ImportImageLicenseSpecificationListRequest:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImportImageLicenseConfigurationRequest'
- - xml:
- name: item
- ImportImageLicenseSpecificationListResponse:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImportImageLicenseConfigurationResponse'
- - xml:
- name: item
- ImportImageRequest:
- type: object
- title: ImportImageRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description string for the import image task.
- DiskContainer:
- allOf:
- - $ref: '#/components/schemas/ImportImageLicenseSpecificationListRequest'
- - description: The ARNs of the license configurations.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/BootModeValues'
- - description: The boot mode of the virtual machine.
- SnapshotDetailList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SnapshotDetail'
- - xml:
- name: item
- ImportImageTask:
- type: object
- properties:
- architecture:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The architecture of the virtual machine.
Valid values: i386 | x86_64 | arm64
The target hypervisor for the import task.
Valid values: xen
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- launchSpecification:
- allOf:
- - $ref: '#/components/schemas/ImportInstanceLaunchSpecification'
- - description: The launch specification.
- platform:
- allOf:
- - $ref: '#/components/schemas/PlatformValues'
- - description: The instance operating system.
- ImportInstanceVolumeDetailSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImportInstanceVolumeDetailItem'
- - xml:
- name: item
- ImportInstanceVolumeDetailItem:
- type: object
- properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone where the resulting instance will reside.
- bytesConverted:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: The number of bytes converted so far.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the task.
- image:
- allOf:
- - $ref: '#/components/schemas/DiskImageDescription'
- - description: The image.
- status:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The status of the import of this particular disk image.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The status information or errors related to the disk image.
- volume:
- allOf:
- - $ref: '#/components/schemas/DiskImageVolumeDescription'
- - description: The volume.
- description: Describes an import volume task.
- ImportKeyPairRequest:
- type: object
- required:
- - KeyName
- - PublicKeyMaterial
- title: ImportKeyPairRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- keyName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A unique name for the key pair.
- publicKeyMaterial:
- allOf:
- - $ref: '#/components/schemas/Blob'
- - description: 'The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to apply to the imported key pair.
- ImportSnapshotRequest:
- type: object
- title: ImportSnapshotRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The name of the role to use when not using the default role, ''vmimport''.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to apply to the import snapshot task during creation.
- SnapshotTaskDetail:
- type: object
- properties:
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the snapshot.
- diskImageSize:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: 'The size of the disk in the snapshot, in GiB.'
- encrypted:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the snapshot is encrypted.
- format:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The format of the disk image from which the snapshot is created.
- kmsKeyId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The identifier for the KMS key that was used to create the encrypted snapshot.
- progress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The percentage of completion for the import snapshot task.
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The snapshot ID of the disk being imported.
- status:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A brief status for the import snapshot task.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A detailed status message for the import snapshot task.
- url:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The URL of the disk image from which the snapshot is created.
- userBucket:
- allOf:
- - $ref: '#/components/schemas/UserBucketDetails'
- - description: The Amazon S3 bucket for the disk image.
- description: Details about the import snapshot task.
- ImportSnapshotTask:
- type: object
- properties:
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the import snapshot task.
- importTaskId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the import snapshot task.
- snapshotTaskDetail:
- allOf:
- - $ref: '#/components/schemas/SnapshotTaskDetail'
- - description: Describes an import snapshot task.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for the import snapshot task.
- description: Describes an import snapshot task.
- ImportSnapshotTaskIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImportSnapshotTaskId'
- - xml:
- name: ImportTaskId
- ImportTaskIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ImportImageTaskId'
- - xml:
- name: ImportTaskId
- ImportVolumeRequest:
- type: object
- required:
- - AvailabilityZone
- - Image
- - Volume
- title: ImportVolumeRequest
- properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone for the resulting EBS volume.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the volume.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- image:
- allOf:
- - $ref: '#/components/schemas/DiskImageDetail'
- - description: The disk image.
- volume:
- allOf:
- - $ref: '#/components/schemas/VolumeDetail'
- - description: The volume size.
- InferenceDeviceInfoList:
- type: array
- items:
- $ref: '#/components/schemas/InferenceDeviceInfo'
- InferenceAcceleratorInfo:
- type: object
- properties:
- accelerators:
- allOf:
- - $ref: '#/components/schemas/InferenceDeviceInfoList'
- - description: Describes the Inference accelerators for the instance type.
- description: Describes the Inference accelerators for the instance type.
- InferenceDeviceCount:
- type: integer
- InferenceDeviceName:
- type: string
- InferenceDeviceManufacturerName:
- type: string
- InferenceDeviceInfo:
- type: object
- properties:
- count:
- allOf:
- - $ref: '#/components/schemas/InferenceDeviceCount'
- - description: The number of Inference accelerators for the instance type.
- name:
- allOf:
- - $ref: '#/components/schemas/InferenceDeviceName'
- - description: The name of the Inference accelerator.
- manufacturer:
- allOf:
- - $ref: '#/components/schemas/InferenceDeviceManufacturerName'
- - description: The manufacturer of the Inference accelerator.
- description: Describes the Inference accelerators for the instance type.
- Monitoring:
- type: object
- properties:
- state:
- allOf:
- - $ref: '#/components/schemas/MonitoringState'
- - description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.'
- description: Describes the monitoring of an instance.
- InstanceState:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
' - name: - allOf: - - $ref: '#/components/schemas/InstanceStateName' - - description: The current state of the instance. - description: Describes the current state of an instance. - InstanceBlockDeviceMappingList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceBlockDeviceMapping' - - xml: - name: item - InstanceLifecycleType: - type: string - enum: - - spot - - scheduled - InstanceNetworkInterfaceList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterface' - - xml: - name: item - LicenseList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LicenseConfiguration' - - xml: - name: item - InstanceMetadataOptionsResponse: - type: object - properties: - state: - allOf: - - $ref: '#/components/schemas/InstanceMetadataOptionsState' - - description:The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
The state of token usage for your instance metadata requests.
If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.
Default: optional
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
' - httpEndpoint: - allOf: - - $ref: '#/components/schemas/InstanceMetadataEndpointState' - - description: 'Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
If the value is disabled, you cannot access your instance metadata.
Windows for Windows instances; otherwise blank.
- privateDnsName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: '(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you''ve enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
' - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The private IPv4 address assigned to the instance. - productCodes: - allOf: - - $ref: '#/components/schemas/ProductCodeList' - - description: 'The product codes attached to this instance, if applicable.' - dnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: '(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters therunning state. For EC2-VPC, this name is only available if you''ve enabled DNS hostnames for your VPC.'
- ipAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
' - ramdiskId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The RAM disk associated with this instance, if applicable.' - instanceState: - allOf: - - $ref: '#/components/schemas/InstanceState' - - description: The current state of the instance. - reason: - allOf: - - $ref: '#/components/schemas/String' - - description: The reason for the most recent state transition. This might be an empty string. - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: '[EC2-VPC] The ID of the subnet in which the instance is running.' - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: '[EC2-VPC] The ID of the VPC in which the instance is running.' - architecture: - allOf: - - $ref: '#/components/schemas/ArchitectureValues' - - description: The architecture of the image. - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/InstanceBlockDeviceMappingList' - - description: Any block device mapping entries for the instance. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The idempotency token you provided when you launched the instance, if applicable.' - ebsOptimized: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. - enaSupport: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Specifies whether enhanced networking with ENA is enabled. - hypervisor: - allOf: - - $ref: '#/components/schemas/HypervisorType' - - description: The hypervisor type of the instance. The valuexen is used for both Xen and Nitro hypervisors.
- iamInstanceProfile:
- allOf:
- - $ref: '#/components/schemas/IamInstanceProfile'
- - description: 'The IAM instance profile associated with the instance, if applicable.'
- instanceLifecycle:
- allOf:
- - $ref: '#/components/schemas/InstanceLifecycleType'
- - description: Indicates whether this is a Spot Instance or a Scheduled Instance.
- elasticGpuAssociationSet:
- allOf:
- - $ref: '#/components/schemas/ElasticGpuAssociationList'
- - description: The Elastic GPU associated with the instance.
- elasticInferenceAcceleratorAssociationSet:
- allOf:
- - $ref: '#/components/schemas/ElasticInferenceAcceleratorAssociationList'
- - description: ' The elastic inference accelerator associated with the instance.'
- networkInterfaceSet:
- allOf:
- - $ref: '#/components/schemas/InstanceNetworkInterfaceList'
- - description: '[EC2-VPC] The network interfaces for the instance.'
- outpostArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the Outpost.
- rootDeviceName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The device name of the root device volume (for example, /dev/sda1).'
- rootDeviceType:
- allOf:
- - $ref: '#/components/schemas/DeviceType'
- - description: The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
- groupSet:
- allOf:
- - $ref: '#/components/schemas/GroupIdentifierList'
- - description: The security groups for the instance.
- sourceDestCheck:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether source/destination checking is enabled.
- spotInstanceRequestId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'If the request is a Spot Instance request, the ID of the request.'
- sriovNetSupport:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
- stateReason:
- allOf:
- - $ref: '#/components/schemas/StateReason'
- - description: The reason for the most recent state transition.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the instance.
- virtualizationType:
- allOf:
- - $ref: '#/components/schemas/VirtualizationType'
- - description: The virtualization type of the instance.
- cpuOptions:
- allOf:
- - $ref: '#/components/schemas/CpuOptions'
- - description: The CPU options for the instance.
- capacityReservationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Capacity Reservation.
- capacityReservationSpecification:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationSpecificationResponse'
- - description: Information about the Capacity Reservation targeting option.
- hibernationOptions:
- allOf:
- - $ref: '#/components/schemas/HibernationOptions'
- - description: Indicates whether the instance is enabled for hibernation.
- licenseSet:
- allOf:
- - $ref: '#/components/schemas/LicenseList'
- - description: The license configurations for the instance.
- metadataOptions:
- allOf:
- - $ref: '#/components/schemas/InstanceMetadataOptionsResponse'
- - description: The metadata options for the instance.
- enclaveOptions:
- allOf:
- - $ref: '#/components/schemas/EnclaveOptions'
- - description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
- bootMode:
- allOf:
- - $ref: '#/components/schemas/BootModeValues'
- - description: 'The boot mode of the instance. For more information, see Boot modes in the Amazon EC2 User Guide.'
- platformDetails:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.'
- usageOperation:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.'
- usageOperationUpdateTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time that the usage operation was last updated.
- privateDnsNameOptions:
- allOf:
- - $ref: '#/components/schemas/PrivateDnsNameOptionsResponse'
- - description: The options for the instance hostname.
- ipv6Address:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 address assigned to the instance.
- tpmSupport:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'If the instance is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.'
- maintenanceOptions:
- allOf:
- - $ref: '#/components/schemas/InstanceMaintenanceOptions'
- - description: Provides information on the recovery and maintenance options of your instance.
- description: Describes an instance.
- InstanceBlockDeviceMapping:
- type: object
- properties:
- deviceName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The device name (for example, /dev/sdh or xvdh).'
- ebs:
- allOf:
- - $ref: '#/components/schemas/EbsInstanceBlockDevice'
- - description: Parameters used to automatically set up EBS volumes when the instance is launched.
- description: Describes a block device mapping.
- InstanceBlockDeviceMappingSpecificationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceBlockDeviceMappingSpecification'
- - xml:
- name: item
- ListingState:
- type: string
- enum:
- - available
- - sold
- - cancelled
- - pending
- InstanceCount:
- type: object
- properties:
- instanceCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of listed Reserved Instances in the state specified by the state.
- state:
- allOf:
- - $ref: '#/components/schemas/ListingState'
- - description: The states of the listed Reserved Instances.
- description: Describes a Reserved Instance listing state.
- InstanceCountList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceCount'
- - xml:
- name: item
- InstanceCreditSpecification:
- type: object
- properties:
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance.
- cpuCredits:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The credit option for CPU usage of the instance. Valid values are standard and unlimited.
- description: 'Describes the credit option for CPU usage of a burstable performance instance. '
- InstanceCreditSpecificationListRequest:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceCreditSpecificationRequest'
- - xml:
- name: item
- InstanceEventId:
- type: string
- InstanceEventWindowTimeRangeList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowTimeRange'
- - xml:
- name: item
- InstanceEventWindowAssociationTarget:
- type: object
- properties:
- instanceIdSet:
- allOf:
- - $ref: '#/components/schemas/InstanceIdList'
- - description: The IDs of the instances associated with the event window.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window.
- dedicatedHostIdSet:
- allOf:
- - $ref: '#/components/schemas/DedicatedHostIdList'
- - description: The IDs of the Dedicated Hosts associated with the event window.
- description: One or more targets associated with the event window.
- InstanceEventWindowState:
- type: string
- enum:
- - creating
- - deleting
- - active
- - deleted
- WeekDay:
- type: string
- enum:
- - sunday
- - monday
- - tuesday
- - wednesday
- - thursday
- - friday
- - saturday
- InstanceEventWindowTimeRange:
- type: object
- properties:
- startWeekDay:
- allOf:
- - $ref: '#/components/schemas/WeekDay'
- - description: The day on which the time range begins.
- startHour:
- allOf:
- - $ref: '#/components/schemas/Hour'
- - description: The hour when the time range begins.
- endWeekDay:
- allOf:
- - $ref: '#/components/schemas/WeekDay'
- - description: The day on which the time range ends.
- endHour:
- allOf:
- - $ref: '#/components/schemas/Hour'
- - description: The hour when the time range ends.
- description: 'The start day and time and the end day and time of the time range, in UTC.'
- InstanceEventWindowTimeRangeRequestSet:
- type: array
- items:
- $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest'
- InstanceGeneration:
- type: string
- enum:
- - current
- - previous
- InstanceGenerationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceGeneration'
- - xml:
- name: item
- InstanceIdSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - xml:
- name: item
- InstanceIpv4Prefix:
- type: object
- properties:
- ipv4Prefix:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: One or more IPv4 prefixes assigned to the network interface.
- description: Information about an IPv4 prefix.
- InstanceIpv4PrefixList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceIpv4Prefix'
- - xml:
- name: item
- InstanceIpv6AddressRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 address.
- description: Describes an IPv6 address.
- InstanceIpv6AddressListRequest:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceIpv6AddressRequest'
- - xml:
- name: InstanceIpv6Address
- InstanceIpv6Prefix:
- type: object
- properties:
- ipv6Prefix:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: One or more IPv6 prefixes assigned to the network interface.
- description: Information about an IPv6 prefix.
- InstanceIpv6PrefixList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceIpv6Prefix'
- - xml:
- name: item
- InstanceList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Instance'
- - xml:
- name: item
- InstanceMaintenanceOptionsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/InstanceAutoRecoveryState'
- - description: 'Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.'
- description: The maintenance options for the instance.
- InstanceMarketOptionsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/SpotMarketOptions'
- - description: The options for Spot Instances.
- description: Describes the market (purchasing) option for the instances.
- InstanceMetadataEndpointState:
- type: string
- enum:
- - disabled
- - enabled
- InstanceMetadataOptionsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/InstanceMetadataTagsState'
- - description: 'Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
The type of network interface.
Valid values: interface | efa | trunk
0, there is no minimum limit.'
- max:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.'
- description: The minimum and maximum number of vCPUs.
- MemoryMiB:
- type: object
- properties:
- min:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.'
- max:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.'
- description: 'The minimum and maximum amount of memory, in MiB.'
- MemoryGiBPerVCpu:
- type: object
- properties:
- min:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: 'The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.'
- max:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: 'The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.'
- description: 'The minimum and maximum amount of memory per vCPU, in GiB.
' - NetworkInterfaceCount: - type: object - properties: - min: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.' - max: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.' - description: The minimum and maximum number of network interfaces. - LocalStorageTypeSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalStorageType' - - xml: - name: item - TotalLocalStorageGB: - type: object - properties: - min: - allOf: - - $ref: '#/components/schemas/Double' - - description: 'The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.' - max: - allOf: - - $ref: '#/components/schemas/Double' - - description: 'The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.' - description: 'The minimum and maximum amount of total local storage, in GB.' - InstanceRequirementsWithMetadataRequest: - type: object - properties: - ArchitectureType: - allOf: - - $ref: '#/components/schemas/ArchitectureTypeSet' - - description: The architecture type. - VirtualizationType: - allOf: - - $ref: '#/components/schemas/InstanceRequirementsRequest' - - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.' - description: 'The architecture type, virtualization type, and other attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadataRequest, you can''t specify InstanceTypes.
running state.
- instanceStatus:
- allOf:
- - $ref: '#/components/schemas/InstanceStatusSummary'
- - description: 'Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.'
- systemStatus:
- allOf:
- - $ref: '#/components/schemas/InstanceStatusSummary'
- - description: 'Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.'
- description: Describes the status of an instance.
- StatusName:
- type: string
- enum:
- - reachability
- StatusType:
- type: string
- enum:
- - passed
- - failed
- - insufficient-data
- - initializing
- InstanceStatusDetails:
- type: object
- properties:
- impairedSince:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.'
- name:
- allOf:
- - $ref: '#/components/schemas/StatusName'
- - description: The type of instance status.
- status:
- allOf:
- - $ref: '#/components/schemas/StatusType'
- - description: The status.
- description: Describes the instance status.
- InstanceStatusDetailsList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InstanceStatusDetails'
- - xml:
- name: item
- InstanceStatusEvent:
- type: object
- properties:
- instanceEventId:
- allOf:
- - $ref: '#/components/schemas/InstanceEventId'
- - description: The ID of the event.
- code:
- allOf:
- - $ref: '#/components/schemas/EventCode'
- - description: The event code.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A description of the event.
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
' - notAfter: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The latest scheduled end time for the event. - notBefore: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The earliest scheduled start time for the event. - notBeforeDeadline: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The deadline for starting the event. - description: Describes a scheduled event for an instance. - SummaryStatus: - type: string - enum: - - ok - - impaired - - insufficient-data - - not-applicable - - initializing - InstanceStorageEncryptionSupport: - type: string - enum: - - unsupported - - required - InstanceStorageFlag: - type: boolean - InstanceStorageInfo: - type: object - properties: - totalSizeInGB: - allOf: - - $ref: '#/components/schemas/DiskSize' - - description: 'The total size of the disks, in GB.' - disks: - allOf: - - $ref: '#/components/schemas/DiskInfoList' - - description: Describes the disks that are available for the instance type. - nvmeSupport: - allOf: - - $ref: '#/components/schemas/EphemeralNvmeSupport' - - description: Indicates whether non-volatile memory express (NVMe) is supported. - encryptionSupport: - allOf: - - $ref: '#/components/schemas/InstanceStorageEncryptionSupport' - - description: Indicates whether data is encrypted at rest. - description: Describes the instance store features that are supported by the instance type. - InstanceTypeHypervisor: - type: string - enum: - - nitro - - xen - UsageClassTypeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/UsageClassType' - - xml: - name: item - RootDeviceTypeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/RootDeviceType' - - xml: - name: item - VirtualizationTypeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VirtualizationType' - - xml: - name: item - ProcessorInfo: - type: object - properties: - supportedArchitectures: - allOf: - - $ref: '#/components/schemas/ArchitectureTypeList' - - description: The architectures supported by the instance type. - sustainedClockSpeedInGhz: - allOf: - - $ref: '#/components/schemas/ProcessorSustainedClockSpeed' - - description: 'The speed of the processor, in GHz.' - description: Describes the processor used by the instance type. - VCpuInfo: - type: object - properties: - defaultVCpus: - allOf: - - $ref: '#/components/schemas/VCpuCount' - - description: The default number of vCPUs for the instance type. - defaultCores: - allOf: - - $ref: '#/components/schemas/CoreCount' - - description: The default number of cores for the instance type. - defaultThreadsPerCore: - allOf: - - $ref: '#/components/schemas/ThreadsPerCore' - - description: The default number of threads per core for the instance type. - validCores: - allOf: - - $ref: '#/components/schemas/CoreCountList' - - description: The valid number of cores that can be configured for the instance type. - validThreadsPerCore: - allOf: - - $ref: '#/components/schemas/ThreadsPerCoreList' - - description: 'The valid number of threads per core that can be configured for the instance type. ' - description: Describes the vCPU configurations for the instance type. - MemoryInfo: - type: object - properties: - sizeInMiB: - allOf: - - $ref: '#/components/schemas/MemorySize' - - description: 'The size of the memory, in MiB.' - description: Describes the memory for the instance type. - NetworkInfo: - type: object - properties: - networkPerformance: - allOf: - - $ref: '#/components/schemas/NetworkPerformance' - - description: The network performance. - maximumNetworkInterfaces: - allOf: - - $ref: '#/components/schemas/MaxNetworkInterfaces' - - description: The maximum number of network interfaces for the instance type. - maximumNetworkCards: - allOf: - - $ref: '#/components/schemas/MaximumNetworkCards' - - description: The maximum number of physical network cards that can be allocated to the instance. - defaultNetworkCardIndex: - allOf: - - $ref: '#/components/schemas/DefaultNetworkCardIndex' - - description: 'The index of the default network card, starting at 0.' - networkCards: - allOf: - - $ref: '#/components/schemas/NetworkCardInfoList' - - description: Describes the network cards for the instance type. - ipv4AddressesPerInterface: - allOf: - - $ref: '#/components/schemas/MaxIpv4AddrPerInterface' - - description: The maximum number of IPv4 addresses per network interface. - ipv6AddressesPerInterface: - allOf: - - $ref: '#/components/schemas/MaxIpv6AddrPerInterface' - - description: The maximum number of IPv6 addresses per network interface. - ipv6Supported: - allOf: - - $ref: '#/components/schemas/Ipv6Flag' - - description: Indicates whether IPv6 is supported. - enaSupport: - allOf: - - $ref: '#/components/schemas/EnaSupport' - - description: Indicates whether Elastic Network Adapter (ENA) is supported. - efaSupported: - allOf: - - $ref: '#/components/schemas/EfaSupportedFlag' - - description: Indicates whether Elastic Fabric Adapter (EFA) is supported. - efaInfo: - allOf: - - $ref: '#/components/schemas/EfaInfo' - - description: Describes the Elastic Fabric Adapters for the instance type. - encryptionInTransitSupported: - allOf: - - $ref: '#/components/schemas/EncryptionInTransitSupported' - - description: Indicates whether the instance type automatically encrypts in-transit traffic between instances. - description: Describes the networking features of the instance type. - PlacementGroupInfo: - type: object - properties: - supportedStrategies: - allOf: - - $ref: '#/components/schemas/PlacementGroupStrategyList' - - description: The supported placement group types. - description: Describes the placement group support of the instance type. - InstanceTypeInfo: - type: object - properties: - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.' - currentGeneration: - allOf: - - $ref: '#/components/schemas/CurrentGenerationFlag' - - description: Indicates whether the instance type is current generation. - freeTierEligible: - allOf: - - $ref: '#/components/schemas/FreeTierEligibleFlag' - - description: Indicates whether the instance type is eligible for the free tier. - supportedUsageClasses: - allOf: - - $ref: '#/components/schemas/UsageClassTypeList' - - description: Indicates whether the instance type is offered for spot or On-Demand. - supportedRootDeviceTypes: - allOf: - - $ref: '#/components/schemas/RootDeviceTypeList' - - description: The supported root device types. - supportedVirtualizationTypes: - allOf: - - $ref: '#/components/schemas/VirtualizationTypeList' - - description: The supported virtualization types. - bareMetal: - allOf: - - $ref: '#/components/schemas/BareMetalFlag' - - description: Indicates whether the instance is a bare metal instance type. - hypervisor: - allOf: - - $ref: '#/components/schemas/InstanceTypeHypervisor' - - description: The hypervisor for the instance type. - processorInfo: - allOf: - - $ref: '#/components/schemas/ProcessorInfo' - - description: Describes the processor. - vCpuInfo: - allOf: - - $ref: '#/components/schemas/VCpuInfo' - - description: Describes the vCPU configurations for the instance type. - memoryInfo: - allOf: - - $ref: '#/components/schemas/MemoryInfo' - - description: Describes the memory for the instance type. - instanceStorageSupported: - allOf: - - $ref: '#/components/schemas/InstanceStorageFlag' - - description: Indicates whether instance storage is supported. - instanceStorageInfo: - allOf: - - $ref: '#/components/schemas/InstanceStorageInfo' - - description: Describes the instance storage for the instance type. - ebsInfo: - allOf: - - $ref: '#/components/schemas/EbsInfo' - - description: Describes the Amazon EBS settings for the instance type. - networkInfo: - allOf: - - $ref: '#/components/schemas/NetworkInfo' - - description: Describes the network settings for the instance type. - gpuInfo: - allOf: - - $ref: '#/components/schemas/GpuInfo' - - description: Describes the GPU accelerator settings for the instance type. - fpgaInfo: - allOf: - - $ref: '#/components/schemas/FpgaInfo' - - description: Describes the FPGA accelerator settings for the instance type. - placementGroupInfo: - allOf: - - $ref: '#/components/schemas/PlacementGroupInfo' - - description: Describes the placement group settings for the instance type. - inferenceAcceleratorInfo: - allOf: - - $ref: '#/components/schemas/InferenceAcceleratorInfo' - - description: Describes the Inference accelerator settings for the instance type. - hibernationSupported: - allOf: - - $ref: '#/components/schemas/HibernationFlag' - - description: Indicates whether On-Demand hibernation is supported. - burstablePerformanceSupported: - allOf: - - $ref: '#/components/schemas/BurstablePerformanceFlag' - - description: Indicates whether the instance type is a burstable performance instance type. - dedicatedHostsSupported: - allOf: - - $ref: '#/components/schemas/DedicatedHostFlag' - - description: Indicates whether Dedicated Hosts are supported on the instance type. - autoRecoverySupported: - allOf: - - $ref: '#/components/schemas/AutoRecoveryFlag' - - description: Indicates whether auto recovery is supported. - supportedBootModes: - allOf: - - $ref: '#/components/schemas/BootModeTypeList' - - description: 'The supported boot modes. For more information, see Boot modes in the Amazon EC2 User Guide.' - description: Describes the instance type. - InstanceTypeInfoFromInstanceRequirements: - type: object - properties: - instanceType: - allOf: - - $ref: '#/components/schemas/String' - - description: The matching instance type. - description: The list of instance types with the specified instance attributes. - Location: - type: string - InstanceTypeOffering: - type: object - properties: - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.' - locationType: - allOf: - - $ref: '#/components/schemas/LocationType' - - description: The location type. - location: - allOf: - - $ref: '#/components/schemas/Location' - - description: 'The identifier for the location. This depends on the location type. For example, if the location type isregion, the location is the Region code (for example, us-east-2.)'
- description: The instance types offered.
- InstanceTypes:
- type: array
- items:
- $ref: '#/components/schemas/String'
- minItems: 0
- maxItems: 1000
- InstanceUsage:
- type: object
- properties:
- accountId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that is making use of the Capacity Reservation.
- usedInstanceCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of instances the Amazon Web Services account currently has in the Capacity Reservation.
- description: Information about the Capacity Reservation usage.
- InterfacePermissionType:
- type: string
- enum:
- - INSTANCE-ATTACH
- - EIP-ASSOCIATE
- InterfaceProtocolType:
- type: string
- enum:
- - VLAN
- - GRE
- InternetGatewayAttachment:
- type: object
- properties:
- state:
- allOf:
- - $ref: '#/components/schemas/AttachmentStatus'
- - description: 'The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.'
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- description: Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
- InternetGatewayIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/InternetGatewayId'
- - xml:
- name: item
- IpAddressType:
- type: string
- enum:
- - ipv4
- - dualstack
- - ipv6
- IpRangeList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/IpRange'
- - xml:
- name: item
- Ipv6RangeList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv6Range'
- - xml:
- name: item
- PrefixListIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PrefixListId'
- - xml:
- name: item
- UserIdGroupPairList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/UserIdGroupPair'
- - xml:
- name: item
- IpRange:
- type: object
- properties:
- cidrIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.'
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' - description: Describes an IPv4 range. - IpRanges: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - IpamId: - type: string - IpamOperatingRegionSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpamOperatingRegion' - - xml: - name: item - IpamState: - type: string - enum: - - create-in-progress - - create-complete - - create-failed - - modify-in-progress - - modify-complete - - modify-failed - - delete-in-progress - - delete-complete - - delete-failed - - isolate-in-progress - - isolate-complete - - restore-in-progress - IpamAddressHistoryMaxResults: - type: integer - minimum: 1 - maximum: 1000 - IpamAddressHistoryResourceType: - type: string - enum: - - eip - - vpc - - subnet - - network-interface - - instance - IpamComplianceStatus: - type: string - enum: - - compliant - - noncompliant - - unmanaged - - ignored - IpamOverlapStatus: - type: string - enum: - - overlapping - - nonoverlapping - - ignored - IpamAddressHistoryRecord: - type: object - properties: - resourceOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource owner. - resourceRegion: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services Region of the resource. - resourceType: - allOf: - - $ref: '#/components/schemas/IpamAddressHistoryResourceType' - - description: The type of the resource. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR of the resource. - resourceName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the resource. - resourceComplianceStatus: - allOf: - - $ref: '#/components/schemas/IpamComplianceStatus' - - description: 'The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' - resourceOverlapStatus: - allOf: - - $ref: '#/components/schemas/IpamOverlapStatus' - - description: 'The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The VPC ID of the resource. - sampledStartTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: 'Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.' - sampledEndTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: 'Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.' - description: 'The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide. ' - IpamCidrAuthorizationContext: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The signed authorization message for the prefix and account. - description: A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. - IpamManagementState: - type: string - enum: - - managed - - unmanaged - - ignored - IpamMaxResults: - type: integer - minimum: 5 - maximum: 1000 - IpamOperatingRegion: - type: object - properties: - regionName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the operating Region. - description: 'The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' - IpamScopeType: - type: string - enum: - - public - - private - IpamPoolState: - type: string - enum: - - create-in-progress - - create-complete - - create-failed - - modify-in-progress - - modify-complete - - modify-failed - - delete-in-progress - - delete-complete - - delete-failed - - isolate-in-progress - - isolate-complete - - restore-in-progress - IpamResourceTagList: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpamResourceTag' - - xml: - name: item - IpamPoolAllocationResourceType: - type: string - enum: - - ipam-pool - - vpc - - ec2-public-ipv4-pool - - custom - IpamPoolCidrState: - type: string - enum: - - pending-provision - - provisioned - - failed-provision - - pending-deprovision - - deprovisioned - - failed-deprovision - - pending-import - - failed-import - IpamPoolCidrFailureReason: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/IpamPoolCidrFailureCode' - - description: An error code related to why an IPAM pool CIDR failed to be provisioned. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: A message related to why an IPAM pool CIDR failed to be provisioned. - description: Details related to why an IPAM pool CIDR failed to be provisioned. - IpamPoolCidrFailureCode: - type: string - enum: - - cidr-not-available - IpamResourceType: - type: string - enum: - - vpc - - subnet - - eip - - public-ipv4-pool - - ipv6-pool - IpamResourceCidr: - type: object - properties: - ipamId: - allOf: - - $ref: '#/components/schemas/IpamId' - - description: The IPAM ID for an IPAM resource. - ipamScopeId: - allOf: - - $ref: '#/components/schemas/IpamScopeId' - - description: The scope ID for an IPAM resource. - ipamPoolId: - allOf: - - $ref: '#/components/schemas/IpamPoolId' - - description: The pool ID for an IPAM resource. - resourceRegion: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services Region for an IPAM resource. - resourceOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account number of the owner of an IPAM resource. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of an IPAM resource. - resourceName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of an IPAM resource. - resourceCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR for an IPAM resource. - resourceType: - allOf: - - $ref: '#/components/schemas/IpamResourceType' - - description: The type of IPAM resource. - resourceTagSet: - allOf: - - $ref: '#/components/schemas/IpamResourceTagList' - - description: The tags for an IPAM resource. - ipUsage: - allOf: - - $ref: '#/components/schemas/BoxedDouble' - - description: 'The IP address space in the IPAM pool that is allocated to this resource. To convert the decimal to a percentage, multiply the decimal by 100.' - complianceStatus: - allOf: - - $ref: '#/components/schemas/IpamComplianceStatus' - - description: 'The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' - managementState: - allOf: - - $ref: '#/components/schemas/IpamManagementState' - - description: 'The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' - overlapStatus: - allOf: - - $ref: '#/components/schemas/IpamOverlapStatus' - - description: 'The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of a VPC. - description: The CIDR for an IPAM resource. - IpamResourceTag: - type: object - properties: - key: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.' - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The value of the tag. - description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
- IpamScopeState:
- type: string
- enum:
- - create-in-progress
- - create-complete
- - create-failed
- - modify-in-progress
- - modify-complete
- - modify-failed
- - delete-in-progress
- - delete-complete
- - delete-failed
- - isolate-in-progress
- - isolate-complete
- - restore-in-progress
- Ipv4PrefixList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv4PrefixSpecificationRequest'
- - xml:
- name: item
- Ipv4PrefixSpecificationResponse:
- type: object
- properties:
- ipv4Prefix:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: One or more IPv4 delegated prefixes assigned to the network interface.
- description: Information about the IPv4 delegated prefixes assigned to a network interface.
- Ipv4PrefixListResponse:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv4PrefixSpecificationResponse'
- - xml:
- name: item
- Ipv4PrefixSpecification:
- type: object
- properties:
- ipv4Prefix:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.'
- description: Describes an IPv4 prefix.
- Ipv6Address:
- type: string
- Ipv6CidrAssociation:
- type: object
- properties:
- ipv6Cidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 CIDR block.
- associatedResource:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The resource that's associated with the IPv6 CIDR block.
- description: Describes an IPv6 CIDR block association.
- Ipv6CidrBlock:
- type: object
- properties:
- ipv6CidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 CIDR block.
- description: Describes an IPv6 CIDR block.
- Ipv6CidrBlockSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv6CidrBlock'
- - xml:
- name: item
- Ipv6Flag:
- type: boolean
- PoolCidrBlocksSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PoolCidrBlock'
- - xml:
- name: item
- Ipv6Pool:
- type: object
- properties:
- poolId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the address pool.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description for the address pool.
- poolCidrBlockSet:
- allOf:
- - $ref: '#/components/schemas/PoolCidrBlocksSet'
- - description: The CIDR blocks for the address pool.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags for the address pool.
- description: Describes an IPv6 address pool.
- Ipv6PoolIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv6PoolEc2Id'
- - xml:
- name: item
- Ipv6PoolMaxResults:
- type: integer
- minimum: 1
- maximum: 1000
- Ipv6PrefixList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv6PrefixSpecificationRequest'
- - xml:
- name: item
- Ipv6PrefixSpecificationResponse:
- type: object
- properties:
- ipv6Prefix:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: One or more IPv6 delegated prefixes assigned to the network interface.
- description: Information about the IPv6 delegated prefixes assigned to a network interface.
- Ipv6PrefixListResponse:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv6PrefixSpecificationResponse'
- - xml:
- name: item
- Ipv6PrefixSpecification:
- type: object
- properties:
- ipv6Prefix:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 prefix.
- description: Describes the IPv6 prefix.
- Ipv6PrefixesList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv6PrefixSpecification'
- - xml:
- name: item
- Ipv6Range:
- type: object
- properties:
- cidrIpv6:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.'
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' - description: '[EC2-VPC only] Describes an IPv6 range.' - Ipv6SupportValue: - type: string - enum: - - enable - - disable - SensitiveUserData: - type: string - format: password - KeyPairInfo: - type: object - properties: - keyPairId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the key pair. - keyFingerprint: - allOf: - - $ref: '#/components/schemas/String' - - description: 'If you used CreateKeyPair to create the key pair:
For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
If you used ImportKeyPair to provide Amazon Web Services the public key:
For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone.
If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone.
' - description: Describes a key pair. - LastError: - type: object - properties: - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The error message for the VPC endpoint error. - code: - allOf: - - $ref: '#/components/schemas/String' - - description: The error code for the VPC endpoint error. - description: The last error that occurred for a VPC endpoint. - LaunchPermission: - type: object - properties: - group: - allOf: - - $ref: '#/components/schemas/PermissionGroup' - - description: The name of the group. - userId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The Amazon Web Services account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
' - organizationArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of an organization. - organizationalUnitArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of an organizational unit (OU). - description: Describes a launch permission. - LaunchPermissionModifications: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchPermissionList' - - description: 'The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.' - description: Describes a launch permission modification. - LaunchSpecification: - type: object - properties: - userData: - allOf: - - $ref: '#/components/schemas/String' - - description: The Base64-encoded user data for the instance. - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdentifierList' - - description: 'One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.' - addressingType: - allOf: - - $ref: '#/components/schemas/String' - - description: Deprecated. - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/BlockDeviceMappingList' - - description: One or more block device mapping entries. - ebsOptimized: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.
WeightedCapacity.'
- subnetId:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - description: 'The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".'
- userData:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Base64-encoded user data that instances use when starting up.
- weightedCapacity:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: 'The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
' - tagSpecificationSet: - allOf: - - $ref: '#/components/schemas/SpotFleetTagSpecificationList' - - description: The tags to apply during creation. - instanceRequirements: - allOf: - - $ref: '#/components/schemas/InstanceRequirements' - - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can''t specify InstanceTypes.
SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.'
- LaunchTemplateAutoRecoveryState:
- type: string
- enum:
- - default
- - disabled
- LaunchTemplateEbsBlockDevice:
- type: object
- properties:
- encrypted:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the EBS volume is encrypted.
- deleteOnTermination:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the EBS volume is deleted on instance termination.
- iops:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The number of I/O operations per second (IOPS) that the volume supports. '
- kmsKeyId:
- allOf:
- - $ref: '#/components/schemas/KmsKeyId'
- - description: The ARN of the Key Management Service (KMS) CMK used for encryption.
- snapshotId:
- allOf:
- - $ref: '#/components/schemas/SnapshotId'
- - description: The ID of the snapshot.
- volumeSize:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The size of the volume, in GiB.'
- volumeType:
- allOf:
- - $ref: '#/components/schemas/VolumeType'
- - description: The volume type.
- throughput:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The throughput that the volume supports, in MiB/s.'
- description: Describes a block device for an EBS volume.
- LaunchTemplateBlockDeviceMapping:
- type: object
- properties:
- deviceName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The device name.
- virtualName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The virtual device name (ephemeralN).
- ebs:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateEbsBlockDevice'
- - description: Information about the block device for an EBS volume.
- noDevice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'To omit the device from the block device mapping, specify an empty string.'
- description: Describes a block device mapping.
- LaunchTemplateBlockDeviceMappingList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMapping'
- - xml:
- name: item
- LaunchTemplateBlockDeviceMappingRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'To omit the device from the block device mapping, specify an empty string.'
- description: Describes a block device mapping.
- LaunchTemplateCapacityReservationSpecificationResponse:
- type: object
- properties:
- capacityReservationPreference:
- allOf:
- - $ref: '#/components/schemas/CapacityReservationPreference'
- - description: 'Indicates the instance''s Capacity Reservation preferences. Possible preferences include:
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
' - description: The parameters for a block device for an EBS volume. - LaunchTemplateElasticInferenceAcceleratorCount: - type: integer - minimum: 1 - LaunchTemplateElasticInferenceAccelerator: - type: object - required: - - Type - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorCount' - - description: 'The number of elastic inference accelerators to attach to the instance.
Default: 1
' - description: ' Describes an elastic inference accelerator. ' - LaunchTemplateElasticInferenceAcceleratorResponse: - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/String' - - description: ' The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. ' - count: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of elastic inference accelerators to attach to the instance.
Default: 1
' - description: ' Describes an elastic inference accelerator. ' - LaunchTemplateElasticInferenceAcceleratorResponseList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorResponse' - - xml: - name: item - LaunchTemplateEnclaveOptions: - type: object - properties: - enabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If this parameter is set totrue, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.'
- description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
- LaunchTemplateEnclaveOptionsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.'
- description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.'
- LaunchTemplateErrorCode:
- type: string
- enum:
- - launchTemplateIdDoesNotExist
- - launchTemplateIdMalformed
- - launchTemplateNameDoesNotExist
- - launchTemplateNameMalformed
- - launchTemplateVersionDoesNotExist
- - unexpectedError
- LaunchTemplateHibernationOptions:
- type: object
- properties:
- configured:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.'
- description: Indicates whether an instance is configured for hibernation.
- LaunchTemplateHibernationOptionsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If you set this parameter to true, the instance is enabled for hibernation.
Default: false
terminate.
- description: The options for Spot Instances.
- LaunchTemplateInstanceMarketOptionsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateSpotMarketOptionsRequest'
- - description: The options for Spot Instances.
- description: The market (purchasing) option for the instances.
- LaunchTemplateInstanceMetadataEndpointState:
- type: string
- enum:
- - disabled
- - enabled
- LaunchTemplateInstanceMetadataOptionsState:
- type: string
- enum:
- - pending
- - applied
- LaunchTemplateInstanceMetadataProtocolIpv6:
- type: string
- enum:
- - disabled
- - enabled
- LaunchTemplateInstanceMetadataTagsState:
- type: string
- enum:
- - disabled
- - enabled
- LaunchTemplateInstanceMetadataOptions:
- type: object
- properties:
- state:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataOptionsState'
- - description: The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
' - httpEndpoint: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataEndpointState' - - description: 'Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
Enables or disables the IPv6 endpoint for the instance metadata service.
Default: disabled
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide.
' - associatePublicIpAddress: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to associate a public IPv4 address with eth0 for a new network interface. - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the network interface is deleted when the instance is terminated. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description for the network interface. - deviceIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The device index for the network interface attachment. - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdStringList' - - description: The IDs of one or more security groups. - interfaceType: - allOf: - - $ref: '#/components/schemas/String' - - description: The type of network interface. - ipv6AddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv6 addresses for the network interface. - ipv6AddressesSet: - allOf: - - $ref: '#/components/schemas/InstanceIpv6AddressList' - - description: The IPv6 addresses for the network interface. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of the network interface. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The primary private IPv4 address of the network interface. - privateIpAddressesSet: - allOf: - - $ref: '#/components/schemas/PrivateIpAddressSpecificationList' - - description: One or more private IPv4 addresses. - secondaryPrivateIpAddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of secondary private IPv4 addresses for the network interface. - subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The ID of the subnet for the network interface. - networkCardIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The index of the network card. - ipv4PrefixSet: - allOf: - - $ref: '#/components/schemas/Ipv4PrefixListResponse' - - description: One or more IPv4 prefixes assigned to the network interface. - ipv4PrefixCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface. - ipv6PrefixSet: - allOf: - - $ref: '#/components/schemas/Ipv6PrefixListResponse' - - description: One or more IPv6 prefixes assigned to the network interface. - ipv6PrefixCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface. - description: Describes a network interface. - LaunchTemplateInstanceNetworkInterfaceSpecificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecification' - - xml: - name: item - LaunchTemplateInstanceNetworkInterfaceSpecificationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The device index for the network interface attachment. - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0. - Ipv4Prefix: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use theIpv4Prefix option.
- Ipv6Prefix:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
- description: The parameters for a network interface.
- LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecificationRequest'
- - xml:
- name: InstanceNetworkInterfaceSpecification
- LaunchTemplateLicenseConfiguration:
- type: object
- properties:
- licenseConfigurationArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the license configuration.
- description: Describes a license configuration.
- LaunchTemplateLicenseConfigurationRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the license configuration.
- description: Describes a license configuration.
- LaunchTemplateLicenseList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateLicenseConfiguration'
- - xml:
- name: item
- LaunchTemplateLicenseSpecificationListRequest:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateLicenseConfigurationRequest'
- - xml:
- name: item
- LaunchTemplateOverrides:
- type: object
- properties:
- instanceType:
- allOf:
- - $ref: '#/components/schemas/InstanceType'
- - description: The instance type.
- spotPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The maximum price per unit hour that you are willing to pay for a Spot Instance.
- subnetId:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - description: The ID of the subnet in which to launch the instances.
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone in which to launch the instances.
- weightedCapacity:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: The number of units provided by the specified instance type.
- priority:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: 'The priority for the launch template override. The highest priority is launched first.
If OnDemandAllocationStrategy is set to prioritized, Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types.
If you specify InstanceRequirements, you can''t specify InstanceTypes.
dedicated runs on single-tenant hardware. '
- spreadDomain:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Reserved for future use.
- hostResourceGroupArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ARN of the host resource group in which to launch the instances. '
- partitionNumber:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
- description: Describes the placement of an instance.
- LaunchTemplatePlacementRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
- description: Describes the placement of an instance.
- LaunchTemplatePrivateDnsNameOptions:
- type: object
- properties:
- hostnameType:
- allOf:
- - $ref: '#/components/schemas/HostnameType'
- - description: The type of hostname to assign to an instance.
- enableResourceNameDnsARecord:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
- enableResourceNameDnsAAAARecord:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
- description: Describes the options for instance hostnames.
- LaunchTemplatePrivateDnsNameOptionsRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
- description: Describes the options for instance hostnames.
- LaunchTemplateSpecification:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The version number of the launch template.
Default: The default version for the launch template.
' - description: 'The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.' - SpotInstanceType: - type: string - enum: - - one-time - - persistent - ResourceType: - type: string - enum: - - capacity-reservation - - client-vpn-endpoint - - customer-gateway - - carrier-gateway - - dedicated-host - - dhcp-options - - egress-only-internet-gateway - - elastic-ip - - elastic-gpu - - export-image-task - - export-instance-task - - fleet - - fpga-image - - host-reservation - - image - - import-image-task - - import-snapshot-task - - instance - - instance-event-window - - internet-gateway - - ipam - - ipam-pool - - ipam-scope - - ipv4pool-ec2 - - ipv6pool-ec2 - - key-pair - - launch-template - - local-gateway - - local-gateway-route-table - - local-gateway-virtual-interface - - local-gateway-virtual-interface-group - - local-gateway-route-table-vpc-association - - local-gateway-route-table-virtual-interface-group-association - - natgateway - - network-acl - - network-interface - - network-insights-analysis - - network-insights-path - - network-insights-access-scope - - network-insights-access-scope-analysis - - placement-group - - prefix-list - - replace-root-volume-task - - reserved-instances - - route-table - - security-group - - security-group-rule - - snapshot - - spot-fleet-request - - spot-instances-request - - subnet - - subnet-cidr-reservation - - traffic-mirror-filter - - traffic-mirror-session - - traffic-mirror-target - - transit-gateway - - transit-gateway-attachment - - transit-gateway-connect-peer - - transit-gateway-multicast-domain - - transit-gateway-route-table - - volume - - vpc - - vpc-endpoint - - vpc-endpoint-service - - vpc-peering-connection - - vpn-connection - - vpn-gateway - - vpc-flow-log - LaunchTemplateTagSpecification: - type: object - properties: - resourceType: - allOf: - - $ref: '#/components/schemas/ResourceType' - - description: The type of resource. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the resource. - description: The tag specification for the launch template. - LaunchTemplateTagSpecificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateTagSpecification' - - xml: - name: item - LaunchTemplateTagSpecificationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ResourceType' - - description: 'The type of resource to tag. Currently, the resource types that support tagging on creation areinstance, volume, elastic-gpu, network-interface, and spot-instances-request. To tag a resource after it has been created, see CreateTags.'
- Tag:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags to apply to the resource.
- description: The tags specification for the launch template.
- VersionDescription:
- type: string
- minLength: 0
- maxLength: 255
- LaunchTemplatesMonitoring:
- type: object
- properties:
- enabled:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.'
- description: Describes the monitoring for the instance.
- LaunchTemplatesMonitoringRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.'
- description: Describes the monitoring for the instance.
- LicenseConfiguration:
- type: object
- properties:
- licenseConfigurationArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the license configuration.
- description: Describes a license configuration.
- LicenseSpecificationListRequest:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LicenseConfigurationRequest'
- - xml:
- name: item
- ListImagesInRecycleBinMaxResults:
- type: integer
- minimum: 1
- maximum: 1000
- ListImagesInRecycleBinRequest:
- type: object
- title: ListImagesInRecycleBinRequest
- properties:
- ImageId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ListSnapshotsInRecycleBinMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- ListSnapshotsInRecycleBinRequest:
- type: object
- title: ListSnapshotsInRecycleBinRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The token for the next page of results.
- SnapshotId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SnapshotRecycleBinInfoList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SnapshotRecycleBinInfo'
- - xml:
- name: item
- ListingStatus:
- type: string
- enum:
- - active
- - pending
- - cancelled
- - closed
- TargetGroupsConfig:
- type: object
- properties:
- targetGroups:
- allOf:
- - $ref: '#/components/schemas/TargetGroups'
- - description: One or more target groups.
- description: Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups.
- LoadPermission:
- type: object
- properties:
- userId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID.
- group:
- allOf:
- - $ref: '#/components/schemas/PermissionGroup'
- - description: The name of the group.
- description: Describes a load permission.
- LoadPermissionRequest:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID.
- description: Describes a load permission.
- LoadPermissionModifications:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/LoadPermissionListRequest'
- - description: The load permissions to remove.
- description: Describes modifications to the load permissions of an Amazon FPGA image (AFI).
- LocalGateway:
- type: object
- properties:
- localGatewayId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayId'
- - description: The ID of the local gateway.
- outpostArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the Outpost.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the local gateway.
- state:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The state of the local gateway.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the local gateway.
- description: Describes a local gateway.
- LocalGatewayMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- LocalGatewayRouteType:
- type: string
- enum:
- - static
- - propagated
- LocalGatewayRouteState:
- type: string
- enum:
- - pending
- - active
- - blackhole
- - deleting
- - deleted
- LocalGatewayRouteList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRoute'
- - xml:
- name: item
- LocalGatewayRouteTable:
- type: object
- properties:
- localGatewayRouteTableId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the local gateway route table.
- localGatewayRouteTableArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The Amazon Resource Name (ARN) of the local gateway route table.
- localGatewayId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayId'
- - description: The ID of the local gateway.
- outpostArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the Outpost.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the local gateway route table.
- state:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The state of the local gateway route table.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the local gateway route table.
- description: Describes a local gateway route table.
- LocalGatewayRouteTableVirtualInterfaceGroupAssociation:
- type: object
- properties:
- localGatewayRouteTableVirtualInterfaceGroupAssociationId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId'
- - description: The ID of the association.
- localGatewayVirtualInterfaceGroupId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
- - description: The ID of the virtual interface group.
- localGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the local gateway.
- localGatewayRouteTableId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayId'
- - description: The ID of the local gateway route table.
- localGatewayRouteTableArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
- state:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The state of the association.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the association.
- description: Describes an association between a local gateway route table and a virtual interface group.
- LocalGatewayVirtualInterface:
- type: object
- properties:
- localGatewayVirtualInterfaceId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceId'
- - description: The ID of the virtual interface.
- localGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the local gateway.
- vlan:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The ID of the VLAN.
- localAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The local address.
- peerAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The peer address.
- localBgpAsn:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
- peerBgpAsn:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The peer BGP ASN.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the local gateway virtual interface.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the virtual interface.
- description: Describes a local gateway virtual interface.
- LocalGatewayVirtualInterfaceGroup:
- type: object
- properties:
- localGatewayVirtualInterfaceGroupId:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
- - description: The ID of the virtual interface group.
- localGatewayVirtualInterfaceIdSet:
- allOf:
- - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceIdSet'
- - description: The IDs of the virtual interfaces.
- localGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the local gateway.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags assigned to the virtual interface group.
- description: Describes a local gateway virtual interface group.
- LocalStorageType:
- type: string
- enum:
- - hdd
- - ssd
- PrefixListState:
- type: string
- enum:
- - create-in-progress
- - create-complete
- - create-failed
- - modify-in-progress
- - modify-complete
- - modify-failed
- - restore-in-progress
- - restore-complete
- - restore-failed
- - delete-in-progress
- - delete-complete
- - delete-failed
- MaxIpv4AddrPerInterface:
- type: integer
- MaxIpv6AddrPerInterface:
- type: integer
- MaxNetworkInterfaces:
- type: integer
- MaxResults:
- type: integer
- MaximumNetworkCards:
- type: integer
- MembershipType:
- type: string
- enum:
- - static
- - igmp
- MemorySize:
- type: integer
- ModifyAddressAttributeRequest:
- type: object
- required:
- - AllocationId
- title: ModifyAddressAttributeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyAvailabilityZoneGroupRequest:
- type: object
- required:
- - GroupName
- - OptInStatus
- title: ModifyAvailabilityZoneGroupRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyAvailabilityZoneOptInStatus:
- type: string
- enum:
- - opted-in
- - not-opted-in
- ModifyCapacityReservationFleetRequest:
- type: object
- required:
- - CapacityReservationFleetId
- title: ModifyCapacityReservationFleetRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the CancelCapacityReservationFleet action.
You can''t specify RemoveEndDate and EndDate in the same request.
' - ModifyCapacityReservationRequest: - type: object - required: - - CapacityReservationId - title: ModifyCapacityReservationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved for future use. - ModifyClientVpnEndpointRequest: - type: object - required: - - ClientVpnEndpointId - title: ModifyClientVpnEndpointRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SecurityGroupId:
- allOf:
- - $ref: '#/components/schemas/ClientLoginBannerOptions'
- - description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
- ModifyDefaultCreditSpecificationRequest:
- type: object
- required:
- - InstanceFamily
- - CpuCredits
- title: ModifyDefaultCreditSpecificationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The credit option for CPU usage of the instance family.
Valid Values: standard | unlimited
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyFleetRequest:
- type: object
- required:
- - FleetId
- title: ModifyFleetRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/FleetExcessCapacityTerminationPolicy'
- - description: Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
- LaunchTemplateConfig:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Reserved.
- OperationType:
- type: string
- enum:
- - add
- - remove
- UserIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: UserId
- UserGroupStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: UserGroup
- ModifyFpgaImageAttributeRequest:
- type: object
- required:
- - FpgaImageId
- title: ModifyFpgaImageAttributeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/OperationType'
- - description: The operation type.
- UserId:
- allOf:
- - $ref: '#/components/schemas/UserIdStringList'
- - description: The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.
- UserGroup:
- allOf:
- - $ref: '#/components/schemas/UserGroupStringList'
- - description: The user groups. This parameter is valid only when modifying the loadPermission attribute.
- ProductCode:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A name for the AFI.
- ModifyHostsRequest:
- type: object
- required:
- - HostIds
- title: ModifyHostsRequest
- properties:
- autoPlacement:
- allOf:
- - $ref: '#/components/schemas/AutoPlacement'
- - description: Specify whether to enable or disable auto-placement.
- hostId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.
If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
' - UnsuccessfulItemList: - type: array - items: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItem' - - xml: - name: item - ModifyIdFormatRequest: - type: object - required: - - Resource - - UseLongIds - title: ModifyIdFormatRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicate whether the resource should use longer IDs (17-character IDs). - ModifyIdentityIdFormatRequest: - type: object - required: - - PrincipalArn - - Resource - - UseLongIds - title: ModifyIdentityIdFormatRequest - properties: - principalArn: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specifyall to modify the ID format for all IAM users, IAM roles, and the root user of the account.'
- resource:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
Attribute parameter is launchPermission.
- ProductCode:
- allOf:
- - $ref: '#/components/schemas/ProductCodeStringList'
- - description: Not supported.
- UserGroup:
- allOf:
- - $ref: '#/components/schemas/UserGroupStringList'
- - description: The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
- UserId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- OrganizationArn:
- allOf:
- - $ref: '#/components/schemas/OrganizationArnStringList'
- - description: The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
- OrganizationalUnitArn:
- allOf:
- - $ref: '#/components/schemas/OrganizationalUnitArnStringList'
- - description: The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
- description: Contains the parameters for ModifyImageAttribute.
- ModifyInstanceAttributeRequest:
- type: object
- required:
- - InstanceId
- title: ModifyInstanceAttributeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
- attribute:
- allOf:
- - $ref: '#/components/schemas/InstanceAttributeName'
- - description: The name of the attribute.
- blockDeviceMapping:
- allOf:
- - $ref: '#/components/schemas/InstanceBlockDeviceMappingSpecificationList'
- - description: 'Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.
' - disableApiTermination: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: 'If the value istrue, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.'
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ebsOptimized:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
- enaSupport:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: Set to true to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
- GroupId: - allOf: - - $ref: '#/components/schemas/GroupIdStringList' - - description: '[EC2-VPC] Replaces the security groups of the instance with the specified security groups. You must specify at least one security group, even if it''s just the default security group for the VPC. You must specify the security group ID, not the security group name.' - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance. - instanceInitiatedShutdownBehavior: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). - instanceType: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: 'Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned isInvalidInstanceAttributeValue.'
- kernel:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: 'Changes the instance''s kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.'
- ramdisk:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: 'Changes the instance''s RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.'
- sriovNetSupport:
- allOf:
- - $ref: '#/components/schemas/AttributeValue'
- - description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
- userData: - allOf: - - $ref: '#/components/schemas/BlobAttributeValue' - - description: 'Changes the instance''s user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.' - value: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A new value for the attribute. Use only with thekernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.'
- ModifyInstanceCapacityReservationAttributesRequest:
- type: object
- required:
- - InstanceId
- - CapacityReservationSpecification
- title: ModifyInstanceCapacityReservationAttributesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyInstanceCreditSpecificationRequest:
- type: object
- required:
- - InstanceCreditSpecifications
- title: ModifyInstanceCreditSpecificationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
- InstanceCreditSpecification:
- allOf:
- - $ref: '#/components/schemas/InstanceCreditSpecificationListRequest'
- - description: Information about the credit option for CPU usage.
- SuccessfulInstanceCreditSpecificationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SuccessfulInstanceCreditSpecificationItem'
- - xml:
- name: item
- UnsuccessfulInstanceCreditSpecificationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationItem'
- - xml:
- name: item
- ModifyInstanceEventStartTimeRequest:
- type: object
- required:
- - InstanceId
- - InstanceEventId
- - NotBefore
- title: ModifyInstanceEventStartTimeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The new date and time when the event will take place.
- ModifyInstanceEventWindowRequest:
- type: object
- required:
- - InstanceEventWindowId
- title: ModifyInstanceEventWindowRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowId'
- - description: The ID of the event window.
- TimeRange:
- allOf:
- - $ref: '#/components/schemas/InstanceEventWindowCronExpression'
- - description: 'The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.
Constraints:
Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
' - ModifyInstanceMaintenanceOptionsRequest: - type: object - required: - - InstanceId - title: ModifyInstanceMaintenanceOptionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyInstanceMetadataOptionsRequest:
- type: object
- required:
- - InstanceId
- title: ModifyInstanceMetadataOptionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/InstanceMetadataTagsState'
- - description: 'Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.
To remove an instance from a placement group, specify an empty string ("").
' - hostId: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - description: The ID of the Dedicated Host with which to associate the instance. - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance that you are modifying. - tenancy: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the host resource group in which to place the instance. - ModifyIpamPoolRequest: - type: object - required: - - IpamPoolId - title: ModifyIpamPoolRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Clear the default netmask length allocation rule for this pool. - AddAllocationResourceTag: - allOf: - - $ref: '#/components/schemas/RequestIpamResourceTagList' - - description: 'Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.' - RemoveAllocationResourceTag: - allOf: - - $ref: '#/components/schemas/RequestIpamResourceTagList' - - description: Remove tag allocation rules from a pool. - RemoveIpamOperatingRegionSet: - type: array - items: - $ref: '#/components/schemas/RemoveIpamOperatingRegion' - minItems: 0 - maxItems: 50 - ModifyIpamRequest: - type: object - required: - - IpamId - title: ModifyIpamRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the IPAM you want to modify. - AddOperatingRegion: - allOf: - - $ref: '#/components/schemas/AddIpamOperatingRegionSet' - - description: 'Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' - RemoveOperatingRegion: - allOf: - - $ref: '#/components/schemas/RemoveIpamOperatingRegionSet' - - description: The operating Regions to remove. - ModifyIpamResourceCidrRequest: - type: object - required: - - ResourceId - - ResourceCidr - - ResourceRegion - - CurrentIpamScopeId - - Monitored - title: ModifyIpamResourceCidrRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.' - ModifyIpamScopeRequest: - type: object - required: - - IpamScopeId - title: ModifyIpamScopeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the scope you want to modify. - ModifyLaunchTemplateRequest: - type: object - title: ModifyLaunchTemplateRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateName' - - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. - SetDefaultVersion: - allOf: - - $ref: '#/components/schemas/String' - - description: The version number of the launch template to set as the default version. - ModifyManagedPrefixListRequest: - type: object - required: - - PrefixListId - title: ModifyManagedPrefixListRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: A name for the prefix list. - AddEntry: - allOf: - - $ref: '#/components/schemas/AddPrefixListEntries' - - description: One or more entries to add to the prefix list. - RemoveEntry: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.
If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.
' - NetworkInterfaceAttachmentChanges: - type: object - properties: - attachmentId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAttachmentId' - - description: The ID of the network interface attachment. - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the network interface is deleted when the instance is terminated. - description: Describes an attachment change. - ModifyNetworkInterfaceAttributeRequest: - type: object - required: - - NetworkInterfaceId - title: ModifyNetworkInterfaceAttributeRequest - properties: - attachment: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAttachmentChanges' - - description: 'Information about the interface attachment. If modifying the ''delete on termination'' attribute, you must specify the ID of the interface attachment.' - description: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: A description for the network interface. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SecurityGroupId:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupIdStringList'
- - description: 'Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it''s just the default security group in the VPC. You must specify the ID of the security group, not the name.'
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceId'
- - description: The ID of the network interface.
- sourceDestCheck:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
- description: Contains the parameters for ModifyNetworkInterfaceAttribute.
- ModifyPrivateDnsNameOptionsRequest:
- type: object
- title: ModifyPrivateDnsNameOptionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
- ReservedInstancesConfigurationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesConfiguration'
- - xml:
- name: item
- ModifyReservedInstancesRequest:
- type: object
- required:
- - ReservedInstancesIds
- - TargetConfigurations
- title: ModifyReservedInstancesRequest
- properties:
- ReservedInstancesId:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesIdStringList'
- - description: The IDs of the Reserved Instances to modify.
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
- ReservedInstancesConfigurationSetItemType:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesConfigurationList'
- - description: The configuration settings for the Reserved Instances to modify.
- description: Contains the parameters for ModifyReservedInstances.
- ModifySecurityGroupRulesRequest:
- type: object
- required:
- - GroupId
- - SecurityGroupRules
- title: ModifySecurityGroupRulesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - description: The ID of the security group.
- SecurityGroupRule:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifySnapshotAttributeRequest:
- type: object
- required:
- - SnapshotId
- title: ModifySnapshotAttributeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/CreateVolumePermissionModifications'
- - description: A JSON representation of the snapshot attribute modification.
- UserGroup:
- allOf:
- - $ref: '#/components/schemas/SnapshotId'
- - description: The ID of the snapshot.
- UserId:
- allOf:
- - $ref: '#/components/schemas/UserIdStringList'
- - description: The account ID to modify for the snapshot.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifySnapshotTierRequest:
- type: object
- required:
- - SnapshotId
- title: ModifySnapshotTierRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifySpotFleetRequestRequest:
- type: object
- required:
- - SpotFleetRequestId
- title: ModifySpotFleetRequestRequest
- properties:
- excessCapacityTerminationPolicy:
- allOf:
- - $ref: '#/components/schemas/ExcessCapacityTerminationPolicy'
- - description: Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
- LaunchTemplateConfig:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateConfigList'
- - description: 'The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.'
- spotFleetRequestId:
- allOf:
- - $ref: '#/components/schemas/SpotFleetRequestId'
- - description: The ID of the Spot Fleet request.
- targetCapacity:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Reserved.
- description: Contains the parameters for ModifySpotFleetRequest.
- ModifySubnetAttributeRequest:
- type: object
- required:
- - SubnetId
- title: ModifySubnetAttributeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address.
- subnetId:
- allOf:
- - $ref: '#/components/schemas/AttributeBooleanValue'
- - description: ' Specify true to indicate that local network interfaces at the current position should be disabled. '
- TrafficMirrorNetworkServiceList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorNetworkService'
- - xml:
- name: item
- ModifyTrafficMirrorFilterNetworkServicesRequest:
- type: object
- required:
- - TrafficMirrorFilterId
- title: ModifyTrafficMirrorFilterNetworkServicesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorFilterId'
- - description: The ID of the Traffic Mirror filter.
- AddNetworkService:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorNetworkServiceList'
- - description: 'The network service, for example Amazon DNS, that you want to mirror.'
- RemoveNetworkService:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyTrafficMirrorFilterRuleRequest:
- type: object
- required:
- - TrafficMirrorFilterRuleId
- title: ModifyTrafficMirrorFilterRuleRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description to assign to the Traffic Mirror rule.
- RemoveField:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyTrafficMirrorSessionRequest:
- type: object
- required:
- - TrafficMirrorSessionId
- title: ModifyTrafficMirrorSessionRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description to assign to the Traffic Mirror session.
- RemoveField:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyTransitGatewayOptions:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableId'
- - description: The ID of the default propagation route table.
- description: The transit gateway options.
- ModifyTransitGatewayPrefixListReferenceRequest:
- type: object
- required:
- - TransitGatewayRouteTableId
- - PrefixListId
- title: ModifyTransitGatewayPrefixListReferenceRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyTransitGatewayRequest:
- type: object
- required:
- - TransitGatewayId
- title: ModifyTransitGatewayRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyTransitGatewayVpcAttachmentRequest:
- type: object
- required:
- - TransitGatewayAttachmentId
- title: ModifyTransitGatewayVpcAttachmentRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyTransitGatewayVpcAttachmentRequestOptions:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ApplianceModeSupportValue'
- - description: 'Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.'
- description: Describes the options for a VPC attachment.
- ModifyVolumeAttributeRequest:
- type: object
- required:
- - VolumeId
- title: ModifyVolumeAttributeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VolumeId'
- - description: The ID of the volume.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyVolumeRequest:
- type: object
- required:
- - VolumeId
- title: ModifyVolumeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.'
- VolumeModification:
- type: object
- properties:
- volumeId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the volume.
- modificationState:
- allOf:
- - $ref: '#/components/schemas/VolumeModificationState'
- - description: The current modification state. The modification state is null for unmodified volumes.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A status message about the modification progress or failure.
- targetSize:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The target size of the volume, in GiB.'
- targetIops:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The target IOPS rate of the volume.
- targetVolumeType:
- allOf:
- - $ref: '#/components/schemas/VolumeType'
- - description: The target EBS volume type of the volume.
- targetThroughput:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The target throughput of the volume, in MiB/s.'
- targetMultiAttachEnabled:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The target setting for Amazon EBS Multi-Attach.
- originalSize:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The original size of the volume, in GiB.'
- originalIops:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The original IOPS rate of the volume.
- originalVolumeType:
- allOf:
- - $ref: '#/components/schemas/VolumeType'
- - description: The original EBS volume type of the volume.
- originalThroughput:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The original throughput of the volume, in MiB/s.'
- originalMultiAttachEnabled:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: The original setting for Amazon EBS Multi-Attach.
- progress:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: 'The modification progress, from 0 to 100 percent complete.'
- startTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The modification start time.
- endTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The modification completion or failure time.
- description: 'Describes the modification status of an EBS volume.
If the volume has never been modified, some element values will be null.
' - ModifyVpcAttributeRequest: - type: object - required: - - VpcId - title: ModifyVpcAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: 'Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
' - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - ModifyVpcEndpointConnectionNotificationRequest: - type: object - required: - - ConnectionNotificationId - title: ModifyVpcEndpointConnectionNotificationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: 'One or more events for the endpoint. Valid values areAccept, Connect, Delete, and Reject.'
- VpcEndpointSecurityGroupIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - xml:
- name: item
- ModifyVpcEndpointRequest:
- type: object
- required:
- - VpcEndpointId
- title: ModifyVpcEndpointRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.
- AddRouteTableId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointRouteTableIdList'
- - description: (Gateway endpoint) One or more route tables IDs to associate with the endpoint.
- RemoveRouteTableId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointRouteTableIdList'
- - description: (Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
- AddSubnetId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointSubnetIdList'
- - description: '(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.'
- RemoveSubnetId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointSubnetIdList'
- - description: (Interface endpoint) One or more subnets IDs in which to remove the endpoint.
- AddSecurityGroupId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointSecurityGroupIdList'
- - description: (Interface endpoint) One or more security group IDs to associate with the network interface.
- RemoveSecurityGroupId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
- description: Contains the parameters for ModifyVpcEndpoint.
- ModifyVpcEndpointServiceConfigurationRequest:
- type: object
- required:
- - ServiceId
- title: ModifyVpcEndpointServiceConfigurationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether requests to create an endpoint to your service must be accepted.
- AddNetworkLoadBalancerArn:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
- RemoveNetworkLoadBalancerArn:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
- AddGatewayLoadBalancerArn:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.
- RemoveGatewayLoadBalancerArn:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.
- AddSupportedIpAddressType:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The IP address types to add to your service configuration.
- RemoveSupportedIpAddressType:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The IP address types to remove from your service configuration.
- PayerResponsibility:
- type: string
- enum:
- - ServiceOwner
- ModifyVpcEndpointServicePayerResponsibilityRequest:
- type: object
- required:
- - ServiceId
- - PayerResponsibility
- title: ModifyVpcEndpointServicePayerResponsibilityRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/PayerResponsibility'
- - description: 'The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.'
- ModifyVpcEndpointServicePermissionsRequest:
- type: object
- required:
- - ServiceId
- title: ModifyVpcEndpointServicePermissionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.
- ModifyVpcPeeringConnectionOptionsRequest:
- type: object
- required:
- - VpcPeeringConnectionId
- title: ModifyVpcPeeringConnectionOptionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnectionId'
- - description: The ID of the VPC peering connection.
- PeeringConnectionOptions:
- type: object
- properties:
- allowDnsResolutionFromRemoteVpc:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.'
- allowEgressFromLocalClassicLinkToRemoteVpc:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If true, enables outbound communication from an EC2-Classic instance that''s linked to a local VPC using ClassicLink to instances in a peer VPC.'
- allowEgressFromLocalVpcToRemoteClassicLink:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that''s linked to a peer VPC using ClassicLink.'
- description: Describes the VPC peering connection options.
- ModifyVpcTenancyRequest:
- type: object
- required:
- - VpcId
- - InstanceTenancy
- title: ModifyVpcTenancyRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyVpnConnectionOptionsRequest:
- type: object
- required:
- - VpnConnectionId
- title: ModifyVpnConnectionOptionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyVpnConnectionRequest:
- type: object
- required:
- - VpnConnectionId
- title: ModifyVpnConnectionRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyVpnTunnelCertificateRequest:
- type: object
- required:
- - VpnConnectionId
- - VpnTunnelOutsideIpAddress
- title: ModifyVpnTunnelCertificateRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyVpnTunnelOptionsRequest:
- type: object
- required:
- - VpnConnectionId
- - VpnTunnelOutsideIpAddress
- - TunnelOptions
- title: ModifyVpnTunnelOptionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ModifyVpnTunnelOptionsSpecification:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- MonitoringState:
- type: string
- enum:
- - disabled
- - disabling
- - enabled
- - pending
- MoveAddressToVpcRequest:
- type: object
- required:
- - PublicIp
- title: MoveAddressToVpcRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- publicIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Elastic IP address.
- Status:
- type: string
- enum:
- - MoveInProgress
- - InVpc
- - InClassic
- MoveByoipCidrToIpamRequest:
- type: object
- required:
- - Cidr
- - IpamPoolId
- - IpamPoolOwner
- title: MoveByoipCidrToIpamRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID of the owner of the IPAM pool.
- MoveStatus:
- type: string
- enum:
- - movingToVpc
- - restoringToClassic
- MovingAddressStatus:
- type: object
- properties:
- moveStatus:
- allOf:
- - $ref: '#/components/schemas/MoveStatus'
- - description: 'The status of the Elastic IP address that''s being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.'
- publicIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Elastic IP address.
- description: Describes the status of a moving Elastic IP address.
- MulticastSupportValue:
- type: string
- enum:
- - enable
- - disable
- NatGatewayAddressList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NatGatewayAddress'
- - xml:
- name: item
- ProvisionedBandwidth:
- type: object
- properties:
- provisionTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.'
- provisioned:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.'
- requestTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.'
- requested:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.'
- status:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.'
- description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.'
- NatGatewayState:
- type: string
- enum:
- - pending
- - failed
- - available
- - deleting
- - deleted
- NatGatewayAddress:
- type: object
- properties:
- allocationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: '[Public NAT gateway only] The allocation ID of the Elastic IP address that''s associated with the NAT gateway.'
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network interface associated with the NAT gateway.
- privateIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The private IP address associated with the NAT gateway.
- publicIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: '[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.'
- description: Describes the IP addresses and network interface associated with a NAT gateway.
- NatGatewayIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NatGatewayId'
- - xml:
- name: item
- NetworkAclAssociationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkAclAssociation'
- - xml:
- name: item
- NetworkAclEntryList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkAclEntry'
- - xml:
- name: item
- NetworkAclAssociation:
- type: object
- properties:
- networkAclAssociationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the association between a network ACL and a subnet.
- networkAclId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network ACL.
- subnetId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the subnet.
- description: Describes an association between a network ACL and a subnet.
- NetworkAclAssociationId:
- type: string
- NetworkAclEntry:
- type: object
- properties:
- cidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IPv4 network range to allow or deny, in CIDR notation.'
- egress:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
- icmpTypeCode:
- allOf:
- - $ref: '#/components/schemas/IcmpTypeCode'
- - description: 'ICMP protocol: The ICMP type and code.'
- ipv6CidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IPv6 network range to allow or deny, in CIDR notation.'
- portRange:
- allOf:
- - $ref: '#/components/schemas/PortRange'
- - description: 'TCP or UDP protocols: The range of ports the rule applies to.'
- protocol:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The protocol number. A value of "-1" means all protocols.
- ruleAction:
- allOf:
- - $ref: '#/components/schemas/RuleAction'
- - description: Indicates whether to allow or deny the traffic that matches the rule.
- ruleNumber:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The rule number for the entry. ACL entries are processed in ascending order by rule number.
- description: Describes an entry in a network ACL.
- NetworkAclIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkAclId'
- - xml:
- name: item
- NetworkCardIndex:
- type: integer
- NetworkPerformance:
- type: string
- NetworkCardInfo:
- type: object
- properties:
- networkCardIndex:
- allOf:
- - $ref: '#/components/schemas/NetworkCardIndex'
- - description: The index of the network card.
- networkPerformance:
- allOf:
- - $ref: '#/components/schemas/NetworkPerformance'
- - description: The network performance of the network card.
- maximumNetworkInterfaces:
- allOf:
- - $ref: '#/components/schemas/MaxNetworkInterfaces'
- - description: The maximum number of network interfaces for the network card.
- description: Describes the network card support of the instance type.
- NetworkCardInfoList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkCardInfo'
- - xml:
- name: item
- NetworkInsightsAccessScopeAnalysis:
- type: object
- properties:
- networkInsightsAccessScopeAnalysisId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
- - description: The ID of the Network Access Scope analysis.
- networkInsightsAccessScopeAnalysisArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The Amazon Resource Name (ARN) of the Network Access Scope analysis.
- networkInsightsAccessScopeId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- - description: The ID of the Network Access Scope.
- status:
- allOf:
- - $ref: '#/components/schemas/AnalysisStatus'
- - description: The status.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The status message.
- warningMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The warning message.
- startDate:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The analysis start date.
- endDate:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The analysis end date.
- findingsFound:
- allOf:
- - $ref: '#/components/schemas/FindingsFound'
- - description: Indicates whether there are findings.
- analyzedEniCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of network interfaces analyzed.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags.
- description: Describes a Network Access Scope analysis.
- NetworkInsightsAccessScopeAnalysisIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
- - xml:
- name: item
- NetworkInsightsAnalysis:
- type: object
- properties:
- networkInsightsAnalysisId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAnalysisId'
- - description: The ID of the network insights analysis.
- networkInsightsAnalysisArn:
- allOf:
- - $ref: '#/components/schemas/ResourceArn'
- - description: The Amazon Resource Name (ARN) of the network insights analysis.
- networkInsightsPathId:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsPathId'
- - description: The ID of the path.
- filterInArnSet:
- allOf:
- - $ref: '#/components/schemas/ArnList'
- - description: The Amazon Resource Names (ARN) of the Amazon Web Services resources that the path must traverse.
- startDate:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The time the analysis started.
- status:
- allOf:
- - $ref: '#/components/schemas/AnalysisStatus'
- - description: The status of the network insights analysis.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The status message, if the status is failed.'
- warningMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The warning message.
- networkPathFound:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the destination is reachable from the source.
- forwardPathComponentSet:
- allOf:
- - $ref: '#/components/schemas/PathComponentList'
- - description: The components in the path from source to destination.
- returnPathComponentSet:
- allOf:
- - $ref: '#/components/schemas/PathComponentList'
- - description: The components in the path from destination to source.
- explanationSet:
- allOf:
- - $ref: '#/components/schemas/ExplanationList'
- - description: 'The explanations. For more information, see Reachability Analyzer explanation codes.'
- alternatePathHintSet:
- allOf:
- - $ref: '#/components/schemas/AlternatePathHintList'
- - description: Potential intermediate components.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags.
- description: Describes a network insights analysis.
- NetworkInsightsAnalysisIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsAnalysisId'
- - xml:
- name: item
- NetworkInsightsMaxResults:
- type: integer
- minimum: 1
- maximum: 100
- Protocol:
- type: string
- enum:
- - tcp
- - udp
- NetworkInsightsResourceId:
- type: string
- NetworkInterfaceAssociation:
- type: object
- properties:
- allocationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The allocation ID.
- associationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The association ID.
- ipOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Elastic IP address owner.
- publicDnsName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The public DNS name.
- publicIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The address of the Elastic IP address bound to the network interface.
- customerOwnedIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The customer-owned IP address associated with the network interface.
- carrierIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The carrier IP address associated with the network interface.
This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
- description: 'Describes association information for an Elastic IP address (IPv4 only), or a Carrier IP address (for a network interface which resides in a subnet in a Wavelength Zone).' - NetworkInterfaceType: - type: string - enum: - - interface - - natGateway - - efa - - trunk - - load_balancer - - network_load_balancer - - vpc_endpoint - - branch - - transit_gateway - - lambda - - quicksight - - global_accelerator_managed - - api_gateway_managed - - gateway_load_balancer - - gateway_load_balancer_endpoint - - iot_rules_managed - - aws_codestar_connections_managed - NetworkInterfaceIpv6AddressesList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceIpv6Address' - - xml: - name: item - NetworkInterfacePrivateIpAddressList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfacePrivateIpAddress' - - xml: - name: item - NetworkInterfaceCountRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of network interfaces. To specify no maximum limit, omit this parameter.' - description: The minimum and maximum number of network interfaces. - NetworkInterfaceIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - xml: - name: item - NetworkInterfaceIpv6Address: - type: object - properties: - ipv6Address: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 address. - description: Describes an IPv6 address associated with a network interface. - NetworkInterfacePermissionState: - type: object - properties: - state: - allOf: - - $ref: '#/components/schemas/NetworkInterfacePermissionStateCode' - - description: The state of the permission. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A status message, if applicable.' - description: Describes the state of a network interface permission. - NetworkInterfacePermissionStateCode: - type: string - enum: - - pending - - granted - - revoking - - revoked - NetworkInterfacePrivateIpAddress: - type: object - properties: - association: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAssociation' - - description: The association information for an Elastic IP address (IPv4) associated with the network interface. - primary: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether this IPv4 address is the primary private IPv4 address of the network interface. - privateDnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The private DNS name. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The private IPv4 address. - description: Describes the private IPv4 address of a network interface. - OccurrenceDayRequestSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/Integer' - - xml: - name: OccurenceDay - OccurrenceDaySet: - type: array - items: - allOf: - - $ref: '#/components/schemas/Integer' - - xml: - name: item - OnDemandOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum amount per hour for On-Demand Instances that you're willing to pay. - description: Describes the configuration of On-Demand Instances in an EC2 Fleet. - ProtocolList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Protocol' - - xml: - name: item - PacketHeaderStatement: - type: object - properties: - sourceAddressSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The source addresses. - destinationAddressSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The destination addresses. - sourcePortSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The source ports. - destinationPortSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The destination ports. - sourcePrefixListSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The source prefix lists. - destinationPrefixListSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The destination prefix lists. - protocolSet: - allOf: - - $ref: '#/components/schemas/ProtocolList' - - description: The protocols. - description: Describes a packet header statement. - PacketHeaderStatementRequest: - type: object - properties: - SourceAddress: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The source addresses. - DestinationAddress: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The destination addresses. - SourcePort: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The source ports. - DestinationPort: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The destination ports. - SourcePrefixList: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The source prefix lists. - DestinationPrefixList: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The destination prefix lists. - Protocol: - allOf: - - $ref: '#/components/schemas/ProtocolList' - - description: The protocols. - description: Describes a packet header statement. - PartitionLoadFrequency: - type: string - enum: - - none - - daily - - weekly - - monthly - PathComponent: - type: object - properties: - sequenceNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The sequence number. - aclRule: - allOf: - - $ref: '#/components/schemas/AnalysisAclRule' - - description: The network ACL rule. - attachedTo: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The resource to which the path component is attached. - component: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The component. - destinationVpc: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The destination VPC. - outboundHeader: - allOf: - - $ref: '#/components/schemas/AnalysisPacketHeader' - - description: The outbound header. - inboundHeader: - allOf: - - $ref: '#/components/schemas/AnalysisPacketHeader' - - description: The inbound header. - routeTableRoute: - allOf: - - $ref: '#/components/schemas/AnalysisRouteTableRoute' - - description: The route table route. - securityGroupRule: - allOf: - - $ref: '#/components/schemas/AnalysisSecurityGroupRule' - - description: The security group rule. - sourceVpc: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The source VPC. - subnet: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The subnet. - vpc: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The component VPC. - additionalDetailSet: - allOf: - - $ref: '#/components/schemas/AdditionalDetailList' - - description: The additional details. - transitGateway: - $ref: '#/components/schemas/AnalysisComponent' - transitGatewayRouteTableRoute: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableRoute' - - description: The route in a transit gateway route table. - description: Describes a path component. - ResourceStatement: - type: object - properties: - resourceSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The resources. - resourceTypeSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The resource types. - description: Describes a resource statement. - ResourceStatementRequest: + type: string + InstanceId: + description: The ID of the instance. + type: string + PrivateIpAddress: + description: The primary or secondary private IP address to associate with the Elastic IP address. + type: string + EIP: + description: The Elastic IP address to associate with the instance. + type: string + x-stackql-resource-name: eip_association + description: Resource schema for EC2 EIP association. + x-type-name: AWS::EC2::EIPAssociation + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - AllocationId + - NetworkInterfaceId + - InstanceId + - PrivateIpAddress + - EIP + x-read-only-properties: + - Id + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + x-required-permissions: + create: + - ec2:DescribeAddresses + - ec2:AssociateAddress + read: + - ec2:DescribeAddresses + delete: + - ec2:DisassociateAddress + - ec2:DescribeAddresses + list: + - ec2:DescribeAddresses + EnclaveCertificateIamRoleAssociation: + type: object + properties: + CertificateArn: + description: The Amazon Resource Name (ARN) of the ACM certificate with which to associate the IAM role. + type: string + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:acm:[A-Za-z0-9-]{1,64}:([0-9]{12})?:certificate/.+$ + minLength: 1 + maxLength: 1283 + RoleArn: + description: The Amazon Resource Name (ARN) of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate. + type: string + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:iam:.*:([0-9]{12})?:role/.+$ + minLength: 1 + maxLength: 1283 + CertificateS3BucketName: + description: The name of the Amazon S3 bucket to which the certificate was uploaded. + type: string + CertificateS3ObjectKey: + description: The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. + type: string + EncryptionKmsKeyId: + description: The ID of the AWS KMS CMK used to encrypt the private key of the certificate. + type: string + required: + - CertificateArn + - RoleArn + x-stackql-resource-name: enclave_certificate_iam_role_association + description: Associates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This association is based on Amazon Resource Names and it enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. + x-type-name: AWS::EC2::EnclaveCertificateIamRoleAssociation + x-stackql-primary-identifier: + - CertificateArn + - RoleArn + x-create-only-properties: + - CertificateArn + - RoleArn + x-read-only-properties: + - CertificateS3BucketName + - CertificateS3ObjectKey + - EncryptionKmsKeyId + x-required-properties: + - CertificateArn + - RoleArn + x-required-permissions: + create: + - ec2:AssociateEnclaveCertificateIamRole + read: + - ec2:GetAssociatedEnclaveCertificateIamRoles + delete: + - ec2:DisassociateEnclaveCertificateIamRole + list: + - ec2:GetAssociatedEnclaveCertificateIamRoles + FlowLog: type: object properties: - Resource: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The resources. + Id: + description: The Flow Log ID + type: string + DeliverCrossAccountRole: + description: The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts. + type: string + DeliverLogsPermissionArn: + description: The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName. + type: string + LogDestination: + description: Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType. + type: string + LogDestinationType: + description: Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. + type: string + enum: + - cloud-watch-logs + - s3 + - kinesis-data-firehose + LogFormat: + description: The fields to include in the flow log record, in the order in which they should appear. + type: string + LogGroupName: + description: The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName. + type: string + MaxAggregationInterval: + description: The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). + type: integer + ResourceId: + description: The ID of the subnet, network interface, or VPC for which you want to create a flow log. + type: string ResourceType: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The resource types. - description: Describes a resource statement. - PeeringAttachmentStatus: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/String' - - description: The status code. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The status message, if applicable.' - description: The status of the transit gateway peering attachment. - PeeringConnectionOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that''s linked to a peer VPC using ClassicLink.' - description: The VPC peering connection options. - PeeringTgwInfo: - type: object - properties: - transitGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the transit gateway. - region: - allOf: - - $ref: '#/components/schemas/String' - - description: The Region of the transit gateway. - description: Information about the transit gateway in the peering attachment. - Phase1DHGroupNumbersListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The Diffie-Hellmann group number. - description: The Diffie-Hellmann group number for phase 1 IKE negotiations. - Phase1DHGroupNumbersList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase1DHGroupNumbersListValue' - - xml: - name: item - Phase1DHGroupNumbersRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The Diffie-Hellmann group number. - description: Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations. - Phase1EncryptionAlgorithmsListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The value for the encryption algorithm. - description: The encryption algorithm for phase 1 IKE negotiations. - Phase1EncryptionAlgorithmsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsListValue' - - xml: - name: item - Phase1EncryptionAlgorithmsRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The value for the encryption algorithm. - description: Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations. - Phase1IntegrityAlgorithmsListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The value for the integrity algorithm. - description: The integrity algorithm for phase 1 IKE negotiations. - Phase1IntegrityAlgorithmsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsListValue' - - xml: - name: item - Phase1IntegrityAlgorithmsRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The value for the integrity algorithm. - description: Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations. - Phase2DHGroupNumbersListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The Diffie-Hellmann group number. - description: The Diffie-Hellmann group number for phase 2 IKE negotiations. - Phase2DHGroupNumbersList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase2DHGroupNumbersListValue' - - xml: - name: item - Phase2DHGroupNumbersRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The Diffie-Hellmann group number. - description: Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations. - Phase2EncryptionAlgorithmsListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The encryption algorithm. - description: The encryption algorithm for phase 2 IKE negotiations. - Phase2EncryptionAlgorithmsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsListValue' - - xml: - name: item - Phase2EncryptionAlgorithmsRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The encryption algorithm. - description: Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations. - Phase2IntegrityAlgorithmsListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The integrity algorithm. - description: The integrity algorithm for phase 2 IKE negotiations. - Phase2IntegrityAlgorithmsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsListValue' - - xml: - name: item - Phase2IntegrityAlgorithmsRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The integrity algorithm. - description: Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations. - PlacementGroupState: - type: string - enum: - - pending - - available - - deleting - - deleted - PlacementStrategy: - type: string - enum: - - cluster - - spread - - partition - PlacementGroupStrategyList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PlacementGroupStrategy' - - xml: - name: item - PlacementGroupStrategy: - type: string - enum: - - cluster - - partition - - spread - PoolCidrBlock: - type: object - properties: - poolCidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR block. - description: Describes a CIDR block for an address pool. - PrefixList: - type: object - properties: - cidrSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The IP address range of the Amazon Web Service. - prefixListId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the prefix. - prefixListName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the prefix. - description: Describes prefixes for Amazon Web Services services. - PrefixListAssociation: - type: object - properties: - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceOwner: - allOf: - - $ref: '#/components/schemas/String' - - description: The owner of the resource. - description: Describes the resource with which a prefix list is associated. - PrefixListEntry: - type: object - properties: - cidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR block. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description. - description: Describes a prefix list entry. - PrefixListId: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
' - prefixListId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the prefix. - description: Describes a prefix list ID. - PrefixListIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - PrefixListMaxResults: - type: integer - minimum: 1 - maximum: 100 - PriceSchedule: - type: object - properties: - active: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
' - currencyCode: - allOf: - - $ref: '#/components/schemas/CurrencyCodeValues' - - description: 'The currency for transacting the Reserved Instance resale. At this time, the only supported currency isUSD.'
- price:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: The fixed price for the term.
- term:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: 'The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.'
- description: Describes the price for a Reserved Instance.
- PriceScheduleList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PriceSchedule'
- - xml:
- name: item
- PricingDetail:
- type: object
- properties:
- count:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of reservations available for the price.
- price:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: The price per instance.
- description: Describes a Reserved Instance offering.
- PricingDetailsList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PricingDetail'
- - xml:
- name: item
- PrincipalIdFormat:
- type: object
- properties:
- arn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: PrincipalIdFormatARN description
- statusSet:
- allOf:
- - $ref: '#/components/schemas/IdFormatList'
- - description: PrincipalIdFormatStatuses description
- description: PrincipalIdFormat description
- PrivateDnsDetails:
- type: object
- properties:
- privateDnsName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The private DNS name assigned to the VPC endpoint service.
- description: Information about the Private DNS name for interface endpoints.
- PrivateDnsDetailsSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PrivateDnsDetails'
- - xml:
- name: item
- PrivateDnsNameConfiguration:
- type: object
- properties:
- state:
- allOf:
- - $ref: '#/components/schemas/DnsNameState'
- - description: The verification state of the VPC endpoint service.
>Consumers of the endpoint service can use the private name only when the state is verified.
value text to the name.
- description: Information about the private DNS name for the service endpoint.
- PrivateDnsNameOptionsOnLaunch:
+ description: The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.
+ type: string
+ enum:
+ - NetworkInterface
+ - Subnet
+ - VPC
+ - TransitGateway
+ - TransitGatewayAttachment
+ Tags:
+ description: The tags to apply to the flow logs.
+ type: array
+ uniqueItems: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ TrafficType:
+ description: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
+ type: string
+ enum:
+ - ACCEPT
+ - ALL
+ - REJECT
+ DestinationOptions:
+ type: object
+ additionalProperties: false
+ properties:
+ FileFormat:
+ type: string
+ enum:
+ - plain-text
+ - parquet
+ HiveCompatiblePartitions:
+ type: boolean
+ PerHourPartition:
+ type: boolean
+ required:
+ - FileFormat
+ - HiveCompatiblePartitions
+ - PerHourPartition
+ required:
+ - ResourceType
+ - ResourceId
+ x-stackql-resource-name: flow_log
+ description: Specifies a VPC flow log, which enables you to capture IP traffic for a specific network interface, subnet, or VPC.
+ x-type-name: AWS::EC2::FlowLog
+ x-stackql-primary-identifier:
+ - Id
+ x-create-only-properties:
+ - DeliverCrossAccountRole
+ - DeliverLogsPermissionArn
+ - LogGroupName
+ - LogDestination
+ - ResourceId
+ - TrafficType
+ - LogDestinationType
+ - ResourceType
+ - LogFormat
+ - MaxAggregationInterval
+ - DestinationOptions
+ x-read-only-properties:
+ - Id
+ x-required-properties:
+ - ResourceType
+ - ResourceId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: true
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateFlowLogs
+ - ec2:DescribeFlowLogs
+ - ec2:CreateTags
+ - iam:PassRole
+ - logs:CreateLogDelivery
+ - s3:GetBucketPolicy
+ - s3:PutBucketPolicy
+ read:
+ - ec2:DescribeFlowLogs
+ update:
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ - ec2:DescribeFlowLogs
+ delete:
+ - ec2:DeleteFlowLogs
+ - ec2:DescribeFlowLogs
+ - logs:DeleteLogDelivery
+ list:
+ - ec2:DescribeFlowLogs
+ GatewayRouteTableAssociation:
type: object
properties:
- hostnameType:
- allOf:
- - $ref: '#/components/schemas/HostnameType'
- - description: 'The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.'
- enableResourceNameDnsARecord:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
- enableResourceNameDnsAAAARecord:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
- description: Describes the options for instance hostnames.
- PrivateDnsNameOptionsRequest:
+ RouteTableId:
+ description: The ID of the route table.
+ type: string
+ GatewayId:
+ description: The ID of the gateway.
+ type: string
+ AssociationId:
+ description: The route table association ID.
+ type: string
+ required:
+ - RouteTableId
+ - GatewayId
+ x-stackql-resource-name: gateway_route_table_association
+ description: Associates a gateway with a route table. The gateway and route table must be in the same VPC. This association causes the incoming traffic to the gateway to be routed according to the routes in the route table.
+ x-type-name: AWS::EC2::GatewayRouteTableAssociation
+ x-stackql-primary-identifier:
+ - GatewayId
+ x-create-only-properties:
+ - GatewayId
+ x-read-only-properties:
+ - AssociationId
+ x-required-properties:
+ - RouteTableId
+ - GatewayId
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:DescribeRouteTables
+ - ec2:AssociateRouteTable
+ read:
+ - ec2:DescribeRouteTables
+ update:
+ - ec2:DescribeRouteTables
+ - ec2:ReplaceRouteTableAssociation
+ delete:
+ - ec2:DescribeRouteTables
+ - ec2:DisassociateRouteTable
+ Host:
type: object
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
- description: Describes the options for instance hostnames.
- ScheduledInstancesPrivateIpAddressConfig:
+ HostId:
+ description: ID of the host created.
+ type: string
+ AutoPlacement:
+ description: Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.
+ type: string
+ AvailabilityZone:
+ description: The Availability Zone in which to allocate the Dedicated Host.
+ type: string
+ HostRecovery:
+ description: Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
+ type: string
+ InstanceType:
+ description: Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
+ type: string
+ InstanceFamily:
+ description: Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
+ type: string
+ OutpostArn:
+ description: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
+ type: string
+ HostMaintenance:
+ description: Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
+ type: string
+ AssetId:
+ description: The ID of the Outpost hardware asset.
+ type: string
+ required:
+ - AvailabilityZone
+ x-stackql-resource-name: host
+ description: Resource Type definition for AWS::EC2::Host
+ x-type-name: AWS::EC2::Host
+ x-stackql-primary-identifier:
+ - HostId
+ x-create-only-properties:
+ - AvailabilityZone
+ - InstanceType
+ - InstanceFamily
+ - OutpostArn
+ - AssetId
+ x-read-only-properties:
+ - HostId
+ x-required-properties:
+ - AvailabilityZone
+ x-required-permissions:
+ create:
+ - ec2:AllocateHosts
+ - ec2:DescribeHosts
+ read:
+ - ec2:DescribeHosts
+ update:
+ - ec2:ModifyHosts
+ - ec2:DescribeHosts
+ delete:
+ - ec2:ReleaseHosts
+ - ec2:DescribeHosts
+ list:
+ - ec2:DescribeHosts
+ LaunchTemplateSpecification:
+ oneOf:
+ - required:
+ - LaunchTemplateName
+ - Version
+ - required:
+ - LaunchTemplateId
+ - Version
+ additionalProperties: false
type: object
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv4 address.
- description: Describes a private IPv4 address for a Scheduled Instance.
- PrivateIpAddressConfigSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ScheduledInstancesPrivateIpAddressConfig'
- - xml:
- name: PrivateIpAddressConfigSet
- ProcessorSustainedClockSpeed:
- type: number
- format: double
- ProductCodeValues:
- type: string
- enum:
- - devpay
- - marketplace
- ProductCode:
+ LaunchTemplateName:
+ description: The name of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
+ type: string
+ Version:
+ description: The version number of the launch template.
+ type: string
+ LaunchTemplateId:
+ description: The ID of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
+ type: string
+ LicenseSpecification:
+ description: |-
+ Specifies a license configuration for an instance.
+ ``LicenseSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).
+ additionalProperties: false
+ type: object
+ properties:
+ LicenseConfigurationArn:
+ description: The Amazon Resource Name (ARN) of the license configuration.
+ type: string
+ ElasticGpuSpecification:
+ description: |-
+ Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
+ Specifies a specification for an Elastic GPU for an Amazon EC2 launch template.
+ ``ElasticGpuSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).
+ additionalProperties: false
type: object
properties:
- productCode:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The product code.
- type:
- allOf:
- - $ref: '#/components/schemas/ProductCodeValues'
- - description: The type of product code.
- description: Describes a product code.
- PropagatingVgw:
+ Type:
+ description: The type of Elastic Graphics accelerator. For more information about the values to specify for ``Type``, see [Elastic Graphics Basics](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html#elastic-graphics-basics), specifically the Elastic Graphics accelerator column, in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*.
+ type: string
+ InstanceIpv6Address:
type: object
+ additionalProperties: false
properties:
- gatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the virtual private gateway.
- description: Describes a virtual private gateway propagating route.
- PropagatingVgwList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PropagatingVgw'
- - xml:
- name: item
- ProvisionByoipCidrRequest:
- type: object
+ Ipv6Address:
+ type: string
required:
- - Cidr
- title: ProvisionByoipCidrRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- PoolTagSpecification:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Reserved.
- ProvisionIpamPoolCidrRequest:
+ - Ipv6Address
+ NetworkInterface:
type: object
- required:
- - IpamPoolId
- title: ProvisionIpamPoolCidrRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/IpamCidrAuthorizationContext'
- - description: A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.
- ProvisionPublicIpv4PoolCidrRequest:
- type: object
+ Description:
+ description: A description for the network interface.
+ type: string
+ PrivateIpAddress:
+ description: 'Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. '
+ type: string
+ PrivateIpAddresses:
+ description: Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/PrivateIpAddressSpecification'
+ SecondaryPrivateIpAddressCount:
+ description: The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses
+ type: integer
+ PrimaryPrivateIpAddress:
+ description: Returns the primary private IP address of the network interface.
+ type: string
+ Ipv4Prefixes:
+ description: 'Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can''t specify IPv4 prefixes if you''ve specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.'
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Ipv4PrefixSpecification'
+ Ipv4PrefixCount:
+ description: 'The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can''t specify a count of IPv4 prefixes if you''ve specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.'
+ type: integer
+ GroupSet:
+ description: A list of security group IDs associated with this network interface.
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ type: string
+ Ipv6Addresses:
+ description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/InstanceIpv6Address'
+ Ipv6Prefixes:
+ description: 'Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can''t specify IPv6 prefixes if you''ve specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.'
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Ipv6PrefixSpecification'
+ Ipv6PrefixCount:
+ description: 'The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can''t specify a count of IPv6 prefixes if you''ve specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.'
+ type: integer
+ SubnetId:
+ description: The ID of the subnet to associate with the network interface.
+ type: string
+ SourceDestCheck:
+ description: Indicates whether traffic to or from the instance is validated.
+ type: boolean
+ InterfaceType:
+ description: Indicates the type of network interface.
+ type: string
+ SecondaryPrivateIpAddresses:
+ description: Returns the secondary private IP addresses of the network interface.
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ type: string
+ Ipv6AddressCount:
+ description: The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.
+ type: integer
+ EnablePrimaryIpv6:
+ description: >-
+ If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you
+ have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.
+ type: boolean
+ PrimaryIpv6Address:
+ description: The primary IPv6 address
+ type: string
+ ConnectionTrackingSpecification:
+ $ref: '#/components/schemas/ConnectionTrackingSpecification'
+ Id:
+ description: Network interface id.
+ type: string
+ Tags:
+ description: An arbitrary set of tags (key-value pairs) for this network interface.
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ VpcId:
+ description: The ID of the VPC
+ type: string
required:
- - IpamPoolId
- - PoolId
- - NetmaskLength
- title: ProvisionPublicIpv4PoolCidrRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The netmask length of the CIDR you would like to allocate to the public IPv4 pool.
- PublicIpv4PoolRange:
+ - SubnetId
+ x-stackql-resource-name: network_interface
+ description: The AWS::EC2::NetworkInterface resource creates network interface
+ x-type-name: AWS::EC2::NetworkInterface
+ x-stackql-primary-identifier:
+ - Id
+ x-create-only-properties:
+ - PrivateIpAddress
+ - InterfaceType
+ - SubnetId
+ x-conditional-create-only-properties:
+ - PrivateIpAddresses
+ - EnablePrimaryIpv6
+ - ConnectionTrackingSpecification
+ x-read-only-properties:
+ - Id
+ - SecondaryPrivateIpAddresses
+ - PrimaryPrivateIpAddress
+ - PrimaryIpv6Address
+ - VpcId
+ x-required-properties:
+ - SubnetId
+ x-taggable: true
+ x-required-permissions:
+ create:
+ - ec2:CreateNetworkInterface
+ - ec2:DescribeNetworkInterfaces
+ - ec2:CreateTags
+ - ec2:ModifyNetworkInterfaceAttribute
+ delete:
+ - ec2:DescribeNetworkInterfaces
+ - ec2:DeleteNetworkInterface
+ list:
+ - ec2:DescribeNetworkInterfaces
+ read:
+ - ec2:DescribeNetworkInterfaces
+ update:
+ - ec2:DescribeNetworkInterfaces
+ - ec2:ModifyNetworkInterfaceAttribute
+ - ec2:UnassignIpv6Addresses
+ - ec2:AssignIpv6Addresses
+ - ec2:DeleteTags
+ - ec2:CreateTags
+ - ec2:UnassignPrivateIpAddresses
+ - ec2:AssignPrivateIpAddresses
+ PrivateDnsNameOptions:
+ description: The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.
+ additionalProperties: false
+ type: object
+ properties:
+ EnableResourceNameDnsARecord:
+ description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
+ type: boolean
+ HostnameType:
+ description: The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.
+ type: string
+ EnableResourceNameDnsAAAARecord:
+ description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
+ type: boolean
+ ElasticInferenceAccelerator:
+ additionalProperties: false
type: object
properties:
- firstAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The first IP address in the range.
- lastAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The last IP address in the range.
- addressCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of addresses in the range.
- availableAddressCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of available addresses in the range.
- description: Describes an address range of an IPv4 address pool.
- PublicIpv4PoolRangeSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PublicIpv4PoolRange'
- - xml:
- name: item
- PublicIpv4Pool:
+ Type:
+ description: The type of elastic inference accelerator.
+ type: string
+ Count:
+ description: The number of elastic inference accelerators to attach to the instance.
+ type: integer
+ minimum: 0
+ required:
+ - Type
+ AssociationParameter:
+ additionalProperties: false
type: object
properties:
- poolId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the address pool.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the address pool.
- poolAddressRangeSet:
- allOf:
- - $ref: '#/components/schemas/PublicIpv4PoolRangeSet'
- - description: The address ranges.
- totalAddressCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The total number of addresses.
- totalAvailableAddressCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The total number of available addresses.
- networkBorderGroup:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags for the address pool.
- description: Describes an IPv4 address pool.
- PublicIpv4PoolIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Ipv4PoolEc2Id'
- - xml:
- name: item
- Purchase:
+ Value:
+ uniqueItems: false
+ description: The value of an input parameter.
+ x-insertionOrder: false
+ type: array
+ items:
+ type: string
+ Key:
+ description: The name of an input parameter that is in the associated SSM document.
+ type: string
+ required:
+ - Value
+ - Key
+ SsmAssociation:
+ additionalProperties: false
+ type: object
+ properties:
+ AssociationParameters:
+ uniqueItems: false
+ description: The input parameter values to use with the associated SSM document.
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/AssociationParameter'
+ DocumentName:
+ description: The name of an SSM document to associate with the instance.
+ type: string
+ required:
+ - DocumentName
+ PrivateIpAddressSpecification:
type: object
+ additionalProperties: false
properties:
- currencyCode:
- allOf:
- - $ref: '#/components/schemas/CurrencyCodeValues'
- - description: 'The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.'
- duration:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The duration of the reservation's term in seconds.
- hostIdSet:
- allOf:
- - $ref: '#/components/schemas/ResponseHostIdSet'
- - description: The IDs of the Dedicated Hosts associated with the reservation.
- hostReservationId:
- allOf:
- - $ref: '#/components/schemas/HostReservationId'
- - description: The ID of the reservation.
- hourlyPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The hourly price of the reservation per hour.
- instanceFamily:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The instance family on the Dedicated Host that the reservation can be associated with.
- paymentOption:
- allOf:
- - $ref: '#/components/schemas/PaymentOption'
- - description: The payment option for the reservation.
- upfrontPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The upfront price of the reservation.
- description: Describes the result of the purchase.
- PurchaseHostReservationRequest:
- type: object
+ Primary:
+ type: boolean
+ PrivateIpAddress:
+ type: string
required:
- - HostIdSet
- - OfferingId
- title: PurchaseHostReservationRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/OfferingId'
- - description: The ID of the offering.
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/TagSpecificationList'
- - description: The tags to apply to the Dedicated Host Reservation during purchase.
- PurchaseRequestSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/PurchaseRequest'
- - xml:
- name: PurchaseRequest
- minItems: 1
- PurchaseReservedInstancesOfferingRequest:
+ - PrivateIpAddress
+ Volume:
type: object
- required:
- - InstanceCount
- - ReservedInstancesOfferingId
- title: PurchaseReservedInstancesOfferingRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesOfferingId'
- - description: The ID of the Reserved Instance offering to purchase.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- limitPrice:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- description: Contains the parameters for PurchaseReservedInstancesOffering.
- PurchaseScheduledInstancesRequest:
- type: object
+ MultiAttachEnabled:
+ type: boolean
+ description: |-
+ Indicates whether Amazon EBS Multi-Attach is enabled.
+ CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
+ KmsKeyId:
+ type: string
+ description: |-
+ The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``.
+ If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key.
+ Alternatively, if you want to specify a different key, you can specify one of the following:
+ + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
+ + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``.
+ + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
+ + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
+ Encrypted:
+ type: boolean
+ description: |-
+ Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*.
+ Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).
+ Size:
+ type: integer
+ description: |-
+ The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
+ The following are the supported volumes sizes for each volume type:
+ + ``gp2`` and ``gp3``: 1 - 16,384 GiB
+ + ``io1``: 4 - 16,384 GiB
+ + ``io2``: 4 - 65,536 GiB
+ + ``st1`` and ``sc1``: 125 - 16,384 GiB
+ + ``standard``: 1 - 1024 GiB
+ AutoEnableIO:
+ type: boolean
+ description: Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
+ OutpostArn:
+ type: string
+ description: The Amazon Resource Name (ARN) of the Outpost.
+ AvailabilityZone:
+ type: string
+ description: The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``.
+ Throughput:
+ type: integer
+ description: |-
+ The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
+ This parameter is valid only for ``gp3`` volumes. The default value is 125.
+ Valid Range: Minimum value of 125. Maximum value of 1000.
+ Iops:
+ type: integer
+ description: |-
+ The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
+ The following are the supported values for each volume type:
+ + ``gp3``: 3,000 - 16,000 IOPS
+ + ``io1``: 100 - 64,000 IOPS
+ + ``io2``: 100 - 256,000 IOPS
+
+ For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.
+ This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes.
+ SnapshotId:
+ type: string
+ description: The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
+ VolumeType:
+ type: string
+ description: |-
+ The volume type. This parameter can be one of the following values:
+ + General Purpose SSD: ``gp2`` | ``gp3``
+ + Provisioned IOPS SSD: ``io1`` | ``io2``
+ + Throughput Optimized HDD: ``st1``
+ + Cold HDD: ``sc1``
+ + Magnetic: ``standard``
+
+ For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*.
+ Default: ``gp2``
+ VolumeId:
+ type: string
+ description: ''
+ Tags:
+ type: array
+ uniqueItems: false
+ description: The tags to apply to the volume during creation.
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
required:
- - PurchaseRequests
- title: PurchaseScheduledInstancesRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- PurchaseRequest:
- allOf:
- - $ref: '#/components/schemas/PurchaseRequestSet'
- - description: The purchase requests.
- description: Contains the parameters for PurchaseScheduledInstances.
- PurchasedScheduledInstanceSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ScheduledInstance'
- - xml:
- name: item
- ScheduledInstance:
+ - AvailabilityZone
+ x-stackql-resource-name: volume
+ description: |-
+ Specifies an Amazon Elastic Block Store (Amazon EBS) volume.
+ When you use CFNlong to update an Amazon EBS volume that modifies ``Iops``, ``Size``, or ``VolumeType``, there is a cooldown period before another operation can occur. This can cause your stack to report being in ``UPDATE_IN_PROGRESS`` or ``UPDATE_ROLLBACK_IN_PROGRESS`` for long periods of time.
+ Amazon EBS does not support sizing down an Amazon EBS volume. CFNlong does not attempt to modify an Amazon EBS volume to a smaller size on rollback.
+ Some common scenarios when you might encounter a cooldown period for Amazon EBS include:
+ + You successfully update an Amazon EBS volume and the update succeeds. When you attempt another update within the cooldown window, that update will be subject to a cooldown period.
+ + You successfully update an Amazon EBS volume and the update succeeds but another change in your ``update-stack`` call fails. The rollback will be subject to a cooldown period.
+
+ For more information on the coo
+ x-type-name: AWS::EC2::Volume
+ x-stackql-primary-identifier:
+ - VolumeId
+ x-read-only-properties:
+ - VolumeId
+ x-required-properties:
+ - AvailabilityZone
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateVolume
+ - ec2:DescribeVolumes
+ - ec2:DescribeVolumeAttribute
+ - ec2:ModifyVolumeAttribute
+ - ec2:CreateTags
+ - kms:GenerateDataKeyWithoutPlaintext
+ - kms:CreateGrant
+ read:
+ - ec2:DescribeVolumes
+ - ec2:DescribeVolumeAttribute
+ - ec2:DescribeTags
+ update:
+ - ec2:ModifyVolume
+ - ec2:ModifyVolumeAttribute
+ - ec2:DescribeVolumeAttribute
+ - ec2:DescribeVolumesModifications
+ - ec2:DescribeVolumes
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ delete:
+ - ec2:DeleteVolume
+ - ec2:CreateSnapshot
+ - ec2:DescribeSnapshots
+ - ec2:DeleteTags
+ - ec2:DescribeVolumes
+ list:
+ - ec2:DescribeVolumes
+ - ec2:DescribeTags
+ - ec2:DescribeVolumeAttribute
+ Ebs:
+ description: |-
+ Parameters for a block device for an EBS volume in an Amazon EC2 launch template.
+ ``Ebs`` is a property of [AWS::EC2::LaunchTemplate BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html).
+ additionalProperties: false
type: object
properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone.
- createDate:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The date when the Scheduled Instance was purchased.
- hourlyPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The hourly price for a single instance.
- instanceCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of instances.
- instanceType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The instance type.
- networkPlatform:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The network platform (EC2-Classic or EC2-VPC).
- nextSlotStartTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time for the next schedule to start.
- platform:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The platform (Linux/UNIX or Windows).
- previousSlotEndTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time that the previous schedule ended or will end.
- recurrence:
- allOf:
- - $ref: '#/components/schemas/ScheduledInstanceRecurrence'
- - description: The schedule recurrence.
- scheduledInstanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Scheduled Instance ID.
- slotDurationInHours:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of hours in the schedule.
- termEndDate:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The end date for the Scheduled Instance.
- termStartDate:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The start date for the Scheduled Instance.
- totalScheduledInstanceHours:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The total number of hours for a single instance for the entire term.
- description: Describes a Scheduled Instance.
- ReasonCodesList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReportInstanceReasonCodes'
- - xml:
- name: item
- RebootInstancesRequest:
+ SnapshotId:
+ description: The ID of the snapshot.
+ type: string
+ VolumeType:
+ description: The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide*.
+ type: string
+ KmsKeyId:
+ description: The ARN of the symmetric KMSlong (KMS) CMK used for encryption.
+ type: string
+ Encrypted:
+ description: Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
+ type: boolean
+ Throughput:
+ description: |-
+ The throughput to provision for a ``gp3`` volume, with a maximum of 1,000 MiB/s.
+ Valid Range: Minimum value of 125. Maximum value of 1000.
+ type: integer
+ Iops:
+ description: |-
+ The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
+ The following are the supported values for each volume type:
+ + ``gp3``: 3,000 - 16,000 IOPS
+ + ``io1``: 100 - 64,000 IOPS
+ + ``io2``: 100 - 256,000 IOPS
+
+ For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.
+ This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only.
+ type: integer
+ VolumeSize:
+ description: |-
+ The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
+ + ``gp2`` and ``gp3``: 1 - 16,384 GiB
+ + ``io1``: 4 - 16,384 GiB
+ + ``io2``: 4 - 65,536 GiB
+ + ``st1`` and ``sc1``: 125 - 16,384 GiB
+ + ``standard``: 1 - 1024 GiB
+ type: integer
+ DeleteOnTermination:
+ description: Indicates whether the EBS volume is deleted on instance termination.
+ type: boolean
+ BlockDeviceMapping:
type: object
+ additionalProperties: false
+ properties:
+ DeviceName:
+ type: string
+ Ebs:
+ $ref: '#/components/schemas/EbsBlockDevice'
+ NoDevice:
+ type: string
+ VirtualName:
+ type: string
required:
- - InstanceIds
- title: RebootInstancesRequest
+ - DeviceName
+ Instance:
+ type: object
properties:
+ Tenancy:
+ description: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
+ type: string
+ SecurityGroups:
+ uniqueItems: false
+ description: the names of the security groups. For a nondefault VPC, you must use security group IDs instead.
+ x-insertionOrder: false
+ type: array
+ items:
+ type: string
+ PrivateDnsName:
+ description: 'The private DNS name of the specified instance. For example: ip-10-24-34-0.ec2.internal.'
+ type: string
+ PrivateIpAddress:
+ description: '[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.'
+ type: string
+ UserData:
+ description: The user data to make available to the instance.
+ type: string
+ BlockDeviceMappings:
+ uniqueItems: false
+ description: The block device mapping entries that defines the block devices to attach to the instance at launch.
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/BlockDeviceMapping'
+ IamInstanceProfile:
+ description: The IAM instance profile.
+ type: string
+ Ipv6Addresses:
+ uniqueItems: false
+ description: '[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.'
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/InstanceIpv6Address'
+ KernelId:
+ description: The ID of the kernel.
+ type: string
+ SubnetId:
+ description: |+
+ [EC2-VPC] The ID of the subnet to launch the instance into.
+
+ type: string
+ EbsOptimized:
+ description: Indicates whether the instance is optimized for Amazon EBS I/O.
+ type: boolean
+ PropagateTagsToVolumeOnCreation:
+ description: Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. If you specify true and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false, those tags are not assigned to the attached volumes.
+ type: boolean
+ ElasticGpuSpecifications:
+ uniqueItems: false
+ description: An elastic GPU to associate with the instance.
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/ElasticGpuSpecification'
+ ElasticInferenceAccelerators:
+ uniqueItems: false
+ description: An elastic inference accelerator to associate with the instance.
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/ElasticInferenceAccelerator'
+ Volumes:
+ uniqueItems: false
+ description: The volumes to attach to the instance.
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/Volume'
+ PrivateIp:
+ description: 'The private IP address of the specified instance. For example: 10.24.34.0.'
+ type: string
+ Ipv6AddressCount:
+ description: '[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.'
+ type: integer
+ LaunchTemplate:
+ description: The launch template to use to launch the instances.
+ type: object
+ $ref: '#/components/schemas/LaunchTemplateSpecification'
+ EnclaveOptions:
+ description: Indicates whether the instance is enabled for AWS Nitro Enclaves.
+ additionalProperties: false
+ type: object
+ properties:
+ Enabled:
+ description: If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.
+ type: boolean
+ NetworkInterfaces:
+ uniqueItems: false
+ description: The network interfaces to associate with the instance.
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/NetworkInterface'
+ ImageId:
+ description: The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
+ type: string
+ InstanceType:
+ description: The instance type.
+ type: string
+ Monitoring:
+ description: Specifies whether detailed monitoring is enabled for the instance.
+ type: boolean
+ Tags:
+ uniqueItems: false
+ description: The tags to add to the instance.
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/Tag'
+ AdditionalInfo:
+ description: 'This property is reserved for internal use. If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX).'
+ type: string
+ HibernationOptions:
+ description: Indicates whether an instance is enabled for hibernation.
+ additionalProperties: false
+ type: object
+ properties:
+ Configured:
+ default: false
+ description: If you set this parameter to true, your instance is enabled for hibernation.
+ type: boolean
+ LicenseSpecifications:
+ uniqueItems: false
+ description: The license configurations.
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/LicenseSpecification'
InstanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceIdStringList'
- - description: The instance IDs.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- RecurringChargeFrequency:
+ description: The EC2 Instance ID.
+ type: string
+ PublicIp:
+ description: 'The public IP address of the specified instance. For example: 192.0.2.0.'
+ type: string
+ InstanceInitiatedShutdownBehavior:
+ description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
+ type: string
+ CpuOptions:
+ description: The CPU options for the instance.
+ additionalProperties: false
+ type: object
+ properties:
+ ThreadsPerCore:
+ type: integer
+ CoreCount:
+ type: integer
+ AvailabilityZone:
+ description: The Availability Zone of the instance.
+ type: string
+ PrivateDnsNameOptions:
+ description: The options for the instance hostname.
+ type: object
+ $ref: '#/components/schemas/PrivateDnsNameOptions'
+ HostId:
+ description: If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with. If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account.
+ type: string
+ HostResourceGroupArn:
+ description: The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
+ type: string
+ PublicDnsName:
+ description: 'The public DNS name of the specified instance. For example: ec2-107-20-50-45.compute-1.amazonaws.com.'
+ type: string
+ SecurityGroupIds:
+ uniqueItems: false
+ description: The IDs of the security groups.
+ x-insertionOrder: false
+ type: array
+ items:
+ type: string
+ DisableApiTermination:
+ description: If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
+ type: boolean
+ KeyName:
+ description: The name of the key pair.
+ type: string
+ RamdiskId:
+ description: The ID of the RAM disk to select.
+ type: string
+ SourceDestCheck:
+ description: Specifies whether to enable an instance launched in a VPC to perform NAT.
+ type: boolean
+ PlacementGroupName:
+ description: The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
+ type: string
+ SsmAssociations:
+ uniqueItems: false
+ description: The SSM document and parameter values in AWS Systems Manager to associate with this instance.
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/SsmAssociation'
+ VpcId:
+ description: The ID of the VPC that the instance is running in.
+ type: string
+ Affinity:
+ description: Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.
+ type: string
+ enum:
+ - default
+ - host
+ CreditSpecification:
+ description: The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.
+ additionalProperties: false
+ type: object
+ properties:
+ CPUCredits:
+ type: string
+ x-stackql-resource-name: instance
+ description: Resource Type definition for AWS::EC2::Instance
+ x-type-name: AWS::EC2::Instance
+ x-stackql-primary-identifier:
+ - InstanceId
+ x-create-only-properties:
+ - AvailabilityZone
+ - CpuOptions
+ - ElasticGpuSpecifications
+ - ElasticInferenceAccelerators
+ - EnclaveOptions
+ - HibernationOptions
+ - HostResourceGroupArn
+ - ImageId
+ - Ipv6AddressCount
+ - Ipv6Addresses
+ - KeyName
+ - LaunchTemplate
+ - LicenseSpecifications
+ - NetworkInterfaces
+ - PlacementGroupName
+ - PrivateIpAddress
+ - SecurityGroups
+ - SubnetId
+ x-conditional-create-only-properties:
+ - AdditionalInfo
+ - Affinity
+ - EbsOptimized
+ - HostId
+ - InstanceType
+ - KernelId
+ - PrivateDnsNameOptions
+ - RamdiskId
+ - SecurityGroupIds
+ - Tenancy
+ - UserData
+ - BlockDeviceMappings
+ x-write-only-properties:
+ - BlockDeviceMappings/*/BlockDeviceMapping/NoDevice
+ - BlockDeviceMappings/*/BlockDeviceMapping/VirtualName
+ - LicenseSpecification
+ - AdditionalInfo
+ - Ipv6AddressCount
+ - Ipv6Addresses
+ - PropagateTagsToVolumeOnCreation
+ x-read-only-properties:
+ - InstanceId
+ - PrivateIp
+ - PublicDnsName
+ - PublicIp
+ - PrivateDnsName
+ - VpcId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ tagProperty: /properties/Tags
+ cloudFormationSystemTags: true
+ x-required-permissions:
+ read:
+ - ec2:DescribeElasticGpus
+ - ec2:DescribeNetworkInterfaces
+ - ec2:DescribeVolumes
+ - ec2:DescribeInstances
+ - ec2:DescribeInstanceAttribute
+ - ec2:DescribeInstanceCreditSpecifications
+ - ec2:DescribeLaunchTemplates
+ - elastic-inference:DescribeAccelerators
+ - ssm:DescribeAssociation
+ - ssm:ListAssociations
+ create:
+ - iam:PassRole
+ - ec2:ModifyPrivateDnsNameOptions
+ - ec2:DescribeElasticGpus
+ - ec2:DescribeNetworkInterfaces
+ - ec2:DescribeVolumes
+ - ec2:RunInstances
+ - ec2:AssociateIamInstanceProfile
+ - ec2:DescribeIamInstanceProfileAssociations
+ - ec2:DescribeInstances
+ - ec2:DescribeSubnets
+ - ec2:DescribeKeyPairs
+ - ec2:DescribeSecurityGroups
+ - ec2:DescribeVpcs
+ - ec2:DescribeInstanceAttribute
+ - ec2:DescribeInstanceCreditSpecifications
+ - ec2:DescribeLaunchTemplates
+ - ec2:DescribeLaunchTemplateVersions
+ - ec2:DetachVolume
+ - ec2:DisassociateIamInstanceProfile
+ - ec2:ModifyInstanceAttribute
+ - ec2:ModifyInstanceCreditSpecification
+ - ec2:ModifyInstancePlacement
+ - ec2:MonitorInstances
+ - ec2:AttachVolume
+ - ec2:CreateTags
+ - ec2:ReplaceIamInstanceProfileAssociation
+ - ec2:StartInstances
+ - elastic-inference:DescribeAccelerators
+ - ssm:CreateAssociation
+ - ssm:DescribeAssociation
+ - ssm:ListAssociations
+ update:
+ - ec2:DescribeElasticGpus
+ - ec2:ModifyPrivateDnsNameOptions
+ - ec2:DescribeNetworkInterfaces
+ - ec2:AssociateIamInstanceProfile
+ - ec2:DescribeIamInstanceProfileAssociations
+ - ec2:DescribeInstances
+ - ec2:DescribeSubnets
+ - ec2:DescribeKeyPairs
+ - ec2:DescribeSecurityGroups
+ - ec2:DescribeVpcs
+ - ec2:DescribeInstanceAttribute
+ - ec2:DescribeInstanceCreditSpecifications
+ - ec2:DescribeLaunchTemplates
+ - ec2:DetachVolume
+ - ec2:DisassociateIamInstanceProfile
+ - ec2:ModifyInstanceAttribute
+ - ec2:ModifyInstanceCreditSpecification
+ - ec2:ModifyInstanceMaintenanceOptions
+ - ec2:ModifyInstancePlacement
+ - ec2:MonitorInstances
+ - ec2:AttachVolume
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ - ec2:ReplaceIamInstanceProfileAssociation
+ - ec2:StartInstances
+ - ec2:StopInstances
+ - ec2:UnmonitorInstances
+ - elastic-inference:DescribeAccelerators
+ - ssm:CreateAssociation
+ - ssm:DeleteAssociation
+ - ssm:DescribeAssociation
+ - ssm:ListAssociations
+ list:
+ - ec2:DescribeInstances
+ delete:
+ - ec2:DescribeInstances
+ - ec2:TerminateInstances
+ - ec2:DescribeElasticGpus
+ - ec2:DescribeNetworkInterfaces
+ - ec2:DescribeVolumes
+ - ec2:DescribeInstances
+ - ec2:DescribeInstanceAttribute
+ - ec2:DescribeInstanceCreditSpecifications
+ - ec2:DescribeLaunchTemplates
+ - elastic-inference:DescribeAccelerators
+ - ssm:DescribeAssociation
+ - ssm:ListAssociations
+ SecurityGroupId:
+ description: The ID of a security group for the endpoint.
type: string
- enum:
- - Hourly
- RecurringCharge:
- type: object
- properties:
- amount:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: The amount of the recurring charge.
- frequency:
- allOf:
- - $ref: '#/components/schemas/RecurringChargeFrequency'
- - description: The frequency of the recurring charge.
- description: Describes a recurring charge.
- RecurringChargesList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/RecurringCharge'
- - xml:
- name: item
- ReferencedSecurityGroup:
- type: object
- properties:
- groupId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the security group.
- peeringStatus:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The status of a VPC peering connection, if applicable.'
- userId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- vpcPeeringConnectionId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC peering connection.
- description: ' Describes the security group that is referenced in the security group rule.'
- Region:
+ InstanceConnectEndpoint:
type: object
properties:
- regionEndpoint:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Region service endpoint.
- regionName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the Region.
- optInStatus:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Region opt-in status. The possible values are opt-in-not-required, opted-in, and not-opted-in.'
- description: Describes a Region.
- RegionNames:
- type: array
- items:
- $ref: '#/components/schemas/String'
- minItems: 0
- maxItems: 10
- StringType:
- type: string
- minLength: 0
- maxLength: 64000
- RegisterImageRequest:
- type: object
+ Id:
+ description: The id of the instance connect endpoint
+ type: string
+ SubnetId:
+ description: The subnet id of the instance connect endpoint
+ type: string
+ ClientToken:
+ description: The client token of the instance connect endpoint.
+ type: string
+ PreserveClientIp:
+ description: If true, the address of the instance connect endpoint client is preserved when connecting to the end resource
+ type: boolean
+ Tags:
+ description: The tags of the instance connect endpoint.
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ SecurityGroupIds:
+ description: The security group IDs of the instance connect endpoint.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/SecurityGroupId'
required:
- - Name
- title: RegisterImageRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.'
- architecture:
- allOf:
- - $ref: '#/components/schemas/ArchitectureValues'
- - description: 'The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
The block device mapping entries.
If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can''t specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description for your AMI. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- enaSupport:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
- kernelId: - allOf: - - $ref: '#/components/schemas/KernelId' - - description: The ID of the kernel. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)
' - BillingProduct: - allOf: - - $ref: '#/components/schemas/BillingProductList' - - description: 'The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the Amazon Web Services Marketplace to bill for the use of an AMI.' - ramdiskId: - allOf: - - $ref: '#/components/schemas/RamdiskId' - - description: The ID of the RAM disk. - rootDeviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The device name of the root device volume (for example,/dev/sda1).'
- sriovNetSupport:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
- virtualizationType: - allOf: - - $ref: '#/components/schemas/StringType' - - description: 'Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.' - description: Contains the parameters for RegisterImage. - RegisterInstanceTagAttributeRequest: + - SubnetId + x-stackql-resource-name: instance_connect_endpoint + description: Resource Type definition for AWS::EC2::InstanceConnectEndpoint + x-type-name: AWS::EC2::InstanceConnectEndpoint + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - SubnetId + - ClientToken + - PreserveClientIp + - SecurityGroupIds + x-write-only-properties: + - ClientToken + x-read-only-properties: + - Id + x-required-properties: + - SubnetId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + x-required-permissions: + create: + - ec2:CreateInstanceConnectEndpoint + - ec2:DescribeInstanceConnectEndpoints + - ec2:CreateTags + - ec2:CreateNetworkInterface + - iam:CreateServiceLinkedRole + read: + - ec2:DescribeInstanceConnectEndpoints + update: + - ec2:DescribeInstanceConnectEndpoints + - ec2:CreateTags + - ec2:DeleteTags + delete: + - ec2:DeleteInstanceConnectEndpoint + - ec2:DescribeInstanceConnectEndpoints + list: + - ec2:DescribeInstanceConnectEndpoints + InternetGateway: type: object properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to register all tag keys in the current Region. Specifytrue to register all tag keys.
- InstanceTagKey:
- allOf:
- - $ref: '#/components/schemas/InstanceTagKeySet'
- - description: The tag keys to register.
- description: Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
- RegisterInstanceEventNotificationAttributesRequest:
+ InternetGatewayId:
+ description: ''
+ type: string
+ Tags:
+ description: Any tags to assign to the internet gateway.
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ x-stackql-resource-name: internet_gateway
+ description: Allocates an internet gateway for use with a VPC. After creating the Internet gateway, you then attach it to a VPC.
+ x-type-name: AWS::EC2::InternetGateway
+ x-stackql-primary-identifier:
+ - InternetGatewayId
+ x-read-only-properties:
+ - InternetGatewayId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: true
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateInternetGateway
+ - ec2:CreateTags
+ - ec2:DescribeInternetGateways
+ read:
+ - ec2:DescribeInternetGateways
+ delete:
+ - ec2:DeleteInternetGateway
+ - ec2:DescribeInternetGateways
+ update:
+ - ec2:DeleteTags
+ - ec2:CreateTags
+ - ec2:DescribeInternetGateways
+ list:
+ - ec2:DescribeInternetGateways
+ IpamOperatingRegion:
+ description: The regions IPAM Resource Discovery is enabled for. Allows for monitoring.
type: object
- title: RegisterInstanceEventNotificationAttributesRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/RegisterInstanceTagAttributeRequest'
- - description: Information about the tag keys to register.
- RegisterTransitGatewayMulticastGroupMembersRequest:
+ RegionName:
+ type: string
+ description: The name of the region.
+ required:
+ - RegionName
+ additionalProperties: false
+ IPAM:
type: object
- title: RegisterTransitGatewayMulticastGroupMembersRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayMulticastRegisteredGroupMembers:
+ IpamId:
+ description: Id of the IPAM.
+ type: string
+ Arn:
+ description: The Amazon Resource Name (ARN) of the IPAM.
+ type: string
+ DefaultResourceDiscoveryId:
+ description: The Id of the default resource discovery, created with this IPAM.
+ type: string
+ DefaultResourceDiscoveryAssociationId:
+ description: The Id of the default association to the default resource discovery, created with this IPAM.
+ type: string
+ ResourceDiscoveryAssociationCount:
+ description: The count of resource discoveries associated with this IPAM.
+ type: integer
+ Description:
+ type: string
+ PublicDefaultScopeId:
+ description: The Id of the default scope for publicly routable IP space, created with this IPAM.
+ type: string
+ maxLength: 255
+ PrivateDefaultScopeId:
+ description: The Id of the default scope for publicly routable IP space, created with this IPAM.
+ type: string
+ ScopeCount:
+ description: The number of scopes that currently exist in this IPAM.
+ type: integer
+ OperatingRegions:
+ description: The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/IpamOperatingRegion'
+ Tier:
+ description: The tier of the IPAM.
+ type: string
+ enum:
+ - free
+ - advanced
+ Tags:
+ description: An array of key-value pairs to apply to this resource.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ required: []
+ x-stackql-resource-name: ipam
+ description: Resource Schema of AWS::EC2::IPAM Type
+ x-type-name: AWS::EC2::IPAM
+ x-stackql-primary-identifier:
+ - IpamId
+ x-read-only-properties:
+ - IpamId
+ - Arn
+ - PublicDefaultScopeId
+ - PrivateDefaultScopeId
+ - ScopeCount
+ - ResourceDiscoveryAssociationCount
+ - DefaultResourceDiscoveryId
+ - DefaultResourceDiscoveryAssociationId
+ x-required-properties: []
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateIpam
+ - iam:CreateServiceLinkedRole
+ - ec2:CreateTags
+ - ec2:DescribeIpams
+ read:
+ - ec2:DescribeIpams
+ update:
+ - ec2:ModifyIpam
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ - ec2:DescribeIpams
+ delete:
+ - ec2:DeleteIpam
+ - ec2:DeleteTags
+ - ec2:DescribeIpams
+ list:
+ - ec2:DescribeIpams
+ Cidr:
+ description: Represents a single IPv4 or IPv6 CIDR
+ type: string
+ IPAMAllocation:
type: object
properties:
- transitGatewayMulticastDomainId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway multicast domain.
- registeredNetworkInterfaceIds:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The ID of the registered network interfaces.
- groupIpAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IP address assigned to the transit gateway multicast group.
- description: Describes the registered transit gateway multicast group members.
- RegisterTransitGatewayMulticastGroupSourcesRequest:
+ IpamPoolAllocationId:
+ description: Id of the allocation.
+ type: string
+ IpamPoolId:
+ description: Id of the IPAM Pool.
+ type: string
+ Cidr:
+ $ref: '#/components/schemas/Cidr'
+ NetmaskLength:
+ description: The desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
+ type: integer
+ Description:
+ type: string
+ required:
+ - IpamPoolId
+ x-stackql-resource-name: ipam_allocation
+ description: Resource Schema of AWS::EC2::IPAMAllocation Type
+ x-type-name: AWS::EC2::IPAMAllocation
+ x-stackql-primary-identifier:
+ - IpamPoolId
+ - IpamPoolAllocationId
+ - Cidr
+ x-create-only-properties:
+ - IpamPoolId
+ - Cidr
+ - Description
+ - NetmaskLength
+ x-write-only-properties:
+ - NetmaskLength
+ x-read-only-properties:
+ - IpamPoolAllocationId
+ x-required-properties:
+ - IpamPoolId
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:AllocateIpamPoolCidr
+ - ec2:GetIpamPoolAllocations
+ read:
+ - ec2:GetIpamPoolAllocations
+ delete:
+ - ec2:ReleaseIpamPoolAllocation
+ list:
+ - ec2:GetIpamPoolAllocations
+ ProvisionedCidr:
+ description: An address space to be inserted into this pool. All allocations must be made from this address space.
type: object
- title: RegisterTransitGatewayMulticastGroupSourcesRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayMulticastRegisteredGroupSources:
+ Cidr:
+ $ref: '#/components/schemas/Cidr'
+ required:
+ - Cidr
+ additionalProperties: false
+ SourceResource:
+ description: The resource associated with this pool's space. Depending on the ResourceType, setting a SourceResource changes which space can be provisioned in this pool and which types of resources can receive allocations
type: object
properties:
- transitGatewayMulticastDomainId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway multicast domain.
- registeredNetworkInterfaceIds:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The IDs of the network interfaces members registered with the transit gateway multicast group.
- groupIpAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IP address assigned to the transit gateway multicast group.
- description: Describes the members registered with the transit gateway multicast group.
- RejectTransitGatewayMulticastDomainAssociationsRequest:
+ ResourceId:
+ type: string
+ ResourceType:
+ type: string
+ ResourceRegion:
+ type: string
+ ResourceOwner:
+ type: string
+ required:
+ - ResourceId
+ - ResourceType
+ - ResourceRegion
+ - ResourceOwner
+ additionalProperties: false
+ IPAMPool:
type: object
- title: RejectTransitGatewayMulticastDomainAssociationsRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- RejectTransitGatewayPeeringAttachmentRequest:
- type: object
+ IpamPoolId:
+ description: Id of the IPAM Pool.
+ type: string
+ AddressFamily:
+ description: The address family of the address space in this pool. Either IPv4 or IPv6.
+ type: string
+ AllocationMinNetmaskLength:
+ description: The minimum allowed netmask length for allocations made from this pool.
+ type: integer
+ AllocationDefaultNetmaskLength:
+ description: The default netmask length for allocations made from this pool. This value is used when the netmask length of an allocation isn't specified.
+ type: integer
+ AllocationMaxNetmaskLength:
+ description: The maximum allowed netmask length for allocations made from this pool.
+ type: integer
+ AllocationResourceTags:
+ description: When specified, an allocation will not be allowed unless a resource has a matching set of tags.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ Arn:
+ description: The Amazon Resource Name (ARN) of the IPAM Pool.
+ type: string
+ AutoImport:
+ description: Determines what to do if IPAM discovers resources that haven't been assigned an allocation. If set to true, an allocation will be made automatically.
+ type: boolean
+ AwsService:
+ description: Limits which service in Amazon Web Services that the pool can be used in.
+ type: string
+ enum:
+ - ec2
+ Description:
+ type: string
+ IpamScopeId:
+ description: The Id of the scope this pool is a part of.
+ type: string
+ IpamScopeArn:
+ description: The Amazon Resource Name (ARN) of the scope this pool is a part of.
+ type: string
+ IpamScopeType:
+ description: Determines whether this scope contains publicly routable space or space for a private network
+ type: string
+ enum:
+ - public
+ - private
+ IpamArn:
+ description: The Amazon Resource Name (ARN) of the IPAM this pool is a part of.
+ type: string
+ Locale:
+ description: The region of this pool. If not set, this will default to "None" which will disable non-custom allocations. If the locale has been specified for the source pool, this value must match.
+ type: string
+ PoolDepth:
+ description: The depth of this pool in the source pool hierarchy.
+ type: integer
+ ProvisionedCidrs:
+ description: A list of cidrs representing the address space available for allocation in this pool.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/ProvisionedCidr'
+ PublicIpSource:
+ description: The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`.
+ type: string
+ enum:
+ - byoip
+ - amazon
+ PubliclyAdvertisable:
+ description: Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
+ type: boolean
+ SourceIpamPoolId:
+ description: The Id of this pool's source. If set, all space provisioned in this pool must be free space provisioned in the parent pool.
+ type: string
+ SourceResource:
+ $ref: '#/components/schemas/SourceResource'
+ State:
+ description: 'The state of this pool. This can be one of the following values: "create-in-progress", "create-complete", "modify-in-progress", "modify-complete", "delete-in-progress", or "delete-complete"'
+ type: string
+ enum:
+ - create-in-progress
+ - create-complete
+ - modify-in-progress
+ - modify-complete
+ - delete-in-progress
+ - delete-complete
+ StateMessage:
+ description: An explanation of how the pool arrived at it current state.
+ type: string
+ Tags:
+ description: An array of key-value pairs to apply to this resource.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
required:
- - TransitGatewayAttachmentId
- title: RejectTransitGatewayPeeringAttachmentRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- RejectTransitGatewayVpcAttachmentRequest:
- type: object
+ - IpamScopeId
+ - AddressFamily
+ x-stackql-resource-name: ipam_pool
+ description: Resource Schema of AWS::EC2::IPAMPool Type
+ x-type-name: AWS::EC2::IPAMPool
+ x-stackql-primary-identifier:
+ - IpamPoolId
+ x-create-only-properties:
+ - IpamScopeId
+ - SourceIpamPoolId
+ - Locale
+ - AddressFamily
+ - PubliclyAdvertisable
+ - PublicIpSource
+ - AwsService
+ - SourceResource
+ x-read-only-properties:
+ - IpamPoolId
+ - Arn
+ - IpamScopeArn
+ - IpamScopeType
+ - IpamArn
+ - PoolDepth
+ - State
+ - StateMessage
+ x-required-properties:
+ - IpamScopeId
+ - AddressFamily
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateIpamPool
+ - ec2:DescribeIpamPools
+ - ec2:ProvisionIpamPoolCidr
+ - ec2:GetIpamPoolCidrs
+ - ec2:CreateTags
+ read:
+ - ec2:DescribeIpamPools
+ - ec2:GetIpamPoolCidrs
+ update:
+ - ec2:ModifyIpamPool
+ - ec2:DescribeIpamPools
+ - ec2:GetIpamPoolCidrs
+ - ec2:ProvisionIpamPoolCidr
+ - ec2:DeprovisionIpamPoolCidr
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ delete:
+ - ec2:DeleteIpamPool
+ - ec2:DescribeIpamPools
+ - ec2:GetIpamPoolCidrs
+ - ec2:DeprovisionIpamPoolCidr
+ - ec2:DeleteTags
+ list:
+ - ec2:DescribeIpamPools
+ IPAMPoolCidr:
+ type: object
+ properties:
+ IpamPoolCidrId:
+ description: Id of the IPAM Pool Cidr.
+ type: string
+ IpamPoolId:
+ description: Id of the IPAM Pool.
+ type: string
+ Cidr:
+ description: Represents a single IPv4 or IPv6 CIDR
+ type: string
+ NetmaskLength:
+ description: The desired netmask length of the provision. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
+ type: integer
+ State:
+ description: Provisioned state of the cidr.
+ type: string
required:
- - TransitGatewayAttachmentId
- title: RejectTransitGatewayVpcAttachmentRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- RejectVpcEndpointConnectionsRequest:
- type: object
+ - IpamPoolId
+ x-stackql-resource-name: ipam_pool_cidr
+ description: Resource Schema of AWS::EC2::IPAMPoolCidr Type
+ x-type-name: AWS::EC2::IPAMPoolCidr
+ x-stackql-primary-identifier:
+ - IpamPoolId
+ - IpamPoolCidrId
+ x-create-only-properties:
+ - IpamPoolId
+ - Cidr
+ - NetmaskLength
+ x-read-only-properties:
+ - IpamPoolCidrId
+ - State
+ x-required-properties:
+ - IpamPoolId
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:ProvisionIpamPoolCidr
+ - ec2:GetIpamPoolCidrs
+ read:
+ - ec2:GetIpamPoolCidrs
+ delete:
+ - ec2:DeprovisionIpamPoolCidr
+ - ec2:GetIpamPoolCidrs
+ list:
+ - ec2:GetIpamPoolCidrs
+ IPAMResourceDiscovery:
+ type: object
+ properties:
+ IpamResourceDiscoveryId:
+ description: Id of the IPAM Pool.
+ type: string
+ OwnerId:
+ description: Owner Account ID of the Resource Discovery
+ type: string
+ OperatingRegions:
+ description: The regions Resource Discovery is enabled for. Allows resource discoveries to be created in these regions, as well as enabling monitoring
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/IpamOperatingRegion'
+ IpamResourceDiscoveryRegion:
+ description: 'The region the resource discovery is setup in. '
+ type: string
+ Description:
+ type: string
+ IsDefault:
+ description: Determines whether or not address space from this pool is publicly advertised. Must be set if and only if the pool is IPv6.
+ type: boolean
+ IpamResourceDiscoveryArn:
+ description: Amazon Resource Name (Arn) for the Resource Discovery.
+ type: string
+ State:
+ description: The state of this Resource Discovery.
+ type: string
+ Tags:
+ description: An array of key-value pairs to apply to this resource.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ required: []
+ x-stackql-resource-name: ipam_resource_discovery
+ description: Resource Schema of AWS::EC2::IPAMResourceDiscovery Type
+ x-type-name: AWS::EC2::IPAMResourceDiscovery
+ x-stackql-primary-identifier:
+ - IpamResourceDiscoveryId
+ x-read-only-properties:
+ - IpamResourceDiscoveryId
+ - IpamResourceDiscoveryArn
+ - OwnerId
+ - IpamResourceDiscoveryRegion
+ - IsDefault
+ - State
+ x-required-properties: []
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateIpamResourceDiscovery
+ - ec2:DescribeIpamResourceDiscoveries
+ - ec2:CreateTags
+ read:
+ - ec2:DescribeIpamResourceDiscoveries
+ update:
+ - ec2:ModifyIpamResourceDiscovery
+ - ec2:DescribeIpamResourceDiscoveries
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ delete:
+ - ec2:DeleteIpamResourceDiscovery
+ - ec2:DescribeIpamResourceDiscoveries
+ - ec2:DeleteTags
+ list:
+ - ec2:DescribeIpamResourceDiscoveries
+ IPAMResourceDiscoveryAssociation:
+ type: object
+ properties:
+ IpamArn:
+ description: Arn of the IPAM.
+ type: string
+ IpamRegion:
+ description: The home region of the IPAM.
+ type: string
+ IpamResourceDiscoveryAssociationId:
+ description: Id of the IPAM Resource Discovery Association.
+ type: string
+ IpamResourceDiscoveryId:
+ description: The Amazon Resource Name (ARN) of the IPAM Resource Discovery Association.
+ type: string
+ IpamId:
+ description: The Id of the IPAM this Resource Discovery is associated to.
+ type: string
+ IpamResourceDiscoveryAssociationArn:
+ description: The Amazon Resource Name (ARN) of the resource discovery association is a part of.
+ type: string
+ IsDefault:
+ description: If the Resource Discovery Association exists due as part of CreateIpam.
+ type: boolean
+ OwnerId:
+ description: The AWS Account ID for the account where the shared IPAM exists.
+ type: string
+ State:
+ description: The operational state of the Resource Discovery Association. Related to Create/Delete activities.
+ type: string
+ ResourceDiscoveryStatus:
+ description: The status of the resource discovery.
+ type: string
+ Tags:
+ description: An array of key-value pairs to apply to this resource.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
required:
- - ServiceId
- - VpcEndpointIds
- title: RejectVpcEndpointConnectionsRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointServiceId'
- - description: The ID of the service.
- VpcEndpointId:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointIdList'
- - description: The IDs of one or more VPC endpoints.
- RejectVpcPeeringConnectionRequest:
+ - IpamId
+ - IpamResourceDiscoveryId
+ x-stackql-resource-name: ipam_resource_discovery_association
+ description: Resource Schema of AWS::EC2::IPAMResourceDiscoveryAssociation Type
+ x-type-name: AWS::EC2::IPAMResourceDiscoveryAssociation
+ x-stackql-primary-identifier:
+ - IpamResourceDiscoveryAssociationId
+ x-create-only-properties:
+ - IpamId
+ - IpamResourceDiscoveryId
+ x-read-only-properties:
+ - IpamArn
+ - IpamRegion
+ - IpamResourceDiscoveryAssociationId
+ - IpamResourceDiscoveryAssociationArn
+ - IsDefault
+ - ResourceDiscoveryStatus
+ - State
+ - OwnerId
+ x-required-properties:
+ - IpamId
+ - IpamResourceDiscoveryId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:AssociateIpamResourceDiscovery
+ - ec2:DescribeIpamResourceDiscoveryAssociations
+ - ec2:CreateTags
+ read:
+ - ec2:DescribeIpamResourceDiscoveryAssociations
+ update:
+ - ec2:DescribeIpamResourceDiscoveryAssociations
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ delete:
+ - ec2:DisassociateIpamResourceDiscovery
+ - ec2:DescribeIpamResourceDiscoveryAssociations
+ - ec2:DeleteTags
+ list:
+ - ec2:DescribeIpamResourceDiscoveryAssociations
+ IPAMScope:
type: object
- required:
- - VpcPeeringConnectionId
- title: RejectVpcPeeringConnectionRequest
properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- vpcPeeringConnectionId:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnectionId'
- - description: The ID of the VPC peering connection.
- ReleaseAddressRequest:
+ IpamScopeId:
+ description: Id of the IPAM scope.
+ type: string
+ Arn:
+ description: The Amazon Resource Name (ARN) of the IPAM scope.
+ type: string
+ IpamId:
+ description: The Id of the IPAM this scope is a part of.
+ type: string
+ IpamArn:
+ description: The Amazon Resource Name (ARN) of the IPAM this scope is a part of.
+ type: string
+ IpamScopeType:
+ description: Determines whether this scope contains publicly routable space or space for a private network
+ type: string
+ enum:
+ - public
+ - private
+ IsDefault:
+ description: Is this one of the default scopes created with the IPAM.
+ type: boolean
+ Description:
+ type: string
+ PoolCount:
+ description: The number of pools that currently exist in this scope.
+ type: integer
+ Tags:
+ description: An array of key-value pairs to apply to this resource.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ required:
+ - IpamId
+ x-stackql-resource-name: ipam_scope
+ description: Resource Schema of AWS::EC2::IPAMScope Type
+ x-type-name: AWS::EC2::IPAMScope
+ x-stackql-primary-identifier:
+ - IpamScopeId
+ x-create-only-properties:
+ - IpamId
+ x-read-only-properties:
+ - IpamScopeId
+ - Arn
+ - IpamArn
+ - IsDefault
+ - PoolCount
+ - IpamScopeType
+ x-required-properties:
+ - IpamId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateIpamScope
+ - ec2:DescribeIpamScopes
+ - ec2:CreateTags
+ read:
+ - ec2:DescribeIpamScopes
+ update:
+ - ec2:ModifyIpamScope
+ - ec2:DescribeIpamScopes
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ delete:
+ - ec2:DeleteIpamScope
+ - ec2:DescribeIpamScopes
+ - ec2:DeleteTags
+ list:
+ - ec2:DescribeIpamScopes
+ KeyPair:
type: object
- title: ReleaseAddressRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you receive an InvalidParameterCombination error.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ReleaseHostsRequest:
- type: object
+ KeyName:
+ description: The name of the SSH key pair
+ type: string
+ KeyType:
+ description: The crypto-system used to generate a key pair.
+ type: string
+ default: rsa
+ enum:
+ - rsa
+ - ed25519
+ KeyFormat:
+ description: The format of the private key
+ type: string
+ default: pem
+ enum:
+ - pem
+ - ppk
+ PublicKeyMaterial:
+ description: Plain text public key to import
+ type: string
+ KeyFingerprint:
+ description: A short sequence of bytes used for public key verification
+ type: string
+ KeyPairId:
+ description: An AWS generated ID for the key pair
+ type: string
+ Tags:
+ description: An array of key-value pairs to apply to this resource.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
required:
- - HostIds
- title: ReleaseHostsRequest
- properties:
- hostId:
- allOf:
- - $ref: '#/components/schemas/RequestHostIdList'
- - description: The IDs of the Dedicated Hosts to release.
- ReleaseIpamPoolAllocationRequest:
+ - KeyName
+ x-stackql-resource-name: key_pair
+ description: The AWS::EC2::KeyPair creates an SSH key pair
+ x-type-name: AWS::EC2::KeyPair
+ x-stackql-primary-identifier:
+ - KeyName
+ x-stackql-additional-identifiers:
+ - - KeyPairId
+ x-create-only-properties:
+ - KeyName
+ - KeyType
+ - KeyFormat
+ - PublicKeyMaterial
+ - Tags
+ x-write-only-properties:
+ - KeyFormat
+ x-read-only-properties:
+ - KeyPairId
+ - KeyFingerprint
+ x-required-properties:
+ - KeyName
+ x-tagging:
+ taggable: true
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:CreateKeyPair
+ - ec2:ImportKeyPair
+ - ec2:CreateTags
+ - ssm:PutParameter
+ read:
+ - ec2:DescribeKeyPairs
+ list:
+ - ec2:DescribeKeyPairs
+ delete:
+ - ec2:DeleteKeyPair
+ - ssm:DeleteParameter
+ - ec2:DescribeKeyPairs
+ LaunchTemplateData:
+ description: |-
+ The information to include in the launch template.
+ You must specify at least one parameter for the launch template data.
+ additionalProperties: false
+ type: object
+ properties:
+ SecurityGroups:
+ uniqueItems: false
+ description: |-
+ The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
+ If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
+ type: array
+ items:
+ type: string
+ TagSpecifications:
+ uniqueItems: false
+ description: |-
+ The tags to apply to the resources that are created during instance launch.
+ To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).
+ To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).
+ type: array
+ items:
+ $ref: '#/components/schemas/TagSpecification'
+ UserData:
+ description: |-
+ The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Linux instance at launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) (Linux) or [Work with instance user data](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instancedata-add-user-data.html) (Windows) in the *Amazon Elastic Compute Cloud User Guide*.
+ If you are creating the launch template for use with BATCH, the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the *User Guide*.
+ type: string
+ BlockDeviceMappings:
+ uniqueItems: false
+ description: The block device mapping.
+ type: array
+ items:
+ $ref: '#/components/schemas/BlockDeviceMapping'
+ MaintenanceOptions:
+ description: The maintenance options of your instance.
+ $ref: '#/components/schemas/MaintenanceOptions'
+ IamInstanceProfile:
+ description: The name or Amazon Resource Name (ARN) of an IAM instance profile.
+ $ref: '#/components/schemas/IamInstanceProfile'
+ KernelId:
+ description: |-
+ The ID of the kernel.
+ We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*.
+ type: string
+ EbsOptimized:
+ description: Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
+ type: boolean
+ ElasticGpuSpecifications:
+ uniqueItems: false
+ description: |-
+ Deprecated.
+ Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
+ type: array
+ items:
+ $ref: '#/components/schemas/ElasticGpuSpecification'
+ ElasticInferenceAccelerators:
+ uniqueItems: false
+ description: |-
+ An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
+ You cannot specify accelerators from different generations in the same request.
+ Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
+ type: array
+ items:
+ $ref: '#/components/schemas/LaunchTemplateElasticInferenceAccelerator'
+ Placement:
+ description: The placement for the instance.
+ $ref: '#/components/schemas/Placement'
+ NetworkInterfaces:
+ uniqueItems: false
+ description: The network interfaces for the instance.
+ type: array
+ items:
+ $ref: '#/components/schemas/NetworkInterface'
+ EnclaveOptions:
+ description: |-
+ Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *Nitro Enclaves User Guide*.
+ You can't enable AWS Nitro Enclaves and hibernation on the same instance.
+ $ref: '#/components/schemas/EnclaveOptions'
+ ImageId:
+ description: |-
+ The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.
+ Valid formats:
+ + ``ami-17characters00000``
+ + ``resolve:ssm:parameter-name``
+ + ``resolve:ssm:parameter-name:version-number``
+ + ``resolve:ssm:parameter-name:label``
+
+ For more information, see [Use a Systems Manager parameter to find an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI) in the *Amazon Elastic Compute Cloud User Guide*.
+ type: string
+ InstanceType:
+ description: |-
+ The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*.
+ If you specify ``InstanceType``, you can't specify ``InstanceRequirements``.
+ type: string
+ Monitoring:
+ description: The monitoring for the instance.
+ $ref: '#/components/schemas/Monitoring'
+ HibernationOptions:
+ description: Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon Elastic Compute Cloud User Guide*.
+ $ref: '#/components/schemas/HibernationOptions'
+ MetadataOptions:
+ description: The metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon Elastic Compute Cloud User Guide*.
+ $ref: '#/components/schemas/MetadataOptions'
+ LicenseSpecifications:
+ uniqueItems: false
+ description: The license configurations.
+ type: array
+ items:
+ $ref: '#/components/schemas/LicenseSpecification'
+ InstanceInitiatedShutdownBehavior:
+ description: |-
+ Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
+ Default: ``stop``
+ type: string
+ DisableApiStop:
+ description: Indicates whether to enable the instance for stop protection. For more information, see [Stop protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection) in the *Amazon Elastic Compute Cloud User Guide*.
+ type: boolean
+ CpuOptions:
+ description: The CPU options for the instance. For more information, see [Optimizing CPU Options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon Elastic Compute Cloud User Guide*.
+ $ref: '#/components/schemas/CpuOptions'
+ PrivateDnsNameOptions:
+ description: The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.
+ $ref: '#/components/schemas/PrivateDnsNameOptions'
+ SecurityGroupIds:
+ uniqueItems: false
+ description: |-
+ The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template.
+ If you specify a network interface, you must specify any security groups as part of the network interface instead.
+ type: array
+ items:
+ type: string
+ KeyName:
+ description: |-
+ The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html).
+ If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
+ type: string
+ DisableApiTermination:
+ description: If you set this parameter to ``true``, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use [ModifyInstanceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html). Alternatively, if you set ``InstanceInitiatedShutdownBehavior`` to ``terminate``, you can terminate the instance by running the shutdown command from the instance.
+ type: boolean
+ InstanceMarketOptions:
+ description: The market (purchasing) option for the instances.
+ $ref: '#/components/schemas/InstanceMarketOptions'
+ InstanceRequirements:
+ description: |-
+ The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
+ You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.
+ When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
+ To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
+ + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
+ + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.
+
+ If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.
+ Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.
+ For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.
+ $ref: '#/components/schemas/InstanceRequirements'
+ RamDiskId:
+ description: |-
+ The ID of the RAM disk.
+ We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon Elastic Compute Cloud User Guide*.
+ type: string
+ CapacityReservationSpecification:
+ description: The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to ``open``, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
+ $ref: '#/components/schemas/CapacityReservationSpecification'
+ CreditSpecification:
+ description: The credit option for CPU usage of the instance. Valid only for T instances.
+ $ref: '#/components/schemas/CreditSpecification'
+ Ipv6Add:
+ description: |-
+ Specifies an IPv6 address in an Amazon EC2 launch template.
+ ``Ipv6Add`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).
+ additionalProperties: false
type: object
- required:
- - IpamPoolId
- - Cidr
- - IpamPoolAllocationId
- title: ReleaseIpamPoolAllocationRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/IpamPoolAllocationId'
- - description: The ID of the allocation.
- RemovePrefixListEntries:
- type: array
- items:
- $ref: '#/components/schemas/RemovePrefixListEntry'
- minItems: 0
- maxItems: 100
- ReplaceIamInstanceProfileAssociationRequest:
+ Ipv6Address:
+ description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
+ type: string
+ MaintenanceOptions:
+ description: The maintenance options of your instance.
+ additionalProperties: false
type: object
- required:
- - IamInstanceProfile
- - AssociationId
- title: ReplaceIamInstanceProfileAssociationRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/IamInstanceProfileAssociationId'
- - description: The ID of the existing IAM instance profile association.
- ReplaceNetworkAclAssociationRequest:
+ AutoRecovery:
+ description: Disables the automatic recovery behavior of your instance or sets it to default.
+ type: string
+ IamInstanceProfile:
+ description: |-
+ Specifies an IAM instance profile, which is a container for an IAM role for your instance. You can use an IAM role to distribute your AWS credentials to your instances.
+ If you are creating the launch template for use with an ASlong group, you can specify either the name or the ARN of the instance profile, but not both.
+ ``IamInstanceProfile`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).
+ additionalProperties: false
+ type: object
+ properties:
+ Arn:
+ description: The Amazon Resource Name (ARN) of the instance profile.
+ type: string
+ Name:
+ description: The name of the instance profile.
+ type: string
+ MemoryGiBPerVCpu:
+ description: The minimum and maximum amount of memory per vCPU, in GiB.
+ additionalProperties: false
type: object
- required:
- - AssociationId
- - NetworkAclId
- title: ReplaceNetworkAclAssociationRequest
properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/NetworkAclAssociationId'
- - description: The ID of the current association between the original network ACL and the subnet.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- networkAclId:
- allOf:
- - $ref: '#/components/schemas/NetworkAclId'
- - description: The ID of the new network ACL to associate with the subnet.
- ReplaceNetworkAclEntryRequest:
+ Min:
+ description: The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.
+ type: number
+ Max:
+ description: The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.
+ type: number
+ VCpuCount:
+ description: The minimum and maximum number of vCPUs.
+ additionalProperties: false
type: object
- required:
- - Egress
- - NetworkAclId
- - Protocol
- - RuleAction
- - RuleNumber
- title: ReplaceNetworkAclEntryRequest
properties:
- cidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).'
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- egress:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
' - Icmp: - allOf: - - $ref: '#/components/schemas/IcmpTypeCode' - - description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.' - ipv6CidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv6 network range to allow or deny, in CIDR notation (for example2001:bd8:1234:1a00::/64).'
- networkAclId:
- allOf:
- - $ref: '#/components/schemas/NetworkAclId'
- - description: The ID of the ACL.
- portRange:
- allOf:
- - $ref: '#/components/schemas/PortRange'
- - description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).'
- protocol:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.'
- ruleAction:
- allOf:
- - $ref: '#/components/schemas/RuleAction'
- - description: Indicates whether to allow or deny the traffic that matches the rule.
- ruleNumber:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The rule number of the entry to replace.
- ReplaceRootVolumeTaskState:
- type: string
- enum:
- - pending
- - in-progress
- - failing
- - succeeded
- - failed
- - failed-detached
- ReplaceRouteRequest:
+ Min:
+ description: The minimum number of vCPUs. To specify no minimum limit, specify ``0``.
+ type: integer
+ Max:
+ description: The maximum number of vCPUs. To specify no maximum limit, omit this parameter.
+ type: integer
+ Ipv4PrefixSpecification:
type: object
- required:
- - RouteTableId
- title: ReplaceRouteRequest
+ additionalProperties: false
properties:
- destinationCidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
- destinationIpv6CidrBlock:
- allOf:
- - $ref: '#/components/schemas/PrefixListResourceId'
- - description: The ID of the prefix list for the route.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointId'
- - description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
- egressOnlyInternetGatewayId:
- allOf:
- - $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
- - description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
- gatewayId:
- allOf:
- - $ref: '#/components/schemas/RouteGatewayId'
- - description: The ID of an internet gateway or virtual private gateway.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Specifies whether to reset the local route to its default target (local).
- natGatewayId:
- allOf:
- - $ref: '#/components/schemas/CarrierGatewayId'
- - description: '[IPv4 traffic only] The ID of a carrier gateway.'
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceId'
- - description: The ID of a network interface.
- routeTableId:
- allOf:
- - $ref: '#/components/schemas/RouteTableId'
- - description: The ID of the route table.
- vpcPeeringConnectionId:
- allOf:
- - $ref: '#/components/schemas/CoreNetworkArn'
- - description: The Amazon Resource Name (ARN) of the core network.
- ReplaceRouteTableAssociationRequest:
- type: object
+ Ipv4Prefix:
+ type: string
required:
- - AssociationId
- - RouteTableId
- title: ReplaceRouteTableAssociationRequest
- properties:
- associationId:
- allOf:
- - $ref: '#/components/schemas/RouteTableAssociationId'
- - description: The association ID.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- routeTableId:
- allOf:
- - $ref: '#/components/schemas/RouteTableId'
- - description: The ID of the new route table to associate with the subnet.
- ReplaceTransitGatewayRouteRequest:
+ - Ipv4Prefix
+ EnaSrdSpecification:
type: object
- required:
- - DestinationCidrBlock
- - TransitGatewayRouteTableId
- title: ReplaceTransitGatewayRouteRequest
+ additionalProperties: false
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ReplacementStrategy:
- type: string
- enum:
- - launch
- - launch-before-terminate
- ReportStatusType:
- type: string
- enum:
- - ok
- - impaired
- ReportInstanceStatusRequest:
+ EnaSrdEnabled:
+ type: boolean
+ EnaSrdUdpSpecification:
+ type: object
+ additionalProperties: false
+ properties:
+ EnaSrdUdpEnabled:
+ type: boolean
+ EnclaveOptions:
+ description: Indicates whether the instance is enabled for AWS Nitro Enclaves.
+ additionalProperties: false
type: object
- required:
- - Instances
- - ReasonCodes
- - Status
- title: ReportInstanceStatusRequest
properties:
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Descriptive text about the health state of your instance.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- endTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time at which the reported instance health state ended.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceIdStringList'
- - description: The instances.
- reasonCode:
- allOf:
- - $ref: '#/components/schemas/ReasonCodesList'
- - description: 'The reason codes that describe the health state of your instance.
instance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems that I believe are network related.
performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.
If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.'
- spotMaintenanceStrategies:
- allOf:
- - $ref: '#/components/schemas/SpotMaintenanceStrategies'
- - description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.'
- excessCapacityTerminationPolicy:
- allOf:
- - $ref: '#/components/schemas/ExcessCapacityTerminationPolicy'
- - description: Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
- fulfilledCapacity:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
- onDemandFulfilledCapacity:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
- iamFleetRole:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.'
- launchSpecifications:
- allOf:
- - $ref: '#/components/schemas/LaunchSpecsList'
- - description: 'The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can''t specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.'
- launchTemplateConfigs:
- allOf:
- - $ref: '#/components/schemas/LaunchTemplateConfigList'
- - description: 'The launch template and overrides. If you specify LaunchTemplateConfigs, you can''t specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.'
- spotPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
- targetCapacity:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.'
- onDemandTargetCapacity:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.'
- onDemandMaxTotalPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The maximum amount per hour for On-Demand Instances that you''re willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.'
- spotMaxTotalPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The maximum amount per hour for Spot Instances that you''re willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.'
- terminateInstancesWithExpiration:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
- type:
- allOf:
- - $ref: '#/components/schemas/FleetType'
- - description: 'The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.'
- validFrom:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.'
- validUntil:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.'
- replaceUnhealthyInstances:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether Spot Fleet should replace unhealthy instances.
- instanceInterruptionBehavior:
- allOf:
- - $ref: '#/components/schemas/InstanceInterruptionBehavior'
- - description: The behavior when a Spot Instance is interrupted. The default is terminate.
- loadBalancersConfig:
- allOf:
- - $ref: '#/components/schemas/LoadBalancersConfig'
- - description: 'One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
' - instancePoolsToUseCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
' - context: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - targetCapacityUnitType: - allOf: - - $ref: '#/components/schemas/TargetCapacityUnitType' - - description: 'The unit for the target capacity.
Default: units (translates to number of instances)
ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.'
- description: Describes the configuration of a Spot Fleet request.
- RequestSpotFleetRequest:
+ Enabled:
+ description: Specify ``true`` to enable detailed monitoring. Otherwise, basic monitoring is enabled.
+ type: boolean
+ MemoryMiB:
+ description: The minimum and maximum amount of memory, in MiB.
+ additionalProperties: false
type: object
- required:
- - SpotFleetRequestConfig
- title: RequestSpotFleetRequest
properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- spotFleetRequestConfig:
- allOf:
- - $ref: '#/components/schemas/SpotFleetRequestConfigData'
- - description: The configuration for the Spot Fleet request.
- description: Contains the parameters for RequestSpotFleet.
- RequestSpotLaunchSpecification:
+ Min:
+ description: The minimum amount of memory, in MiB. To specify no minimum limit, specify ``0``.
+ type: integer
+ Max:
+ description: The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.
+ type: integer
+ HibernationOptions:
+ description: |-
+ Specifies whether your instance is configured for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). For more information, see [Hibernate Your Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*.
+ ``HibernationOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).
+ additionalProperties: false
+ type: object
+ properties:
+ Configured:
+ description: |-
+ If you set this parameter to ``true``, the instance is enabled for hibernation.
+ Default: ``false``
+ type: boolean
+ MetadataOptions:
+ description: |-
+ The metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide*.
+ ``MetadataOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).
+ additionalProperties: false
+ type: object
+ properties:
+ HttpPutResponseHopLimit:
+ description: |-
+ The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
+ Default: ``1``
+ Possible values: Integers from 1 to 64
+ type: integer
+ HttpTokens:
+ description: |-
+ Indicates whether IMDSv2 is required.
+ + ``optional`` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.
+ + ``required`` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
+
+ Default: If the value of ``ImdsSupport`` for the Amazon Machine Image (AMI) for your instance is ``v2.0``, the default is ``required``.
+ type: string
+ HttpProtocolIpv6:
+ description: |-
+ Enables or disables the IPv6 endpoint for the instance metadata service.
+ Default: ``disabled``
+ type: string
+ InstanceMetadataTags:
+ description: |-
+ Set to ``enabled`` to allow access to instance tags from the instance metadata. Set to ``disabled`` to turn off access to instance tags from the instance metadata. For more information, see [Work with instance tags using the instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS).
+ Default: ``disabled``
+ type: string
+ HttpEndpoint:
+ description: |-
+ Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is ``enabled``.
+ If you specify a value of ``disabled``, you will not be able to access your instance metadata.
+ type: string
+ NetworkInterfaceCount:
+ description: The minimum and maximum number of network interfaces.
+ additionalProperties: false
type: object
properties:
- SecurityGroupId:
- allOf:
- - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupIdList'
- - description: One or more security group IDs.
- SecurityGroup:
- allOf:
- - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupList'
- - description: 'One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.'
- addressingType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Deprecated.
- blockDeviceMapping:
- allOf:
- - $ref: '#/components/schemas/BlockDeviceMappingList'
- - description: 'One or more block device mapping entries. You can''t specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.'
- ebsOptimized:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Indicates whether basic or detailed monitoring is enabled for the instance.
Default: Disabled
' - NetworkInterface: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecificationList' - - description: 'One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.' - placement: - allOf: - - $ref: '#/components/schemas/SpotPlacement' - - description: The placement information for the instance. - ramdiskId: - allOf: - - $ref: '#/components/schemas/RamdiskId' - - description: The ID of the RAM disk. - subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The ID of the subnet in which to launch the instance. - userData: - allOf: - - $ref: '#/components/schemas/String' - - description: The Base64-encoded user data for the instance. User data is limited to 16 KB. - description: Describes the launch specification for an instance. - RequestSpotInstancesRequest: + Min: + description: The minimum number of network interfaces. To specify no minimum limit, omit this parameter. + type: integer + Max: + description: The maximum number of network interfaces. To specify no maximum limit, omit this parameter. + type: integer + CpuOptions: + description: |- + Specifies the CPU options for an instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *User Guide*. + ``CpuOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html). + additionalProperties: false type: object - title: RequestSpotInstancesRequest properties: - availabilityZoneGroup: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
' - blockDurationMinutes: - allOf: - - $ref: '#/components/schemas/Integer' - - description: Deprecated. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- instanceCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The maximum number of Spot Instances to launch.
Default: 1
' - launchGroup: - allOf: - - $ref: '#/components/schemas/RequestSpotLaunchSpecification' - - description: The launch specification. - spotPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. - type: - allOf: - - $ref: '#/components/schemas/SpotInstanceType' - - description: 'The Spot Instance request type.
Default: one-time
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.
' - validUntil: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
terminate.
- description: Contains the parameters for RequestSpotInstances.
- ReservationFleetInstanceSpecificationList:
- type: array
- items:
- $ref: '#/components/schemas/ReservationFleetInstanceSpecification'
- ReservedInstanceLimitPrice:
+ ThreadsPerCore:
+ description: The number of threads per CPU core. To disable multithreading for the instance, specify a value of ``1``. Otherwise, specify the default value of ``2``.
+ type: integer
+ AmdSevSnp:
+ description: Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html).
+ type: string
+ enum:
+ - enabled
+ - disabled
+ CoreCount:
+ description: The number of CPU cores for the instance.
+ type: integer
+ SpotOptions:
+ description: |-
+ Specifies options for Spot Instances.
+ ``SpotOptions`` is a property of [AWS::EC2::LaunchTemplate InstanceMarketOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html).
+ additionalProperties: false
+ type: object
+ properties:
+ SpotInstanceType:
+ description: |-
+ The Spot Instance request type.
+ If you are using Spot Instances with an Auto Scaling group, use ``one-time`` requests, as the ASlong service handles requesting new Spot Instances whenever the group is below its desired capacity.
+ type: string
+ InstanceInterruptionBehavior:
+ description: The behavior when a Spot Instance is interrupted. The default is ``terminate``.
+ type: string
+ MaxPrice:
+ description: |-
+ The maximum hourly price you're willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
+ If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
+ type: string
+ BlockDurationMinutes:
+ description: Deprecated.
+ type: integer
+ ValidUntil:
+ description: |-
+ The end date of the request, in UTC format (*YYYY-MM-DD*T*HH:MM:SS*Z). Supported only for persistent requests.
+ + For a persistent request, the request remains active until the ``ValidUntil`` date and time is reached. Otherwise, the request remains active until you cancel it.
+ + For a one-time request, ``ValidUntil`` is not supported. The request remains active until all instances launch or you cancel the request.
+
+ Default: 7 days from the current date
+ type: string
+ PrivateIpAdd:
+ description: |-
+ Specifies a secondary private IPv4 address for a network interface.
+ ``PrivateIpAdd`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).
+ additionalProperties: false
+ type: object
+ properties:
+ PrivateIpAddress:
+ description: The private IPv4 address.
+ type: string
+ Primary:
+ description: Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
+ type: boolean
+ Ipv6PrefixSpecification:
type: object
+ additionalProperties: false
properties:
- amount:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
- currencyCode:
- allOf:
- - $ref: '#/components/schemas/CurrencyCodeValues'
- - description: 'The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.'
- description: Describes the limit price of a Reserved Instance offering.
- ReservedInstanceReservationValue:
+ Ipv6Prefix:
+ type: string
+ required:
+ - Ipv6Prefix
+ LaunchTemplateTagSpecification:
+ description: |-
+ Specifies the tags to apply to the launch template during creation.
+ ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html).
+ additionalProperties: false
type: object
properties:
- reservationValue:
- allOf:
- - $ref: '#/components/schemas/ReservationValue'
- - description: The total value of the Convertible Reserved Instance that you are exchanging.
- reservedInstanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Convertible Reserved Instance that you are exchanging.
- description: The total value of the Convertible Reserved Instance.
- ReservedInstanceState:
- type: string
- enum:
- - payment-pending
- - active
- - payment-failed
- - retired
- - queued
- - queued-deleted
- scope:
- type: string
- enum:
- - Availability Zone
- - Region
- ReservedInstances:
+ ResourceType:
+ description: The type of resource. To tag the launch template, ``ResourceType`` must be ``launch-template``.
+ type: string
+ Tags:
+ uniqueItems: false
+ description: The tags for the resource.
+ type: array
+ items:
+ $ref: '#/components/schemas/Tag'
+ EnaSrdUdpSpecification:
+ description: ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.
+ additionalProperties: false
+ type: object
+ properties:
+ EnaSrdUdpEnabled:
+ description: Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
+ type: boolean
+ NetworkBandwidthGbps:
+ description: |-
+ The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
+ Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide*.
+ additionalProperties: false
+ type: object
+ properties:
+ Min:
+ description: The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.
+ type: number
+ Max:
+ description: The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.
+ type: number
+ AcceleratorCount:
+ description: The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
+ additionalProperties: false
type: object
properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone in which the Reserved Instance can be used.
- duration:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: 'The duration of the Reserved Instance, in seconds.'
- end:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time when the Reserved Instance expires.
- fixedPrice:
- allOf:
- - $ref: '#/components/schemas/Float'
- - description: The purchase price of the Reserved Instance.
- instanceCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of reservations purchased.
- instanceType:
- allOf:
- - $ref: '#/components/schemas/InstanceType'
- - description: The instance type on which the Reserved Instance can be used.
- productDescription:
- allOf:
- - $ref: '#/components/schemas/RIProductDescription'
- - description: The Reserved Instance product platform description.
- reservedInstancesId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Reserved Instance.
- start:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The date and time the Reserved Instance started.
- state:
- allOf:
- - $ref: '#/components/schemas/ReservedInstanceState'
- - description: The state of the Reserved Instance purchase.
- usagePrice:
- allOf:
- - $ref: '#/components/schemas/Float'
- - description: 'The usage price of the Reserved Instance, per hour.'
- currencyCode:
- allOf:
- - $ref: '#/components/schemas/CurrencyCodeValues'
- - description: 'The currency of the Reserved Instance. It''s specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.'
- instanceTenancy:
- allOf:
- - $ref: '#/components/schemas/Tenancy'
- - description: The tenancy of the instance.
- offeringClass:
- allOf:
- - $ref: '#/components/schemas/OfferingClassType'
- - description: The offering class of the Reserved Instance.
- offeringType:
- allOf:
- - $ref: '#/components/schemas/OfferingTypeValues'
- - description: The Reserved Instance offering type.
- recurringCharges:
- allOf:
- - $ref: '#/components/schemas/RecurringChargesList'
- - description: The recurring charge tag assigned to the resource.
- scope:
- allOf:
- - $ref: '#/components/schemas/scope'
- - description: The scope of the Reserved Instance.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the resource.
- description: Describes a Reserved Instance.
- ReservedInstancesId:
+ Min:
+ description: The minimum number of accelerators. To specify no minimum limit, omit this parameter.
+ type: integer
+ Max:
+ description: The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set ``Max`` to ``0``.
+ type: integer
+ InstanceMarketOptions:
+ description: |-
+ Specifies the market (purchasing) option for an instance.
+ ``InstanceMarketOptions`` is a property of the [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).
+ additionalProperties: false
+ type: object
+ properties:
+ SpotOptions:
+ description: The options for Spot Instances.
+ $ref: '#/components/schemas/SpotOptions'
+ MarketType:
+ description: The market type.
+ type: string
+ LaunchTemplateElasticInferenceAccelerator:
+ description: |-
+ Specifies an elastic inference accelerator.
+ ``LaunchTemplateElasticInferenceAccelerator`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).
+ additionalProperties: false
+ type: object
+ properties:
+ Type:
+ description: The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
+ type: string
+ Count:
+ description: |-
+ The number of elastic inference accelerators to attach to the instance.
+ Default: 1
+ type: integer
+ BaselineEbsBandwidthMbps:
+ description: The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.
+ additionalProperties: false
type: object
properties:
- reservedInstancesId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Reserved Instance.
- description: Describes the ID of a Reserved Instance.
- ReservedInstancesListing:
+ Min:
+ description: The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.
+ type: integer
+ Max:
+ description: The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.
+ type: integer
+ InstanceRequirements:
+ description: |-
+ The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
+ You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.
+ When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
+ To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
+ + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
+ + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.
+
+ If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.
+ Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify ``InstanceRequirements``.
+ For more information, see [Attribute-based instance type selection for EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), [Attribute-based instance type selection for Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.
+ additionalProperties: false
+ type: object
+ properties:
+ LocalStorageTypes:
+ uniqueItems: false
+ description: |-
+ The type of local storage that is required.
+ + For instance types with hard disk drive (HDD) storage, specify ``hdd``.
+ + For instance types with solid state drive (SSD) storage, specify ``ssd``.
+
+ Default: ``hdd`` and ``ssd``
+ type: array
+ items:
+ type: string
+ InstanceGenerations:
+ uniqueItems: false
+ description: |-
+ Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.
+ For current generation instance types, specify ``current``.
+ For previous generation instance types, specify ``previous``.
+ Default: Current and previous generation instance types
+ type: array
+ items:
+ type: string
+ NetworkInterfaceCount:
+ description: |-
+ The minimum and maximum number of network interfaces.
+ Default: No minimum or maximum limits
+ $ref: '#/components/schemas/NetworkInterfaceCount'
+ MemoryGiBPerVCpu:
+ description: |-
+ The minimum and maximum amount of memory per vCPU, in GiB.
+ Default: No minimum or maximum limits
+ $ref: '#/components/schemas/MemoryGiBPerVCpu'
+ AcceleratorTypes:
+ uniqueItems: false
+ description: |-
+ The accelerator types that must be on the instance type.
+ + For instance types with GPU accelerators, specify ``gpu``.
+ + For instance types with FPGA accelerators, specify ``fpga``.
+ + For instance types with inference accelerators, specify ``inference``.
+
+ Default: Any accelerator type
+ type: array
+ items:
+ type: string
+ VCpuCount:
+ description: The minimum and maximum number of vCPUs.
+ $ref: '#/components/schemas/VCpuCount'
+ ExcludedInstanceTypes:
+ uniqueItems: false
+ description: |-
+ The instance types to exclude.
+ You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.
+ For example, if you specify ``c5*``,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
+ If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.
+ Default: No excluded instance types
+ type: array
+ items:
+ description: The user data to make available to the instance.
+ type: string
+ AcceleratorManufacturers:
+ uniqueItems: false
+ description: |-
+ Indicates whether instance types must have accelerators by specific manufacturers.
+ + For instance types with AWS devices, specify ``amazon-web-services``.
+ + For instance types with AMD devices, specify ``amd``.
+ + For instance types with Habana devices, specify ``habana``.
+ + For instance types with NVIDIA devices, specify ``nvidia``.
+ + For instance types with Xilinx devices, specify ``xilinx``.
+
+ Default: Any manufacturer
+ type: array
+ items:
+ type: string
+ AllowedInstanceTypes:
+ uniqueItems: false
+ description: |-
+ The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
+ You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.
+ For example, if you specify ``c5*``,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
+ If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.
+ Default: All instance types
+ type: array
+ items:
+ type: string
+ LocalStorage:
+ description: |-
+ Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*.
+ + To include instance types with instance store volumes, specify ``included``.
+ + To require only instance types with instance store volumes, specify ``required``.
+ + To exclude instance types with instance store volumes, specify ``excluded``.
+
+ Default: ``included``
+ type: string
+ CpuManufacturers:
+ uniqueItems: false
+ description: |-
+ The CPU manufacturers to include.
+ + For instance types with Intel CPUs, specify ``intel``.
+ + For instance types with AMD CPUs, specify ``amd``.
+ + For instance types with AWS CPUs, specify ``amazon-web-services``.
+
+ Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
+ Default: Any manufacturer
+ type: array
+ items:
+ type: string
+ AcceleratorCount:
+ description: |-
+ The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
+ To exclude accelerator-enabled instance types, set ``Max`` to ``0``.
+ Default: No minimum or maximum limits
+ $ref: '#/components/schemas/AcceleratorCount'
+ NetworkBandwidthGbps:
+ description: |-
+ The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
+ Default: No minimum or maximum limits
+ $ref: '#/components/schemas/NetworkBandwidthGbps'
+ BareMetal:
+ description: |-
+ Indicates whether bare metal instance types must be included, excluded, or required.
+ + To include bare metal instance types, specify ``included``.
+ + To require only bare metal instance types, specify ``required``.
+ + To exclude bare metal instance types, specify ``excluded``.
+
+ Default: ``excluded``
+ type: string
+ RequireHibernateSupport:
+ description: |-
+ Indicates whether instance types must support hibernation for On-Demand Instances.
+ This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html).
+ Default: ``false``
+ type: boolean
+ MaxSpotPriceAsPercentageOfOptimalOnDemandPrice:
+ description: >-
+ [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation
+ instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
+ The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
+ If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.
+ Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.
+ type: integer
+ SpotMaxPricePercentageOverLowestPrice:
+ description: >-
+ [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous
+ generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.
+ The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
+ If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
+ This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).
+ Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.
+ Default: ``100``
+ type: integer
+ BaselineEbsBandwidthMbps:
+ description: |-
+ The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.
+ Default: No minimum or maximum limits
+ $ref: '#/components/schemas/BaselineEbsBandwidthMbps'
+ OnDemandMaxPricePercentageOverLowestPrice:
+ description: |-
+ [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
+ The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
+ To turn off price protection, specify a high value, such as ``999999``.
+ This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).
+ If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
+ Default: ``20``
+ type: integer
+ AcceleratorNames:
+ uniqueItems: false
+ description: |-
+ The accelerators that must be on the instance type.
+ + For instance types with NVIDIA A10G GPUs, specify ``a10g``.
+ + For instance types with NVIDIA A100 GPUs, specify ``a100``.
+ + For instance types with NVIDIA H100 GPUs, specify ``h100``.
+ + For instance types with AWS Inferentia chips, specify ``inferentia``.
+ + For instance types with NVIDIA GRID K520 GPUs, specify ``k520``.
+ + For instance types with NVIDIA K80 GPUs, specify ``k80``.
+ + For instance types with NVIDIA M60 GPUs, specify ``m60``.
+ + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``.
+ + For instance types with NVIDIA T4 GPUs, specify ``t4``.
+ + For instance types with NVIDIA T4G GPUs, specify ``t4g``.
+ + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.
+ + For instance types with NVIDIA V100 GPUs, specify ``v100``.
+
+ Default: Any accelerator
+ type: array
+ items:
+ type: string
+ AcceleratorTotalMemoryMiB:
+ description: |-
+ The minimum and maximum amount of total accelerator memory, in MiB.
+ Default: No minimum or maximum limits
+ $ref: '#/components/schemas/AcceleratorTotalMemoryMiB'
+ BurstablePerformance:
+ description: |-
+ Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html).
+ + To include burstable performance instance types, specify ``included``.
+ + To require only burstable performance instance types, specify ``required``.
+ + To exclude burstable performance instance types, specify ``excluded``.
+
+ Default: ``excluded``
+ type: string
+ MemoryMiB:
+ description: The minimum and maximum amount of memory, in MiB.
+ $ref: '#/components/schemas/MemoryMiB'
+ TotalLocalStorageGB:
+ description: |-
+ The minimum and maximum amount of total local storage, in GB.
+ Default: No minimum or maximum limits
+ $ref: '#/components/schemas/TotalLocalStorageGB'
+ AcceleratorTotalMemoryMiB:
+ description: The minimum and maximum amount of total accelerator memory, in MiB.
+ additionalProperties: false
type: object
properties:
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.'
- createDate:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time the listing was created.
- instanceCounts:
- allOf:
- - $ref: '#/components/schemas/InstanceCountList'
- - description: The number of instances in this state.
- priceSchedules:
- allOf:
- - $ref: '#/components/schemas/PriceScheduleList'
- - description: The price of the Reserved Instance listing.
- reservedInstancesId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Reserved Instance.
- reservedInstancesListingId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Reserved Instance listing.
- status:
- allOf:
- - $ref: '#/components/schemas/ListingStatus'
- - description: The status of the Reserved Instance listing.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The reason for the current status of the Reserved Instance listing. The response can be blank.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the resource.
- updateDate:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The last modified timestamp of the listing.
- description: Describes a Reserved Instance listing.
- ReservedInstancesModificationResultList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesModificationResult'
- - xml:
- name: item
- ReservedIntancesIds:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesId'
- - xml:
- name: item
- ReservedInstancesModification:
+ Min:
+ description: The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.
+ type: integer
+ Max:
+ description: The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.
+ type: integer
+ CapacityReservationTarget:
+ description: |-
+ Specifies a target Capacity Reservation.
+ ``CapacityReservationTarget`` is a property of the [Amazon EC2 LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) property type.
+ additionalProperties: false
type: object
properties:
- clientToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.'
- createDate:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time when the modification request was created.
- effectiveDate:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time for the modification to become effective.
- modificationResultSet:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesModificationResultList'
- - description: Contains target configurations along with their corresponding new Reserved Instance IDs.
- reservedInstancesSet:
- allOf:
- - $ref: '#/components/schemas/ReservedIntancesIds'
- - description: The IDs of one or more Reserved Instances.
- reservedInstancesModificationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A unique ID for the Reserved Instance modification.
- status:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The status of the Reserved Instances modification request.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The reason for the status.
- updateDate:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time when the modification request was last updated.
- description: Describes a Reserved Instance modification.
- ReservedInstancesModificationResult:
+ CapacityReservationResourceGroupArn:
+ description: The ARN of the Capacity Reservation resource group in which to run the instance.
+ type: string
+ CapacityReservationId:
+ description: The ID of the Capacity Reservation in which to run the instance.
+ type: string
+ CapacityReservationSpecification:
+ description: |-
+ Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.
+ ``CapacityReservationSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).
+ additionalProperties: false
+ type: object
+ properties:
+ CapacityReservationPreference:
+ description: |-
+ Indicates the instance's Capacity Reservation preferences. Possible preferences include:
+ + ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
+ + ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
+ type: string
+ CapacityReservationTarget:
+ description: Information about the target Capacity Reservation or Capacity Reservation group.
+ $ref: '#/components/schemas/CapacityReservationTarget'
+ CreditSpecification:
+ description: |-
+ Specifies the credit option for CPU usage of a T2, T3, or T3a instance.
+ ``CreditSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).
+ additionalProperties: false
type: object
properties:
- reservedInstancesId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
- targetConfiguration:
- allOf:
- - $ref: '#/components/schemas/ReservedInstancesConfiguration'
- - description: The target Reserved Instances configurations supplied as part of the modification request.
- description: Describes the modification request/s.
- ReservedInstancesOffering:
+ CpuCredits:
+ description: |-
+ The credit option for CPU usage of a T instance.
+ Valid values: ``standard`` | ``unlimited``
+ type: string
+ TotalLocalStorageGB:
+ description: The minimum and maximum amount of total local storage, in GB.
+ additionalProperties: false
type: object
properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone in which the Reserved Instance can be used.
- duration:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: 'The duration of the Reserved Instance, in seconds.'
- fixedPrice:
- allOf:
- - $ref: '#/components/schemas/Float'
- - description: The purchase price of the Reserved Instance.
- instanceType:
- allOf:
- - $ref: '#/components/schemas/InstanceType'
- - description: The instance type on which the Reserved Instance can be used.
- productDescription:
- allOf:
- - $ref: '#/components/schemas/RIProductDescription'
- - description: The Reserved Instance product platform description.
- reservedInstancesOfferingId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
- usagePrice:
- allOf:
- - $ref: '#/components/schemas/Float'
- - description: 'The usage price of the Reserved Instance, per hour.'
- currencyCode:
- allOf:
- - $ref: '#/components/schemas/CurrencyCodeValues'
- - description: 'The currency of the Reserved Instance offering you are purchasing. It''s specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.'
- instanceTenancy:
- allOf:
- - $ref: '#/components/schemas/Tenancy'
- - description: The tenancy of the instance.
- marketplace:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it''s a Reserved Instance Marketplace offering, this is true.'
- offeringClass:
- allOf:
- - $ref: '#/components/schemas/OfferingClassType'
- - description: 'If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, it is not possible to perform an exchange.'
- offeringType:
- allOf:
- - $ref: '#/components/schemas/OfferingTypeValues'
- - description: The Reserved Instance offering type.
- pricingDetailsSet:
- allOf:
- - $ref: '#/components/schemas/PricingDetailsList'
- - description: The pricing details of the Reserved Instance offering.
- recurringCharges:
- allOf:
- - $ref: '#/components/schemas/RecurringChargesList'
- - description: The recurring charge tag assigned to the resource.
- scope:
- allOf:
- - $ref: '#/components/schemas/scope'
- - description: Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
- description: Describes a Reserved Instance offering.
- ResetAddressAttributeRequest:
+ Min:
+ description: The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.
+ type: number
+ Max:
+ description: The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.
+ type: number
+ ConnectionTrackingSpecification:
type: object
- required:
- - AllocationId
- - Attribute
- title: ResetAddressAttributeRequest
+ additionalProperties: false
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ResetEbsDefaultKmsKeyIdRequest:
+ TcpEstablishedTimeout:
+ type: integer
+ UdpStreamTimeout:
+ type: integer
+ UdpTimeout:
+ type: integer
+ LaunchTemplate:
type: object
- title: ResetEbsDefaultKmsKeyIdRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ResetFpgaImageAttributeName:
- type: string
- enum:
- - loadPermission
- ResetFpgaImageAttributeRequest:
- type: object
+ LaunchTemplateName:
+ description: A name for the launch template.
+ type: string
+ LaunchTemplateData:
+ description: The information for the launch template.
+ $ref: '#/components/schemas/LaunchTemplateData'
+ VersionDescription:
+ description: A description for the first version of the launch template.
+ type: string
+ TagSpecifications:
+ uniqueItems: false
+ description: |-
+ The tags to apply to the launch template on creation. To tag the launch template, the resource type must be ``launch-template``.
+ To specify the tags for the resources that are created when an instance is launched, you must use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications).
+ type: array
+ items:
+ $ref: '#/components/schemas/LaunchTemplateTagSpecification'
+ LatestVersionNumber:
+ description: ''
+ type: string
+ LaunchTemplateId:
+ description: ''
+ type: string
+ DefaultVersionNumber:
+ description: ''
+ type: string
required:
- - FpgaImageId
- title: ResetFpgaImageAttributeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ResetFpgaImageAttributeName'
- - description: The attribute.
- ResetImageAttributeName:
- type: string
- enum:
- - launchPermission
- ResetImageAttributeRequest:
+ - LaunchTemplateData
+ x-stackql-resource-name: launch_template
+ description: |-
+ Specifies the properties for creating a launch template.
+ The minimum required properties for specifying a launch template are as follows:
+ + You must specify at least one property for the launch template data.
+ + You do not need to specify a name for the launch template. If you do not specify a name, CFN creates the name for you.
+
+ A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ``ImageId`` property, which has no default value. If you do not specify an AMI ID for the launch template ``ImageId`` property, you must specify an AMI ID for the instance ``ImageId`` property.
+ For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*.
+ x-type-name: AWS::EC2::LaunchTemplate
+ x-stackql-primary-identifier:
+ - LaunchTemplateId
+ x-create-only-properties:
+ - LaunchTemplateName
+ x-write-only-properties:
+ - LaunchTemplateData
+ - VersionDescription
+ - TagSpecifications
+ x-read-only-properties:
+ - DefaultVersionNumber
+ - LaunchTemplateId
+ - LatestVersionNumber
+ x-required-properties:
+ - LaunchTemplateData
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ read:
+ - ec2:DescribeLaunchTemplates
+ create:
+ - ec2:CreateLaunchTemplate
+ - ec2:CreateTags
+ update:
+ - ec2:CreateLaunchTemplateVersion
+ list:
+ - ec2:DescribeLaunchTemplates
+ delete:
+ - ec2:DeleteLaunchTemplate
+ - ec2:DeleteTags
+ - ec2:DescribeLaunchTemplates
+ LocalGatewayRoute:
type: object
- required:
- - Attribute
- - ImageId
- title: ResetImageAttributeRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ImageId'
- - description: The ID of the AMI.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- description: Contains the parameters for ResetImageAttribute.
- ResetInstanceAttributeRequest:
+ DestinationCidrBlock:
+ description: The CIDR block used for destination matches.
+ type: string
+ LocalGatewayRouteTableId:
+ description: The ID of the local gateway route table.
+ type: string
+ LocalGatewayVirtualInterfaceGroupId:
+ description: The ID of the virtual interface group.
+ type: string
+ NetworkInterfaceId:
+ description: The ID of the network interface.
+ type: string
+ State:
+ description: The state of the route.
+ type: string
+ Type:
+ description: The route type.
+ type: string
+ x-stackql-resource-name: local_gateway_route
+ description: Describes a route for a local gateway route table.
+ x-type-name: AWS::EC2::LocalGatewayRoute
+ x-stackql-primary-identifier:
+ - DestinationCidrBlock
+ - LocalGatewayRouteTableId
+ x-create-only-properties:
+ - DestinationCidrBlock
+ - LocalGatewayRouteTableId
+ x-read-only-properties:
+ - State
+ - Type
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:CreateLocalGatewayRoute
+ - ec2:SearchLocalGatewayRoutes
+ read:
+ - ec2:SearchLocalGatewayRoutes
+ delete:
+ - ec2:DeleteLocalGatewayRoute
+ - ec2:SearchLocalGatewayRoutes
+ list:
+ - ec2:DescribeLocalGatewayRouteTables
+ - ec2:SearchLocalGatewayRoutes
+ update:
+ - ec2:ModifyLocalGatewayRoute
+ - ec2:SearchLocalGatewayRoutes
+ LocalGatewayRouteTable:
type: object
- required:
- - Attribute
- - InstanceId
- title: ResetInstanceAttributeRequest
properties:
- attribute:
- allOf:
- - $ref: '#/components/schemas/InstanceAttributeName'
- - description: 'The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- instanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: The ID of the instance.
- ResetNetworkInterfaceAttributeRequest:
+ LocalGatewayRouteTableId:
+ description: The ID of the local gateway route table.
+ type: string
+ LocalGatewayRouteTableArn:
+ description: The ARN of the local gateway route table.
+ type: string
+ LocalGatewayId:
+ description: The ID of the local gateway.
+ type: string
+ OutpostArn:
+ description: The ARN of the outpost.
+ type: string
+ OwnerId:
+ description: The owner of the local gateway route table.
+ type: string
+ State:
+ description: The state of the local gateway route table.
+ type: string
+ Mode:
+ description: The mode of the local gateway route table.
+ type: string
+ Tags:
+ description: The tags for the local gateway route table.
+ $ref: '#/components/schemas/Tags'
+ required:
+ - LocalGatewayId
+ x-stackql-resource-name: local_gateway_route_table
+ description: Describes a route table for a local gateway.
+ x-type-name: AWS::EC2::LocalGatewayRouteTable
+ x-stackql-primary-identifier:
+ - LocalGatewayRouteTableId
+ x-create-only-properties:
+ - LocalGatewayId
+ - Mode
+ x-read-only-properties:
+ - LocalGatewayRouteTableId
+ - LocalGatewayRouteTableArn
+ - OutpostArn
+ - OwnerId
+ - State
+ x-required-properties:
+ - LocalGatewayId
+ x-replacement-strategy: delete_then_create
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:CreateLocalGatewayRouteTable
+ - ec2:DescribeLocalGatewayRouteTables
+ - ec2:CreateTags
+ read:
+ - ec2:DescribeLocalGatewayRouteTables
+ update:
+ - ec2:DescribeLocalGatewayRouteTables
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ delete:
+ - ec2:DeleteLocalGatewayRouteTable
+ - ec2:DescribeLocalGatewayRouteTables
+ - ec2:DeleteTags
+ list:
+ - ec2:DescribeLocalGatewayRouteTables
+ LocalGatewayRouteTableVirtualInterfaceGroupAssociation:
type: object
- required:
- - NetworkInterfaceId
- title: ResetNetworkInterfaceAttributeRequest
properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceId'
- - description: The ID of the network interface.
- sourceDestCheck:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The source/destination checking attribute. Resets the value to true.
- description: Contains the parameters for ResetNetworkInterfaceAttribute.
- ResetSnapshotAttributeRequest:
- type: object
+ LocalGatewayRouteTableVirtualInterfaceGroupAssociationId:
+ description: The ID of the local gateway route table virtual interface group association.
+ type: string
+ LocalGatewayId:
+ description: The ID of the local gateway.
+ type: string
+ LocalGatewayRouteTableId:
+ description: The ID of the local gateway route table.
+ type: string
+ LocalGatewayRouteTableArn:
+ description: The ARN of the local gateway route table.
+ type: string
+ LocalGatewayVirtualInterfaceGroupId:
+ description: The ID of the local gateway route table virtual interface group.
+ type: string
+ OwnerId:
+ description: The owner of the local gateway route table virtual interface group association.
+ type: string
+ State:
+ description: The state of the local gateway route table virtual interface group association.
+ type: string
+ Tags:
+ description: The tags for the local gateway route table virtual interface group association.
+ $ref: '#/components/schemas/Tags'
required:
- - Attribute
- - SnapshotId
- title: ResetSnapshotAttributeRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/SnapshotId'
- - description: The ID of the snapshot.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ResourceList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- RestoreAddressToClassicRequest:
+ - LocalGatewayRouteTableId
+ - LocalGatewayVirtualInterfaceGroupId
+ x-stackql-resource-name: local_gateway_route_table_virtual_interface_group_association
+ description: Describes a local gateway route table virtual interface group association for a local gateway.
+ x-type-name: AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation
+ x-stackql-primary-identifier:
+ - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId
+ x-create-only-properties:
+ - LocalGatewayRouteTableId
+ - LocalGatewayVirtualInterfaceGroupId
+ x-read-only-properties:
+ - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId
+ - LocalGatewayId
+ - LocalGatewayRouteTableArn
+ - OwnerId
+ - State
+ x-required-properties:
+ - LocalGatewayRouteTableId
+ - LocalGatewayVirtualInterfaceGroupId
+ x-replacement-strategy: delete_then_create
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation
+ - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
+ - ec2:CreateTags
+ read:
+ - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
+ update:
+ - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ delete:
+ - ec2:DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation
+ - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
+ - ec2:DeleteTags
+ list:
+ - ec2:DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
+ LocalGatewayRouteTableVPCAssociation:
type: object
- required:
- - PublicIp
- title: RestoreAddressToClassicRequest
properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- publicIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Elastic IP address.
- RestoreImageFromRecycleBinRequest:
- type: object
+ LocalGatewayId:
+ description: The ID of the local gateway.
+ type: string
+ LocalGatewayRouteTableId:
+ description: The ID of the local gateway route table.
+ type: string
+ LocalGatewayRouteTableVpcAssociationId:
+ description: The ID of the association.
+ type: string
+ State:
+ description: The state of the association.
+ type: string
+ VpcId:
+ description: The ID of the VPC.
+ type: string
+ Tags:
+ description: The tags for the association.
+ $ref: '#/components/schemas/Tags'
required:
- - ImageId
- title: RestoreImageFromRecycleBinRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- RestoreManagedPrefixListVersionRequest:
+ - LocalGatewayRouteTableId
+ - VpcId
+ x-stackql-resource-name: local_gateway_route_tablevpc_association
+ description: Describes an association between a local gateway route table and a VPC.
+ x-type-name: AWS::EC2::LocalGatewayRouteTableVPCAssociation
+ x-stackql-primary-identifier:
+ - LocalGatewayRouteTableVpcAssociationId
+ x-create-only-properties:
+ - LocalGatewayRouteTableId
+ - VpcId
+ x-read-only-properties:
+ - LocalGatewayId
+ - LocalGatewayRouteTableVpcAssociationId
+ - State
+ x-required-properties:
+ - LocalGatewayRouteTableId
+ - VpcId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:CreateLocalGatewayRouteTableVpcAssociation
+ - ec2:DescribeLocalGatewayRouteTableVpcAssociations
+ - ec2:CreateTags
+ read:
+ - ec2:DescribeLocalGatewayRouteTableVpcAssociations
+ update:
+ - ec2:DescribeLocalGatewayRouteTableVpcAssociations
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ delete:
+ - ec2:DeleteLocalGatewayRouteTableVpcAssociation
+ - ec2:DescribeLocalGatewayRouteTableVpcAssociations
+ - ec2:DeleteTags
+ list:
+ - ec2:DescribeLocalGatewayRouteTableVpcAssociations
+ NatGateway:
type: object
- required:
- - PrefixListId
- - PreviousVersion
- - CurrentVersion
- title: RestoreManagedPrefixListVersionRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: The current version number for the prefix list.
- RestoreSnapshotFromRecycleBinRequest:
- type: object
+ SecondaryAllocationIds:
+ uniqueItems: true
+ description: Secondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon VPC User Guide*.
+ x-insertionOrder: true
+ type: array
+ items:
+ type: string
+ PrivateIpAddress:
+ description: The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.
+ type: string
+ ConnectivityType:
+ description: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
+ type: string
+ SecondaryPrivateIpAddresses:
+ uniqueItems: true
+ description: |-
+ Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.
+ ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.
+ x-insertionOrder: true
+ type: array
+ items:
+ type: string
+ SecondaryPrivateIpAddressCount:
+ description: |-
+ [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.
+ ``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.
+ type: integer
+ minimum: 1
+ AllocationId:
+ description: '[Public NAT gateway only] The allocation ID of the Elastic IP address that''s associated with the NAT gateway. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.'
+ type: string
+ SubnetId:
+ description: The ID of the subnet in which the NAT gateway is located.
+ type: string
+ NatGatewayId:
+ description: ''
+ type: string
+ Tags:
+ uniqueItems: false
+ description: The tags for the NAT gateway.
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/Tag'
+ MaxDrainDurationSeconds:
+ description: The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
+ type: integer
required:
- - SnapshotId
- title: RestoreSnapshotFromRecycleBinRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SnapshotState:
- type: string
- enum:
- - pending
- - completed
- - error
- - recoverable
- - recovering
- RestoreSnapshotTierRequest:
+ - SubnetId
+ x-stackql-resource-name: nat_gateway
+ description: |-
+ Specifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.
+ With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.
+ If you add a default route (``AWS::EC2::Route`` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's ``NatGatewayId`` property.
+ When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.
+ x-type-name: AWS::EC2::NatGateway
+ x-stackql-primary-identifier:
+ - NatGatewayId
+ x-create-only-properties:
+ - SubnetId
+ - ConnectivityType
+ - AllocationId
+ - PrivateIpAddress
+ x-write-only-properties:
+ - MaxDrainDurationSeconds
+ x-read-only-properties:
+ - NatGatewayId
+ x-required-properties:
+ - SubnetId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: true
+ x-required-permissions:
+ read:
+ - ec2:DescribeNatGateways
+ create:
+ - ec2:CreateNatGateway
+ - ec2:DescribeNatGateways
+ - ec2:CreateTags
+ update:
+ - ec2:DescribeNatGateways
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ - ec2:AssociateNatGatewayAddress
+ - ec2:DisassociateNatGatewayAddress
+ - ec2:AssignPrivateNatGatewayAddress
+ - ec2:UnassignPrivateNatGatewayAddress
+ list:
+ - ec2:DescribeNatGateways
+ delete:
+ - ec2:DeleteNatGateway
+ - ec2:DescribeNatGateways
+ NetworkAcl:
type: object
- required:
- - SnapshotId
- title: RestoreSnapshotTierRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- RestoreSnapshotTierRequestTemporaryRestoreDays:
- type: integer
- ResultRange:
- type: integer
- minimum: 20
- maximum: 500
- RevokeClientVpnIngressRequest:
- type: object
+ Id:
+ type: string
+ description: ''
+ Tags:
+ description: The tags for the network ACL.
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ VpcId:
+ description: The ID of the VPC for the network ACL.
+ type: string
required:
- - ClientVpnEndpointId
- - TargetNetworkCidr
- title: RevokeClientVpnIngressRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SecurityGroupRuleIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: item
- RevokeSecurityGroupEgressRequest:
+ - VpcId
+ x-stackql-resource-name: network_acl
+ description: Specifies a network ACL for your VPC.
+ x-type-name: AWS::EC2::NetworkAcl
+ x-stackql-primary-identifier:
+ - Id
+ x-create-only-properties:
+ - VpcId
+ x-read-only-properties:
+ - Id
+ x-required-properties:
+ - VpcId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: true
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateNetworkAcl
+ - ec2:DescribeNetworkAcls
+ - ec2:CreateTags
+ read:
+ - ec2:DescribeNetworkAcls
+ - ec2:DescribeTags
+ update:
+ - ec2:DescribeNetworkAcls
+ - ec2:DeleteTags
+ - ec2:CreateTags
+ delete:
+ - ec2:DeleteTags
+ - ec2:DeleteNetworkAcl
+ - ec2:DescribeNetworkAcls
+ list:
+ - ec2:DescribeNetworkAcls
+ AccessScopePathRequest:
type: object
- required:
- - GroupId
- title: RevokeSecurityGroupEgressRequest
- properties:
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- groupId:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - description: The ID of the security group.
- ipPermissions:
- allOf:
- - $ref: '#/components/schemas/IpPermissionList'
- - description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
- SecurityGroupRuleId:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRuleIdList'
- - description: The IDs of the security group rules.
- cidrIp:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Not supported. Use a set of IP permissions to specify the CIDR.
- fromPort:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: Not supported. Use a set of IP permissions to specify the port.
- ipProtocol:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Not supported. Use a set of IP permissions to specify the protocol name or number.
- toPort:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: Not supported. Use a set of IP permissions to specify the port.
- sourceSecurityGroupName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Not supported. Use a set of IP permissions to specify a destination security group.
- sourceSecurityGroupOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Not supported. Use a set of IP permissions to specify a destination security group.
- RevokeSecurityGroupIngressRequest:
+ additionalProperties: false
+ properties:
+ Source:
+ $ref: '#/components/schemas/PathStatementRequest'
+ Destination:
+ $ref: '#/components/schemas/PathStatementRequest'
+ ThroughResources:
+ type: array
+ x-insertionOrder: true
+ items:
+ $ref: '#/components/schemas/ThroughResourcesStatementRequest'
+ PathStatementRequest:
type: object
- title: RevokeSecurityGroupIngressRequest
+ additionalProperties: false
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.'
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SecurityGroupRuleId:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRuleIdList'
- - description: The IDs of the security group rules.
- RootDeviceType:
- type: string
- enum:
- - ebs
- - instance-store
- RouteOrigin:
- type: string
- enum:
- - CreateRouteTable
- - CreateRoute
- - EnableVgwRoutePropagation
- RouteState:
+ PacketHeaderStatement:
+ $ref: '#/components/schemas/PacketHeaderStatementRequest'
+ ResourceStatement:
+ $ref: '#/components/schemas/ResourceStatementRequest'
+ PacketHeaderStatementRequest:
+ type: object
+ additionalProperties: false
+ properties:
+ SourceAddresses:
+ type: array
+ x-insertionOrder: true
+ items:
+ type: string
+ DestinationAddresses:
+ type: array
+ x-insertionOrder: true
+ items:
+ type: string
+ SourcePorts:
+ type: array
+ x-insertionOrder: true
+ items:
+ type: string
+ DestinationPorts:
+ type: array
+ x-insertionOrder: true
+ items:
+ type: string
+ SourcePrefixLists:
+ type: array
+ x-insertionOrder: true
+ items:
+ type: string
+ DestinationPrefixLists:
+ type: array
+ x-insertionOrder: true
+ items:
+ type: string
+ Protocols:
+ type: array
+ x-insertionOrder: true
+ items:
+ $ref: '#/components/schemas/Protocol'
+ Protocol:
type: string
enum:
- - active
- - blackhole
- Route:
+ - tcp
+ - udp
+ ResourceStatementRequest:
type: object
+ additionalProperties: false
properties:
- destinationCidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv4 CIDR block used for the destination match.
- destinationIpv6CidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 CIDR block used for the destination match.
- destinationPrefixListId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The prefix of the Amazon Web Service.
- egressOnlyInternetGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the egress-only internet gateway.
- gatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of a gateway attached to your VPC.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of a NAT instance in your VPC.
- instanceOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of Amazon Web Services account that owns the instance.
- natGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of a NAT gateway.
- transitGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of a transit gateway.
- localGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the local gateway.
- carrierGatewayId:
- allOf:
- - $ref: '#/components/schemas/CarrierGatewayId'
- - description: The ID of the carrier gateway.
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the network interface.
- origin:
- allOf:
- - $ref: '#/components/schemas/RouteOrigin'
- - description: Describes how the route was created.
CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.
blackhole state indicates that the route''s target isn''t available (for example, the specified gateway isn''t attached to the VPC, or the specified NAT instance has been terminated).'
- vpcPeeringConnectionId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of a VPC peering connection.
- coreNetworkArn:
- allOf:
- - $ref: '#/components/schemas/CoreNetworkArn'
- - description: The Amazon Resource Name (ARN) of the core network.
- description: Describes a route in a route table.
- RouteList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/Route'
- - xml:
- name: item
- RouteTableAssociationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/RouteTableAssociation'
- - xml:
- name: item
- RouteTableAssociation:
+ Resources:
+ type: array
+ x-insertionOrder: true
+ items:
+ type: string
+ ResourceTypes:
+ type: array
+ x-insertionOrder: true
+ items:
+ type: string
+ ThroughResourcesStatementRequest:
type: object
+ additionalProperties: false
properties:
- main:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether this is the main route table.
- routeTableAssociationId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the association.
- routeTableId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the route table.
- subnetId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the subnet. A subnet ID is not returned for an implicit association.
- gatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the internet gateway or virtual private gateway.
- associationState:
- allOf:
- - $ref: '#/components/schemas/RouteTableAssociationState'
- - description: The state of the association.
- description: Describes an association between a route table and a subnet or gateway.
- RouteTableAssociationStateCode:
- type: string
- enum:
- - associating
- - associated
- - disassociating
- - disassociated
- - failed
- RouteTableIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/RouteTableId'
- - xml:
- name: item
- RunInstancesUserData:
- type: string
- format: password
- RunInstancesRequest:
+ ResourceStatement:
+ $ref: '#/components/schemas/ResourceStatementRequest'
+ NetworkInsightsAccessScope:
type: object
- required:
- - MaxCount
- - MinCount
- title: RunInstancesRequest
properties:
- BlockDeviceMapping:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: '[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you''ve specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
' - Ipv6Address: - allOf: - - $ref: '#/components/schemas/RamdiskId' - - description: 'The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface.
' - SecurityGroup: - allOf: - - $ref: '#/components/schemas/RunInstancesUserData' - - description: 'The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.' - additionalInfo: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
' - disableApiTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If you set this parameter to true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ebsOptimized:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
- TagSpecification: - allOf: - - $ref: '#/components/schemas/HibernationOptionsRequest' - - description: 'Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
You can''t enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
' - LicenseSpecification: - allOf: - - $ref: '#/components/schemas/InstanceMaintenanceOptionsRequest' - - description: The maintenance and recovery options for the instance. - RunScheduledInstancesRequest: + NetworkInsightsAccessScopeId: + type: string + NetworkInsightsAccessScopeArn: + type: string + CreatedDate: + type: string + UpdatedDate: + type: string + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + MatchPaths: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/AccessScopePathRequest' + ExcludePaths: + type: array + x-insertionOrder: true + items: + $ref: '#/components/schemas/AccessScopePathRequest' + x-stackql-resource-name: network_insights_access_scope + description: Resource schema for AWS::EC2::NetworkInsightsAccessScope + x-type-name: AWS::EC2::NetworkInsightsAccessScope + x-stackql-primary-identifier: + - NetworkInsightsAccessScopeId + x-stackql-additional-identifiers: + - - NetworkInsightsAccessScopeArn + x-create-only-properties: + - MatchPaths + - ExcludePaths + x-write-only-properties: + - MatchPaths + - ExcludePaths + x-read-only-properties: + - NetworkInsightsAccessScopeId + - NetworkInsightsAccessScopeArn + - CreatedDate + - UpdatedDate + x-required-permissions: + create: + - ec2:CreateNetworkInsightsAccessScope + - ec2:CreateTags + - tiros:CreateQuery + read: + - ec2:DescribeNetworkInsightsAccessScopes + - ec2:GetNetworkInsightsAccessScopeContent + update: + - ec2:DescribeNetworkInsightsAccessScopes + - ec2:GetNetworkInsightsAccessScopeContent + - ec2:CreateTags + - ec2:DeleteTags + delete: + - ec2:DeleteNetworkInsightsAccessScope + - ec2:DeleteTags + list: + - ec2:DescribeNetworkInsightsAccessScopes + NetworkInsightsAccessScopeAnalysis: type: object + properties: + NetworkInsightsAccessScopeAnalysisId: + type: string + NetworkInsightsAccessScopeAnalysisArn: + type: string + NetworkInsightsAccessScopeId: + type: string + Status: + type: string + enum: + - running + - failed + - succeeded + StatusMessage: + type: string + StartDate: + type: string + EndDate: + type: string + FindingsFound: + type: string + enum: + - 'true' + - 'false' + - unknown + AnalyzedEniCount: + type: integer + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - - LaunchSpecification - - ScheduledInstanceId - title: RunScheduledInstancesRequest + - NetworkInsightsAccessScopeId + x-stackql-resource-name: network_insights_access_scope_analysis + description: Resource schema for AWS::EC2::NetworkInsightsAccessScopeAnalysis + x-type-name: AWS::EC2::NetworkInsightsAccessScopeAnalysis + x-stackql-primary-identifier: + - NetworkInsightsAccessScopeAnalysisId + x-stackql-additional-identifiers: + - - NetworkInsightsAccessScopeAnalysisArn + x-create-only-properties: + - NetworkInsightsAccessScopeId + x-read-only-properties: + - NetworkInsightsAccessScopeAnalysisId + - NetworkInsightsAccessScopeAnalysisArn + - Status + - StatusMessage + - StartDate + - EndDate + - FindingsFound + - AnalyzedEniCount + x-required-properties: + - NetworkInsightsAccessScopeId + x-required-permissions: + create: + - ec2:CreateTags + - ec2:StartNetworkInsightsAccessScopeAnalysis + - ec2:GetTransitGatewayRouteTablePropagations + - ec2:Describe* + - elasticloadbalancing:Describe* + - directconnect:Describe* + - tiros:CreateQuery + - tiros:GetQueryAnswer + - tiros:GetQueryExplanation + read: + - ec2:DescribeNetworkInsightsAccessScopeAnalyses + update: + - ec2:DescribeNetworkInsightsAccessScopeAnalyses + - ec2:CreateTags + - ec2:DeleteTags + delete: + - ec2:DeleteNetworkInsightsAccessScopeAnalysis + - ec2:DeleteTags + list: + - ec2:DescribeNetworkInsightsAccessScopeAnalyses + PathComponent: + additionalProperties: false + type: object properties: - undefined: - allOf: - - $ref: '#/components/schemas/ScheduledInstanceId' - - description: The Scheduled Instance ID. - description: Contains the parameters for RunScheduledInstances. - S3ObjectTagList: - type: array - items: - allOf: - - $ref: '#/components/schemas/S3ObjectTag' - - xml: - name: item - ScheduledInstanceRecurrence: + AdditionalDetails: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/AdditionalDetail' + InboundHeader: + $ref: '#/components/schemas/AnalysisPacketHeader' + Vpc: + $ref: '#/components/schemas/AnalysisComponent' + DestinationVpc: + $ref: '#/components/schemas/AnalysisComponent' + SecurityGroupRule: + $ref: '#/components/schemas/AnalysisSecurityGroupRule' + TransitGateway: + $ref: '#/components/schemas/AnalysisComponent' + ElasticLoadBalancerListener: + $ref: '#/components/schemas/AnalysisComponent' + Explanations: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/Explanation' + ServiceName: + type: string + SequenceNumber: + type: integer + SourceVpc: + $ref: '#/components/schemas/AnalysisComponent' + OutboundHeader: + $ref: '#/components/schemas/AnalysisPacketHeader' + AclRule: + $ref: '#/components/schemas/AnalysisAclRule' + TransitGatewayRouteTableRoute: + $ref: '#/components/schemas/TransitGatewayRouteTableRoute' + Component: + $ref: '#/components/schemas/AnalysisComponent' + Subnet: + $ref: '#/components/schemas/AnalysisComponent' + RouteTableRoute: + $ref: '#/components/schemas/AnalysisRouteTableRoute' + AnalysisLoadBalancerListener: + additionalProperties: false type: object properties: - frequency: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The frequency (Daily, Weekly, or Monthly).'
- interval:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.'
- occurrenceDaySet:
- allOf:
- - $ref: '#/components/schemas/OccurrenceDaySet'
- - description: 'The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).'
- occurrenceRelativeToEnd:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the occurrence is relative to the end of the specified week or month.
- occurrenceUnit:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).
- description: Describes the recurring schedule for a Scheduled Instance.
- ScheduledInstanceAvailability:
+ InstancePort:
+ $ref: '#/components/schemas/Port'
+ LoadBalancerPort:
+ $ref: '#/components/schemas/Port'
+ AnalysisLoadBalancerTarget:
+ additionalProperties: false
type: object
properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone.
- availableInstanceCount:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of available instances.
- firstSlotStartTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The time period for the first schedule to start.
- hourlyPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The hourly price for a single instance.
- instanceType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The instance type. You can specify one of the C3, C4, M4, or R3 instance types.'
- maxTermDurationInDays:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The maximum term. The only possible value is 365 days.
- minTermDurationInDays:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The minimum term. The only possible value is 365 days.
- networkPlatform:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The network platform (EC2-Classic or EC2-VPC).
- platform:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The platform (Linux/UNIX or Windows).
- purchaseToken:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The purchase token. This token expires in two hours.
- recurrence:
- allOf:
- - $ref: '#/components/schemas/ScheduledInstanceRecurrence'
- - description: The schedule recurrence.
- slotDurationInHours:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of hours in the schedule.
- totalScheduledInstanceHours:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The total number of hours for a single instance for the entire term.
- description: Describes a schedule that is available for your Scheduled Instances.
- ScheduledInstanceIdRequestSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ScheduledInstanceId'
- - xml:
- name: ScheduledInstanceId
- ScheduledInstancesBlockDeviceMapping:
+ Address:
+ $ref: '#/components/schemas/IpAddress'
+ Instance:
+ $ref: '#/components/schemas/AnalysisComponent'
+ Port:
+ $ref: '#/components/schemas/Port'
+ AvailabilityZone:
+ type: string
+ Explanation:
+ additionalProperties: false
type: object
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
' - description: Describes a block device mapping for a Scheduled Instance. - ScheduledInstancesBlockDeviceMappingSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ScheduledInstancesBlockDeviceMapping' - - xml: - name: BlockDeviceMapping - ScheduledInstancesEbs: + VpnGateway: + $ref: '#/components/schemas/AnalysisComponent' + PacketField: + type: string + TransitGatewayAttachment: + $ref: '#/components/schemas/AnalysisComponent' + Protocols: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/Protocol' + IngressRouteTable: + $ref: '#/components/schemas/AnalysisComponent' + ClassicLoadBalancerListener: + $ref: '#/components/schemas/AnalysisLoadBalancerListener' + VpcPeeringConnection: + $ref: '#/components/schemas/AnalysisComponent' + Address: + $ref: '#/components/schemas/IpAddress' + Port: + $ref: '#/components/schemas/Port' + Addresses: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/IpAddress' + ElasticLoadBalancerListener: + $ref: '#/components/schemas/AnalysisComponent' + TransitGatewayRouteTable: + $ref: '#/components/schemas/AnalysisComponent' + ExplanationCode: + type: string + InternetGateway: + $ref: '#/components/schemas/AnalysisComponent' + SourceVpc: + $ref: '#/components/schemas/AnalysisComponent' + AttachedTo: + $ref: '#/components/schemas/AnalysisComponent' + PrefixList: + $ref: '#/components/schemas/AnalysisComponent' + TransitGatewayRouteTableRoute: + $ref: '#/components/schemas/TransitGatewayRouteTableRoute' + ComponentRegion: + type: string + LoadBalancerTargetGroup: + $ref: '#/components/schemas/AnalysisComponent' + NetworkInterface: + $ref: '#/components/schemas/AnalysisComponent' + CustomerGateway: + $ref: '#/components/schemas/AnalysisComponent' + DestinationVpc: + $ref: '#/components/schemas/AnalysisComponent' + SecurityGroup: + $ref: '#/components/schemas/AnalysisComponent' + TransitGateway: + $ref: '#/components/schemas/AnalysisComponent' + RouteTable: + $ref: '#/components/schemas/AnalysisComponent' + State: + type: string + LoadBalancerListenerPort: + $ref: '#/components/schemas/Port' + vpcEndpoint: + $ref: '#/components/schemas/AnalysisComponent' + Subnet: + $ref: '#/components/schemas/AnalysisComponent' + Cidrs: + uniqueItems: false + x-insertionOrder: true + type: array + items: + type: string + Destination: + $ref: '#/components/schemas/AnalysisComponent' + SecurityGroups: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/AnalysisComponent' + ComponentAccount: + type: string + VpnConnection: + $ref: '#/components/schemas/AnalysisComponent' + Vpc: + $ref: '#/components/schemas/AnalysisComponent' + NatGateway: + $ref: '#/components/schemas/AnalysisComponent' + Direction: + type: string + LoadBalancerTargetPort: + $ref: '#/components/schemas/Port' + LoadBalancerTarget: + $ref: '#/components/schemas/AnalysisLoadBalancerTarget' + LoadBalancerTargetGroups: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/AnalysisComponent' + Component: + $ref: '#/components/schemas/AnalysisComponent' + MissingComponent: + type: string + RouteTableRoute: + $ref: '#/components/schemas/AnalysisRouteTableRoute' + AvailabilityZones: + uniqueItems: false + x-insertionOrder: true + type: array + items: + type: string + PortRanges: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/PortRange' + Acl: + $ref: '#/components/schemas/AnalysisComponent' + SecurityGroupRule: + $ref: '#/components/schemas/AnalysisSecurityGroupRule' + SubnetRouteTable: + $ref: '#/components/schemas/AnalysisComponent' + LoadBalancerArn: + $ref: '#/components/schemas/ResourceArn' + AclRule: + $ref: '#/components/schemas/AnalysisAclRule' + Port: + type: integer + AnalysisPacketHeader: + additionalProperties: false + type: object + properties: + DestinationPortRanges: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/PortRange' + SourcePortRanges: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/PortRange' + DestinationAddresses: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/IpAddress' + Protocol: + $ref: '#/components/schemas/Protocol' + SourceAddresses: + uniqueItems: false + x-insertionOrder: true + type: array + items: + $ref: '#/components/schemas/IpAddress' + AdditionalDetail: + additionalProperties: false type: object properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The volume type. gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.
Default: gp2
Describes the launch specification for a Scheduled Instance.
If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- SearchTransitGatewayMulticastGroupsRequest:
+ From:
+ type: integer
+ To:
+ type: integer
+ IpAddress:
+ type: string
+ NetworkInsightsAnalysis:
type: object
- title: SearchTransitGatewayMulticastGroupsRequest
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- - description: The ID of the transit gateway multicast domain.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayMulticastGroupList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulticastGroup'
- - xml:
- name: item
- SearchTransitGatewayRoutesRequest:
- type: object
+ Status:
+ type: string
+ enum:
+ - running
+ - failed
+ - succeeded
+ ReturnPathComponents:
+ uniqueItems: false
+ x-insertionOrder: true
+ type: array
+ items:
+ $ref: '#/components/schemas/PathComponent'
+ NetworkInsightsAnalysisId:
+ type: string
+ NetworkInsightsPathId:
+ type: string
+ NetworkPathFound:
+ type: boolean
+ SuggestedAccounts:
+ uniqueItems: true
+ x-insertionOrder: true
+ type: array
+ items:
+ type: string
+ FilterInArns:
+ uniqueItems: false
+ x-insertionOrder: true
+ type: array
+ items:
+ $ref: '#/components/schemas/ResourceArn'
+ NetworkInsightsAnalysisArn:
+ type: string
+ StatusMessage:
+ type: string
+ StartDate:
+ type: string
+ AlternatePathHints:
+ uniqueItems: false
+ x-insertionOrder: true
+ type: array
+ items:
+ $ref: '#/components/schemas/AlternatePathHint'
+ Explanations:
+ uniqueItems: false
+ x-insertionOrder: true
+ type: array
+ items:
+ $ref: '#/components/schemas/Explanation'
+ ForwardPathComponents:
+ uniqueItems: false
+ x-insertionOrder: true
+ type: array
+ items:
+ $ref: '#/components/schemas/PathComponent'
+ AdditionalAccounts:
+ uniqueItems: true
+ x-insertionOrder: true
+ type: array
+ items:
+ type: string
+ Tags:
+ uniqueItems: true
+ type: array
+ items:
+ $ref: '#/components/schemas/Tag'
required:
- - TransitGatewayRouteTableId
- - Filters
- title: SearchTransitGatewayRoutesRequest
+ - NetworkInsightsPathId
+ x-stackql-resource-name: network_insights_analysis
+ description: Resource schema for AWS::EC2::NetworkInsightsAnalysis
+ x-type-name: AWS::EC2::NetworkInsightsAnalysis
+ x-stackql-primary-identifier:
+ - NetworkInsightsAnalysisId
+ x-stackql-additional-identifiers:
+ - - NetworkInsightsAnalysisArn
+ x-create-only-properties:
+ - NetworkInsightsPathId
+ - FilterInArns
+ x-read-only-properties:
+ - NetworkInsightsAnalysisId
+ - NetworkInsightsAnalysisArn
+ - StartDate
+ - Status
+ - StatusMessage
+ - NetworkPathFound
+ - ForwardPathComponents
+ - ReturnPathComponents
+ - Explanations
+ - AlternatePathHints
+ - SuggestedAccounts
+ x-required-properties:
+ - NetworkInsightsPathId
+ x-required-permissions:
+ read:
+ - ec2:Describe*
+ create:
+ - ec2:CreateTags
+ - ec2:StartNetworkInsightsAnalysis
+ - ec2:GetTransitGatewayRouteTablePropagations
+ - ec2:SearchTransitGatewayRoutes
+ - ec2:Describe*
+ - ec2:GetManagedPrefixListEntries
+ - elasticloadbalancing:Describe*
+ - directconnect:Describe*
+ - tiros:CreateQuery
+ - tiros:GetQueryAnswer
+ - tiros:GetQueryExplanation
+ update:
+ - ec2:CreateTags
+ - ec2:Describe*
+ - ec2:DeleteTags
+ list:
+ - ec2:Describe*
+ delete:
+ - ec2:DeleteNetworkInsightsAnalysis
+ - ec2:DeleteTags
+ FilterPortRange:
+ type: object
+ additionalProperties: false
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteTableId'
- - description: The ID of the transit gateway route table.
- Filter:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TransitGatewayRouteList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRoute'
- - xml:
- name: item
- SecurityGroup:
+ FromPort:
+ type: integer
+ ToPort:
+ type: integer
+ PathFilter:
type: object
+ additionalProperties: false
properties:
- groupDescription:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the security group.
- groupName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the security group.
- ipPermissions:
- allOf:
- - $ref: '#/components/schemas/IpPermissionList'
- - description: The inbound rules associated with the security group.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID of the owner of the security group.
- groupId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the security group.
- ipPermissionsEgress:
- allOf:
- - $ref: '#/components/schemas/IpPermissionList'
- - description: '[VPC only] The outbound rules associated with the security group.'
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the security group.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: '[VPC only] The ID of the VPC for the security group.'
- description: Describes a security group.
- SecurityGroupReference:
+ SourceAddress:
+ $ref: '#/components/schemas/IpAddress'
+ SourcePortRange:
+ $ref: '#/components/schemas/FilterPortRange'
+ DestinationAddress:
+ $ref: '#/components/schemas/IpAddress'
+ DestinationPortRange:
+ $ref: '#/components/schemas/FilterPortRange'
+ NetworkInsightsPath:
type: object
properties:
- groupId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of your security group.
- referencingVpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC with the referencing security group.
- vpcPeeringConnectionId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC peering connection.
- description: Describes a VPC with a security group that references your security group.
- SecurityGroupRuleId:
- type: string
- SecurityGroupRule:
+ NetworkInsightsPathId:
+ type: string
+ NetworkInsightsPathArn:
+ type: string
+ CreatedDate:
+ type: string
+ SourceIp:
+ $ref: '#/components/schemas/IpAddress'
+ FilterAtSource:
+ $ref: '#/components/schemas/PathFilter'
+ FilterAtDestination:
+ $ref: '#/components/schemas/PathFilter'
+ DestinationIp:
+ $ref: '#/components/schemas/IpAddress'
+ Source:
+ type: string
+ Destination:
+ type: string
+ SourceArn:
+ type: string
+ DestinationArn:
+ type: string
+ Protocol:
+ $ref: '#/components/schemas/Protocol'
+ DestinationPort:
+ $ref: '#/components/schemas/Port'
+ Tags:
+ type: array
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ required:
+ - Protocol
+ - Source
+ x-stackql-resource-name: network_insights_path
+ description: Resource schema for AWS::EC2::NetworkInsightsPath
+ x-type-name: AWS::EC2::NetworkInsightsPath
+ x-stackql-primary-identifier:
+ - NetworkInsightsPathId
+ x-stackql-additional-identifiers:
+ - - NetworkInsightsPathArn
+ x-create-only-properties:
+ - SourceIp
+ - DestinationIp
+ - Source
+ - Destination
+ - Protocol
+ - DestinationPort
+ - FilterAtSource
+ - FilterAtDestination
+ x-read-only-properties:
+ - NetworkInsightsPathId
+ - NetworkInsightsPathArn
+ - CreatedDate
+ - SourceArn
+ - DestinationArn
+ x-required-properties:
+ - Protocol
+ - Source
+ x-required-permissions:
+ create:
+ - ec2:CreateNetworkInsightsPath
+ - ec2:CreateTags
+ delete:
+ - ec2:DeleteNetworkInsightsPath
+ - ec2:DeleteTags
+ read:
+ - ec2:DescribeNetworkInsightsPaths
+ list:
+ - ec2:DescribeNetworkInsightsPaths
+ update:
+ - ec2:DescribeNetworkInsightsPaths
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ NetworkInterfaceAttachment:
type: object
properties:
- securityGroupRuleId:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRuleId'
- - description: The ID of the security group rule.
- groupId:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupId'
- - description: The ID of the security group.
- groupOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The ID of the Amazon Web Services account that owns the security group. '
- isEgress:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the security group rule is an outbound rule.
- ipProtocol:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
-1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes. '
- cidrIpv4:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv4 CIDR range.
- cidrIpv6:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 CIDR range.
- prefixListId:
- allOf:
- - $ref: '#/components/schemas/PrefixListResourceId'
- - description: The ID of the prefix list.
- referencedGroupInfo:
- allOf:
- - $ref: '#/components/schemas/ReferencedSecurityGroup'
- - description: Describes the security group that is referenced in the rule.
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The security group rule description.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags applied to the security group rule.
- description: Describes a security group rule.
- SecurityGroupRuleDescriptionList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRuleDescription'
- - xml:
- name: item
- SecurityGroupRuleRequest:
+ AttachmentId:
+ description: The ID of the network interface attachment.
+ type: string
+ DeleteOnTermination:
+ description: Whether to delete the network interface when the instance terminates. By default, this value is set to true.
+ type: boolean
+ default: true
+ DeviceIndex:
+ description: The network interface's position in the attachment order. For example, the first attached network interface has a DeviceIndex of 0.
+ type: string
+ InstanceId:
+ description: The ID of the instance to which you will attach the ENI.
+ type: string
+ NetworkInterfaceId:
+ description: The ID of the ENI that you want to attach.
+ type: string
+ EnaSrdSpecification:
+ $ref: '#/components/schemas/EnaSrdSpecification'
+ required:
+ - DeviceIndex
+ - InstanceId
+ - NetworkInterfaceId
+ x-stackql-resource-name: network_interface_attachment
+ description: Resource Type definition for AWS::EC2::NetworkInterfaceAttachment
+ x-type-name: AWS::EC2::NetworkInterfaceAttachment
+ x-stackql-primary-identifier:
+ - AttachmentId
+ x-stackql-additional-identifiers:
+ - - NetworkInterfaceId
+ x-create-only-properties:
+ - DeviceIndex
+ - InstanceId
+ - NetworkInterfaceId
+ x-read-only-properties:
+ - AttachmentId
+ x-required-properties:
+ - DeviceIndex
+ - InstanceId
+ - NetworkInterfaceId
+ x-replacement-strategy: delete_then_create
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:AttachNetworkInterface
+ - ec2:DescribeNetworkInterfaces
+ - ec2:ModifyNetworkInterfaceAttribute
+ read:
+ - ec2:DescribeNetworkInterfaces
+ list:
+ - ec2:DescribeNetworkInterfaces
+ update:
+ - ec2:ModifyNetworkInterfaceAttribute
+ - ec2:DescribeNetworkInterfaces
+ - ec2:AttachNetworkInterface
+ - ec2:DetachNetworkInterface
+ delete:
+ - ec2:DetachNetworkInterface
+ - ec2:DescribeNetworkInterfaces
+ NetworkPerformanceMetricSubscription:
+ type: object
+ properties:
+ Source:
+ description: The starting Region or Availability Zone for metric to subscribe to.
+ type: string
+ Destination:
+ description: The target Region or Availability Zone for the metric to subscribe to.
+ type: string
+ Metric:
+ description: The metric type to subscribe to.
+ type: string
+ Statistic:
+ description: The statistic to subscribe to.
+ type: string
+ required:
+ - Source
+ - Destination
+ - Metric
+ - Statistic
+ x-stackql-resource-name: network_performance_metric_subscription
+ description: Resource Type definition for AWS::EC2::NetworkPerformanceMetricSubscription
+ x-type-name: AWS::EC2::NetworkPerformanceMetricSubscription
+ x-stackql-primary-identifier:
+ - Source
+ - Destination
+ - Metric
+ - Statistic
+ x-create-only-properties:
+ - Source
+ - Destination
+ - Metric
+ - Statistic
+ x-required-properties:
+ - Source
+ - Destination
+ - Metric
+ - Statistic
+ x-tagging:
+ taggable: false
+ x-required-permissions:
+ create:
+ - ec2:DescribeAwsNetworkPerformanceMetricSubscriptions
+ - ec2:EnableAwsNetworkPerformanceMetricSubscription
+ read:
+ - ec2:DescribeAwsNetworkPerformanceMetricSubscriptions
+ delete:
+ - ec2:DescribeAwsNetworkPerformanceMetricSubscriptions
+ - ec2:DisableAwsNetworkPerformanceMetricSubscription
+ list:
+ - ec2:DescribeAwsNetworkPerformanceMetricSubscriptions
+ PlacementGroup:
type: object
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the security group rule.
- description: 'Describes a security group rule.
You must specify exactly one of the following parameters, based on the rule type:
CidrIpv4
CidrIpv6
PrefixListId
ReferencedGroupId
When you modify a rule, you cannot change the rule type. For example, if the rule uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 address range.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ServiceTypeDetailSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ServiceTypeDetail'
- - xml:
- name: item
- ServiceState:
- type: string
- enum:
- - Pending
- - Available
- - Deleting
- - Deleted
- - Failed
- SupportedIpAddressTypes:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ServiceConnectivityType'
- - xml:
- name: item
- minItems: 0
- maxItems: 2
- ServiceConnectivityType:
- type: string
- enum:
- - ipv4
- - ipv6
- ServiceDetail:
+ - Cidr
+ additionalProperties: false
+ PrefixList:
type: object
properties:
- serviceName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the service.
- serviceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the endpoint service.
- serviceType:
- allOf:
- - $ref: '#/components/schemas/ServiceTypeDetailSet'
- - description: The type of service.
- availabilityZoneSet:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The Availability Zones in which the service is available.
- owner:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Web Services account ID of the service owner.
- baseEndpointDnsNameSet:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The DNS names for the service.
- privateDnsName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The private DNS name for the service.
- privateDnsNameSet:
- allOf:
- - $ref: '#/components/schemas/PrivateDnsDetailsSet'
- - description: 'The private DNS names assigned to the VPC endpoint service. '
- vpcEndpointPolicySupported:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the service supports endpoint policies.
- acceptanceRequired:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
- managesVpcEndpoints:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
- payerResponsibility:
- allOf:
- - $ref: '#/components/schemas/PayerResponsibility'
- - description: The payer responsibility.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the service.
- privateDnsNameVerificationState:
- allOf:
- - $ref: '#/components/schemas/DnsNameState'
- - description: The verification state of the VPC endpoint service.
Consumers of the endpoint service cannot use the private name when the state is not verified.
standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
- lastTieringStartTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The date and time when the last archive or restore process was started.
- lastTieringProgress:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The progress of the last archive or restore process, as a percentage.'
- lastTieringOperationStatus:
- allOf:
- - $ref: '#/components/schemas/TieringOperationStatus'
- - description: The status of the last archive or restore process.
- lastTieringOperationStatusDetail:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A message describing the status of the last archive or restore process.
- archivalCompleteTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The date and time when the last archive process was completed.
- restoreExpiryTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
- description: Provides information about a snapshot's storage tier.
- SpotAllocationStrategy:
- type: string
- enum:
- - lowest-price
- - diversified
- - capacity-optimized
- - capacity-optimized-prioritized
+ CapacityRebalance:
+ $ref: '#/components/schemas/SpotCapacityRebalance'
SpotCapacityRebalance:
type: object
+ additionalProperties: false
properties:
- replacementStrategy:
- allOf:
- - $ref: '#/components/schemas/ReplacementStrategy'
- - description: 'The replacement strategy to use. Only available for fleets of type maintain.
launch - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay), terminates the instances that received a rebalance notification.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
Enables monitoring for the instance.
Default: false
error. After all requests are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating.'
- createTime:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The creation date and time of the request.
- spotFleetRequestConfig:
- allOf:
- - $ref: '#/components/schemas/SpotFleetRequestConfigData'
- - description: The configuration of the Spot Fleet request.
- spotFleetRequestId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Spot Fleet request.
- spotFleetRequestState:
- allOf:
- - $ref: '#/components/schemas/BatchState'
- - description: The state of the Spot Fleet request.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for a Spot Fleet resource.
- description: Describes a Spot Fleet request.
+ LaunchTemplateSpecification:
+ $ref: '#/components/schemas/FleetLaunchTemplateSpecification'
+ Overrides:
+ type: array
+ uniqueItems: true
+ items:
+ $ref: '#/components/schemas/LaunchTemplateOverrides'
SpotFleetTagSpecification:
type: object
+ additionalProperties: false
properties:
- resourceType:
- allOf:
- - $ref: '#/components/schemas/ResourceType'
- - description: 'The type of resource. Currently, the only resource type that is supported is instance. To tag the Spot Fleet request on creation, use the TagSpecifications parameter in SpotFleetRequestConfigData .'
- tag:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags.
- description: The tags for a Spot Fleet resource.
- SpotInstanceInterruptionBehavior:
- type: string
- enum:
- - hibernate
- - stop
- - terminate
- SpotInstanceState:
- type: string
- enum:
- - open
- - active
- - closed
- - cancelled
- - failed
- SpotInstanceStatus:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide for Linux Instances.'
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description for the status code.
- updateTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- description: Describes the status of a Spot Instance request.
- SpotInstanceRequest:
- type: object
- properties:
- actualBlockHourlyPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Deprecated.
- availabilityZoneGroup:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.'
- blockDurationMinutes:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: Deprecated.
- createTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- fault:
- allOf:
- - $ref: '#/components/schemas/SpotInstanceStateFault'
- - description: 'The fault codes for the Spot Instance request, if any.'
- instanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceId'
- - description: 'The instance ID, if an instance has been launched to fulfill the Spot Instance request.'
- launchGroup:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
- launchSpecification:
- allOf:
- - $ref: '#/components/schemas/LaunchSpecification'
- - description: Additional information for launching instances.
- launchedAvailabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone in which the request is launched.
- productDescription:
- allOf:
- - $ref: '#/components/schemas/RIProductDescription'
- - description: The product description associated with the Spot Instance.
- spotInstanceRequestId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Spot Instance request.
- spotPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The maximum price per hour that you are willing to pay for a Spot Instance.
- state:
- allOf:
- - $ref: '#/components/schemas/SpotInstanceState'
- - description: 'The state of the Spot Instance request. Spot request status information helps track your Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.'
- status:
- allOf:
- - $ref: '#/components/schemas/SpotInstanceStatus'
- - description: The status code and status message describing the Spot Instance request.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the resource.
- type:
- allOf:
- - $ref: '#/components/schemas/SpotInstanceType'
- - description: The Spot Instance request type.
- validFrom:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.'
- validUntil:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the validUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the validUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
1 to 10. A score of 10 indicates that your Spot request is highly likely to succeed in this Region or Availability Zone. A score of 1 indicates that your Spot request is not likely to succeed. '
- description: The Spot placement score for this Region or Availability Zone. The score is calculated based on the assumption that the capacity-optimized allocation strategy is used and that all of the Availability Zones in the Region can be used.
- SpotPlacementScoresMaxResults:
- type: integer
- minimum: 10
- maximum: 1000
- SpotPlacementScoresTargetCapacity:
- type: integer
- minimum: 1
- maximum: 2000000000
- SpotPrice:
+ LaunchTemplateId:
+ type: string
+ LaunchTemplateName:
+ type: string
+ minLength: 3
+ maxLength: 128
+ pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
+ Version:
+ type: string
+ required:
+ - Version
+ GroupIdentifier:
type: object
+ additionalProperties: false
properties:
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone.
- instanceType:
- allOf:
- - $ref: '#/components/schemas/InstanceType'
- - description: The instance type.
- productDescription:
- allOf:
- - $ref: '#/components/schemas/RIProductDescription'
- - description: A general description of the AMI.
- spotPrice:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The maximum price per hour that you are willing to pay for a Spot Instance.
- timestamp:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: 'The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
- description: Describes the maximum price per hour that you are willing to pay for a Spot Instance.
- UserIdGroupPairSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/UserIdGroupPair'
- - xml:
- name: item
- StaleIpPermission:
+ GroupId:
+ type: string
+ required:
+ - GroupId
+ IamInstanceProfileSpecification:
type: object
+ additionalProperties: false
properties:
- fromPort:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types. '
- ipProtocol:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).'
- ipRanges:
- allOf:
- - $ref: '#/components/schemas/IpRanges'
- - description: The IP ranges. Not applicable for stale security group rules.
- prefixListIds:
- allOf:
- - $ref: '#/components/schemas/PrefixListIdSet'
- - description: The prefix list IDs. Not applicable for stale security group rules.
- toPort:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types. '
- groups:
- allOf:
- - $ref: '#/components/schemas/UserIdGroupPairSet'
- - description: 'The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.'
- description: Describes a stale rule in a security group.
- StaleIpPermissionSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/StaleIpPermission'
- - xml:
- name: item
- StaleSecurityGroup:
+ Arn:
+ type: string
+ ClassicLoadBalancersConfig:
type: object
+ additionalProperties: false
properties:
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The description of the security group.
- groupId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the security group.
- groupName:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The name of the security group.
- staleIpPermissions:
- allOf:
- - $ref: '#/components/schemas/StaleIpPermissionSet'
- - description: Information about the stale inbound rules in the security group.
- staleIpPermissionsEgress:
- allOf:
- - $ref: '#/components/schemas/StaleIpPermissionSet'
- - description: Information about the stale outbound rules in the security group.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC for the security group.
- description: Describes a stale security group (a security group that contains stale rules).
- StartInstancesRequest:
- type: object
+ ClassicLoadBalancers:
+ type: array
+ uniqueItems: true
+ items:
+ $ref: '#/components/schemas/ClassicLoadBalancer'
required:
- - InstanceIds
- title: StartInstancesRequest
+ - ClassicLoadBalancers
+ LaunchTemplateOverrides:
+ type: object
+ additionalProperties: false
properties:
- InstanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceIdStringList'
- - description: The IDs of the instances.
- additionalInfo:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Reserved.
- dryRun:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- StartNetworkInsightsAccessScopeAnalysisRequest:
+ AvailabilityZone:
+ type: string
+ InstanceType:
+ type: string
+ SpotPrice:
+ type: string
+ SubnetId:
+ type: string
+ WeightedCapacity:
+ type: number
+ InstanceRequirements:
+ $ref: '#/components/schemas/InstanceRequirementsRequest'
+ Priority:
+ type: number
+ SpotFleetMonitoring:
type: object
- required:
- - NetworkInsightsAccessScopeId
- - ClientToken
- title: StartNetworkInsightsAccessScopeAnalysisRequest
+ additionalProperties: false
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- StartNetworkInsightsAnalysisRequest:
+ Enabled:
+ type: boolean
+ default: false
+ SpotPlacement:
type: object
- required:
- - NetworkInsightsPathId
- - ClientToken
- title: StartNetworkInsightsAnalysisRequest
+ additionalProperties: false
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/NetworkInsightsPathId'
- - description: The ID of the path.
- FilterInArn:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TagSpecification:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
- StartVpcEndpointServicePrivateDnsVerificationRequest:
+ AvailabilityZone:
+ type: string
+ GroupName:
+ type: string
+ Tenancy:
+ type: string
+ enum:
+ - dedicated
+ - default
+ - host
+ InstanceNetworkInterfaceSpecification:
type: object
- required:
- - ServiceId
- title: StartVpcEndpointServicePrivateDnsVerificationRequest
+ additionalProperties: false
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/VpcEndpointServiceId'
- - description: The ID of the endpoint service.
- State:
- type: string
- enum:
- - PendingAcceptance
- - Pending
- - Available
- - Deleting
- - Deleted
- - Rejected
- - Failed
- - Expired
- StaticSourcesSupportValue:
- type: string
- enum:
- - enable
- - disable
- StopInstancesRequest:
+ AssociatePublicIpAddress:
+ type: boolean
+ DeleteOnTermination:
+ type: boolean
+ Description:
+ type: string
+ DeviceIndex:
+ type: integer
+ Groups:
+ type: array
+ uniqueItems: true
+ items:
+ type: string
+ Ipv6AddressCount:
+ type: integer
+ Ipv6Addresses:
+ type: array
+ uniqueItems: true
+ items:
+ $ref: '#/components/schemas/InstanceIpv6Address'
+ NetworkInterfaceId:
+ type: string
+ PrivateIpAddresses:
+ type: array
+ uniqueItems: true
+ items:
+ $ref: '#/components/schemas/PrivateIpAddressSpecification'
+ SecondaryPrivateIpAddressCount:
+ type: integer
+ SubnetId:
+ type: string
+ TargetGroupsConfig:
type: object
- required:
- - InstanceIds
- title: StopInstancesRequest
+ additionalProperties: false
properties:
- InstanceId:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- force:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: 'Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
InProgress, Completed, or Failed).'
- storeTaskFailureReason:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'If the tasks fails, the reason for the failure is returned. If the task succeeds, null is returned.'
- description: 'The information about the AMI store task, including the progress of the task.'
- SubnetState:
- type: string
- enum:
- - pending
- - available
- SubnetIpv6CidrBlockAssociationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation'
- - xml:
- name: item
- TransitGatewayMulitcastDomainAssociationState:
- type: string
- enum:
- - pendingAcceptance
- - associating
- - associated
- - disassociating
- - disassociated
- - rejected
- - failed
- SubnetAssociation:
+ Arn:
+ type: string
+ required:
+ - Arn
+ ClassicLoadBalancer:
type: object
+ additionalProperties: false
properties:
- subnetId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the subnet.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayMulitcastDomainAssociationState'
- - description: The state of the subnet association.
- description: Describes the subnet association with the transit gateway multicast domain.
- SubnetAssociationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SubnetAssociation'
- - xml:
- name: item
- SubnetCidrBlockStateCode:
- type: string
- enum:
- - associating
- - associated
- - disassociating
- - disassociated
- - failing
- - failed
- SubnetCidrBlockState:
+ Name:
+ type: string
+ required:
+ - Name
+ SpotFleet:
+ type: object
+ properties:
+ Id:
+ type: string
+ SpotFleetRequestConfigData:
+ $ref: '#/components/schemas/SpotFleetRequestConfigData'
+ required:
+ - SpotFleetRequestConfigData
+ x-stackql-resource-name: spot_fleet
+ description: Resource Type definition for AWS::EC2::SpotFleet
+ x-type-name: AWS::EC2::SpotFleet
+ x-stackql-primary-identifier:
+ - Id
+ x-create-only-properties:
+ - SpotFleetRequestConfigData/AllocationStrategy
+ - SpotFleetRequestConfigData/IamFleetRole
+ - SpotFleetRequestConfigData/InstanceInterruptionBehavior
+ - SpotFleetRequestConfigData/InstancePoolsToUseCount
+ - SpotFleetRequestConfigData/LaunchSpecifications
+ - SpotFleetRequestConfigData/LaunchTemplateConfigs
+ - SpotFleetRequestConfigData/LoadBalancersConfig
+ - SpotFleetRequestConfigData/OnDemandAllocationStrategy
+ - SpotFleetRequestConfigData/OnDemandMaxTotalPrice
+ - SpotFleetRequestConfigData/OnDemandTargetCapacity
+ - SpotFleetRequestConfigData/ReplaceUnhealthyInstances
+ - SpotFleetRequestConfigData/SpotMaintenanceStrategies
+ - SpotFleetRequestConfigData/SpotMaxTotalPrice
+ - SpotFleetRequestConfigData/SpotPrice
+ - SpotFleetRequestConfigData/TagSpecifications
+ - SpotFleetRequestConfigData/TerminateInstancesWithExpiration
+ - SpotFleetRequestConfigData/Type
+ - SpotFleetRequestConfigData/ValidFrom
+ - SpotFleetRequestConfigData/ValidUntil
+ x-write-only-properties:
+ - SpotFleetRequestConfigData/TagSpecifications
+ - SpotFleetRequestConfigData/LaunchSpecifications/*/NetworkInterfaces/*/Groups
+ x-read-only-properties:
+ - Id
+ x-required-properties:
+ - SpotFleetRequestConfigData
+ x-required-permissions:
+ create:
+ - iam:PassRole
+ - ec2:CreateTags
+ - ec2:RequestSpotFleet
+ - ec2:DescribeSpotFleetRequests
+ - ec2:RunInstances
+ delete:
+ - ec2:DescribeSpotFleetRequests
+ - ec2:CancelSpotFleetRequests
+ list:
+ - ec2:DescribeSpotFleetRequests
+ read:
+ - ec2:DescribeSpotFleetRequests
+ update:
+ - ec2:ModifySpotFleetRequest
+ - ec2:DescribeSpotFleetRequests
+ Subnet:
type: object
properties:
- state:
- allOf:
- - $ref: '#/components/schemas/SubnetCidrBlockStateCode'
- - description: The state of a CIDR block.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A message about the status of the CIDR block, if applicable.'
- description: Describes the state of a CIDR block.
- SubnetCidrReservationId:
- type: string
- SubnetCidrReservationType:
- type: string
- enum:
- - prefix
- - explicit
- SuccessfulInstanceCreditSpecificationItem:
+ AssignIpv6AddressOnCreation:
+ type: boolean
+ description: |-
+ Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``.
+ If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.
+ VpcId:
+ type: string
+ description: |-
+ The ID of the VPC the subnet is in.
+ If you update this property, you must also update the ``CidrBlock`` property.
+ MapPublicIpOnLaunch:
+ type: boolean
+ description: |-
+ Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``.
+ AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).
+ EnableLniAtDeviceIndex:
+ type: integer
+ description: Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1).
+ NetworkAclAssociationId:
+ type: string
+ description: ''
+ AvailabilityZone:
+ type: string
+ description: |-
+ The Availability Zone of the subnet.
+ If you update this property, you must also update the ``CidrBlock`` property.
+ AvailabilityZoneId:
+ type: string
+ description: The AZ ID of the subnet.
+ CidrBlock:
+ type: string
+ description: |-
+ The IPv4 CIDR block assigned to the subnet.
+ If you update this property, we create a new subnet, and then delete the existing one.
+ SubnetId:
+ type: string
+ description: ''
+ Ipv6CidrBlocks:
+ type: array
+ uniqueItems: false
+ items:
+ type: string
+ description: The IPv6 network ranges for the subnet, in CIDR notation.
+ Ipv6CidrBlock:
+ type: string
+ description: |-
+ The IPv6 CIDR block.
+ If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.
+ OutpostArn:
+ type: string
+ description: The Amazon Resource Name (ARN) of the Outpost.
+ Ipv6Native:
+ type: boolean
+ description: Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.
+ EnableDns64:
+ type: boolean
+ description: Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*.
+ PrivateDnsNameOptionsOnLaunch:
+ type: object
+ additionalProperties: false
+ properties:
+ HostnameType:
+ type: string
+ EnableResourceNameDnsARecord:
+ type: boolean
+ EnableResourceNameDnsAAAARecord:
+ type: boolean
+ description: |-
+ The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.
+ Available options:
+ + EnableResourceNameDnsAAAARecord (true | false)
+ + EnableResourceNameDnsARecord (true | false)
+ + HostnameType (ip-name | resource-name)
+ Tags:
+ type: array
+ uniqueItems: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ description: Any tags assigned to the subnet.
+ Ipv4IpamPoolId:
+ type: string
+ description: An IPv4 IPAM pool ID for the subnet.
+ Ipv4NetmaskLength:
+ type: integer
+ description: An IPv4 netmask length for the subnet.
+ Ipv6IpamPoolId:
+ type: string
+ description: An IPv6 IPAM pool ID for the subnet.
+ Ipv6NetmaskLength:
+ type: integer
+ description: An IPv6 netmask length for the subnet.
+ required:
+ - VpcId
+ x-stackql-resource-name: subnet
+ description: |-
+ Specifies a subnet for the specified VPC.
+ For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
+ For more information, see [Subnets for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*.
+ x-type-name: AWS::EC2::Subnet
+ x-stackql-primary-identifier:
+ - SubnetId
+ x-create-only-properties:
+ - VpcId
+ - AvailabilityZone
+ - AvailabilityZoneId
+ - CidrBlock
+ - OutpostArn
+ - Ipv6Native
+ - Ipv4IpamPoolId
+ - Ipv4NetmaskLength
+ - Ipv6IpamPoolId
+ - Ipv6NetmaskLength
+ x-conditional-create-only-properties:
+ - Ipv6CidrBlock
+ x-write-only-properties:
+ - EnableLniAtDeviceIndex
+ - Ipv4IpamPoolId
+ - Ipv4NetmaskLength
+ - Ipv6IpamPoolId
+ - Ipv6NetmaskLength
+ x-read-only-properties:
+ - NetworkAclAssociationId
+ - SubnetId
+ x-required-properties:
+ - VpcId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: true
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:DescribeSubnets
+ - ec2:CreateSubnet
+ - ec2:CreateTags
+ - ec2:ModifySubnetAttribute
+ read:
+ - ec2:DescribeSubnets
+ - ec2:DescribeNetworkAcls
+ update:
+ - ec2:DescribeSubnets
+ - ec2:ModifySubnetAttribute
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ - ec2:AssociateSubnetCidrBlock
+ - ec2:DisassociateSubnetCidrBlock
+ delete:
+ - ec2:DescribeSubnets
+ - ec2:DeleteSubnet
+ list:
+ - ec2:DescribeSubnets
+ - ec2:DescribeNetworkAcls
+ SubnetCidrBlock:
+ type: object
+ properties:
+ Id:
+ description: Information about the IPv6 association.
+ type: string
+ Ipv6CidrBlock:
+ description: The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length
+ type: string
+ maxLength: 42
+ Ipv6IpamPoolId:
+ description: The ID of an IPv6 Amazon VPC IP Address Manager (IPAM) pool from which to allocate, to get the subnet's CIDR
+ type: string
+ Ipv6NetmaskLength:
+ description: The netmask length of the IPv6 CIDR to allocate to the subnet from an IPAM pool
+ type: integer
+ minimum: 0
+ maximum: 128
+ SubnetId:
+ description: The ID of the subnet
+ type: string
+ required:
+ - SubnetId
+ x-stackql-resource-name: subnet_cidr_block
+ description: The AWS::EC2::SubnetCidrBlock resource creates association between subnet and IPv6 CIDR
+ x-type-name: AWS::EC2::SubnetCidrBlock
+ x-stackql-primary-identifier:
+ - Id
+ x-create-only-properties:
+ - Ipv6CidrBlock
+ - SubnetId
+ - Ipv6IpamPoolId
+ - Ipv6NetmaskLength
+ x-write-only-properties:
+ - Ipv6IpamPoolId
+ - Ipv6NetmaskLength
+ x-read-only-properties:
+ - Id
+ x-required-properties:
+ - SubnetId
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:AssociateSubnetCidrBlock
+ - ec2:DescribeSubnets
+ delete:
+ - ec2:DisassociateSubnetCidrBlock
+ - ec2:DescribeSubnets
+ list:
+ - ec2:DescribeSubnets
+ read:
+ - ec2:DescribeSubnets
+ SubnetNetworkAclAssociation:
type: object
properties:
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance.
- description: Describes the burstable performance instance whose credit option for CPU usage was successfully modified.
- SuccessfulQueuedPurchaseDeletion:
+ SubnetId:
+ type: string
+ description: The ID of the subnet
+ NetworkAclId:
+ type: string
+ description: The ID of the network ACL
+ AssociationId:
+ type: string
+ required:
+ - NetworkAclId
+ - SubnetId
+ x-stackql-resource-name: subnet_network_acl_association
+ description: Resource Type definition for AWS::EC2::SubnetNetworkAclAssociation
+ x-type-name: AWS::EC2::SubnetNetworkAclAssociation
+ x-stackql-primary-identifier:
+ - AssociationId
+ x-create-only-properties:
+ - SubnetId
+ - NetworkAclId
+ x-read-only-properties:
+ - AssociationId
+ x-required-properties:
+ - NetworkAclId
+ - SubnetId
+ x-replacement-strategy: delete_then_create
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:DescribeNetworkAcls
+ - ec2:ReplaceNetworkAclAssociation
+ read:
+ - ec2:DescribeNetworkAcls
+ delete:
+ - ec2:DescribeNetworkAcls
+ - ec2:ReplaceNetworkAclAssociation
+ list:
+ - ec2:DescribeNetworkAcls
+ SubnetRouteTableAssociation:
type: object
properties:
- reservedInstancesId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Reserved Instance.
- description: Describes a Reserved Instance whose queued purchase was successfully deleted.
- TagDescription:
+ Id:
+ type: string
+ description: ''
+ RouteTableId:
+ type: string
+ description: |-
+ The ID of the route table.
+ The physical ID changes when the route table ID is changed.
+ SubnetId:
+ type: string
+ description: The ID of the subnet.
+ required:
+ - RouteTableId
+ - SubnetId
+ x-stackql-resource-name: subnet_route_table_association
+ description: Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. A route table can be associated with multiple subnets. To create a route table, see [AWS::EC2::RouteTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-routetable.html).
+ x-type-name: AWS::EC2::SubnetRouteTableAssociation
+ x-stackql-primary-identifier:
+ - Id
+ x-create-only-properties:
+ - SubnetId
+ - RouteTableId
+ x-read-only-properties:
+ - Id
+ x-required-properties:
+ - RouteTableId
+ - SubnetId
+ x-replacement-strategy: delete_then_create
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:AssociateRouteTable
+ - ec2:ReplaceRouteTableAssociation
+ - ec2:DescribeSubnets
+ - ec2:DescribeRouteTables
+ read:
+ - ec2:DescribeRouteTables
+ delete:
+ - ec2:DisassociateRouteTable
+ - ec2:DescribeSubnets
+ - ec2:DescribeRouteTables
+ list:
+ - ec2:DescribeRouteTables
+ TransitGateway:
type: object
properties:
- key:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The tag key.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/ResourceType'
- - description: The resource type.
- value:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The tag value.
- description: Describes a tag.
- TargetCapacitySpecificationRequest:
+ Description:
+ type: string
+ AssociationDefaultRouteTableId:
+ type: string
+ AutoAcceptSharedAttachments:
+ type: string
+ TransitGatewayArn:
+ type: string
+ DefaultRouteTablePropagation:
+ type: string
+ TransitGatewayCidrBlocks:
+ type: array
+ items:
+ type: string
+ PropagationDefaultRouteTableId:
+ type: string
+ DefaultRouteTableAssociation:
+ type: string
+ Id:
+ type: string
+ VpnEcmpSupport:
+ type: string
+ DnsSupport:
+ type: string
+ MulticastSupport:
+ type: string
+ AmazonSideAsn:
+ format: int64
+ type: integer
+ Tags:
+ uniqueItems: false
+ type: array
+ items:
+ $ref: '#/components/schemas/Tag'
+ x-stackql-resource-name: transit_gateway
+ description: Resource Type definition for AWS::EC2::TransitGateway
+ x-type-name: AWS::EC2::TransitGateway
+ x-stackql-primary-identifier:
+ - Id
+ x-create-only-properties:
+ - AmazonSideAsn
+ - MulticastSupport
+ x-read-only-properties:
+ - Id
+ - TransitGatewayArn
+ x-tagging:
+ taggable: true
+ x-required-permissions:
+ read:
+ - ec2:CreateTransitGateway
+ - ec2:CreateTags
+ - ec2:DescribeTransitGateways
+ - ec2:DescribeTags
+ - ec2:DeleteTransitGateway
+ - ec2:DeleteTags
+ - ec2:ModifyTransitGateway
+ - ec2:ModifyTransitGatewayOptions
+ create:
+ - ec2:CreateTransitGateway
+ - ec2:CreateTags
+ - ec2:DescribeTransitGateways
+ - ec2:DescribeTags
+ - ec2:DeleteTransitGateway
+ - ec2:DeleteTags
+ - ec2:ModifyTransitGateway
+ - ec2:ModifyTransitGatewayOptions
+ update:
+ - ec2:CreateTransitGateway
+ - ec2:CreateTags
+ - ec2:DescribeTransitGateways
+ - ec2:DescribeTags
+ - ec2:DeleteTransitGateway
+ - ec2:DeleteTags
+ - ec2:ModifyTransitGateway
+ - ec2:ModifyTransitGatewayOptions
+ list:
+ - ec2:CreateTransitGateway
+ - ec2:CreateTags
+ - ec2:DescribeTransitGateways
+ - ec2:DescribeTags
+ - ec2:DeleteTransitGateway
+ - ec2:DeleteTags
+ - ec2:ModifyTransitGateway
+ - ec2:ModifyTransitGatewayOptions
+ delete:
+ - ec2:CreateTransitGateway
+ - ec2:CreateTags
+ - ec2:DescribeTransitGateways
+ - ec2:DescribeTags
+ - ec2:DeleteTransitGateway
+ - ec2:DeleteTags
+ - ec2:ModifyTransitGateway
+ - ec2:ModifyTransitGatewayOptions
+ TransitGatewayAttachment:
type: object
- required:
- - TotalTargetCapacity
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/TargetCapacityUnitType'
- - description: 'The unit for the target capacity.
Default: units (translates to number of instances)
The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- TerminateConnectionStatusSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TerminateConnectionStatus'
- - xml:
- name: item
- TerminateConnectionStatus:
+ - TransitGatewayMulticastDomainId
+ - TransitGatewayAttachmentId
+ - SubnetId
+ x-stackql-resource-name: transit_gateway_multicast_domain_association
+ description: The AWS::EC2::TransitGatewayMulticastDomainAssociation type
+ x-type-name: AWS::EC2::TransitGatewayMulticastDomainAssociation
+ x-stackql-primary-identifier:
+ - TransitGatewayMulticastDomainId
+ - TransitGatewayAttachmentId
+ - SubnetId
+ x-create-only-properties:
+ - TransitGatewayMulticastDomainId
+ - TransitGatewayAttachmentId
+ - SubnetId
+ x-read-only-properties:
+ - ResourceId
+ - ResourceType
+ - State
+ x-required-properties:
+ - TransitGatewayMulticastDomainId
+ - TransitGatewayAttachmentId
+ - SubnetId
+ x-required-permissions:
+ create:
+ - ec2:AssociateTransitGatewayMulticastDomain
+ - ec2:GetTransitGatewayMulticastDomainAssociations
+ read:
+ - ec2:GetTransitGatewayMulticastDomainAssociations
+ delete:
+ - ec2:DisassociateTransitGatewayMulticastDomain
+ - ec2:GetTransitGatewayMulticastDomainAssociations
+ list:
+ - ec2:GetTransitGatewayMulticastDomainAssociations
+ TransitGatewayMulticastGroupMember:
type: object
properties:
- connectionId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the client connection.
- previousStatus:
- allOf:
- - $ref: '#/components/schemas/ClientVpnConnectionStatus'
- - description: The state of the client connection.
- currentStatus:
- allOf:
- - $ref: '#/components/schemas/ClientVpnConnectionStatus'
- - description: 'A message about the status of the client connection, if applicable.'
- description: Information about a terminated Client VPN endpoint client connection.
- TerminateInstancesRequest:
+ GroupIpAddress:
+ description: The IP address assigned to the transit gateway multicast group.
+ type: string
+ TransitGatewayAttachmentId:
+ description: The ID of the transit gateway attachment.
+ type: string
+ TransitGatewayMulticastDomainId:
+ description: The ID of the transit gateway multicast domain.
+ type: string
+ SubnetId:
+ description: The ID of the subnet.
+ type: string
+ ResourceId:
+ description: The ID of the resource.
+ type: string
+ ResourceType:
+ description: The type of resource, for example a VPC attachment.
+ type: string
+ NetworkInterfaceId:
+ description: The ID of the transit gateway attachment.
+ type: string
+ GroupMember:
+ description: Indicates that the resource is a transit gateway multicast group member.
+ type: boolean
+ GroupSource:
+ description: Indicates that the resource is a transit gateway multicast group member.
+ type: boolean
+ MemberType:
+ description: The member type (for example, static).
+ type: string
+ SourceType:
+ description: The source type.
+ type: string
+ required:
+ - GroupIpAddress
+ - NetworkInterfaceId
+ - TransitGatewayMulticastDomainId
+ x-stackql-resource-name: transit_gateway_multicast_group_member
+ description: The AWS::EC2::TransitGatewayMulticastGroupMember registers and deregisters members and sources (network interfaces) with the transit gateway multicast group
+ x-type-name: AWS::EC2::TransitGatewayMulticastGroupMember
+ x-stackql-primary-identifier:
+ - TransitGatewayMulticastDomainId
+ - GroupIpAddress
+ - NetworkInterfaceId
+ x-create-only-properties:
+ - TransitGatewayMulticastDomainId
+ - GroupIpAddress
+ - NetworkInterfaceId
+ x-read-only-properties:
+ - SubnetId
+ - ResourceId
+ - ResourceType
+ - GroupSource
+ - GroupMember
+ - MemberType
+ - SourceType
+ - TransitGatewayAttachmentId
+ x-required-properties:
+ - GroupIpAddress
+ - NetworkInterfaceId
+ - TransitGatewayMulticastDomainId
+ x-required-permissions:
+ create:
+ - ec2:RegisterTransitGatewayMulticastGroupMembers
+ - ec2:SearchTransitGatewayMulticastGroups
+ read:
+ - ec2:SearchTransitGatewayMulticastGroups
+ delete:
+ - ec2:DeregisterTransitGatewayMulticastGroupMembers
+ - ec2:SearchTransitGatewayMulticastGroups
+ list:
+ - ec2:SearchTransitGatewayMulticastGroups
+ TransitGatewayMulticastGroupSource:
type: object
+ properties:
+ GroupIpAddress:
+ description: The IP address assigned to the transit gateway multicast group.
+ type: string
+ TransitGatewayAttachmentId:
+ description: The ID of the transit gateway attachment.
+ type: string
+ TransitGatewayMulticastDomainId:
+ description: The ID of the transit gateway multicast domain.
+ type: string
+ SubnetId:
+ description: The ID of the subnet.
+ type: string
+ ResourceId:
+ description: The ID of the resource.
+ type: string
+ ResourceType:
+ description: The type of resource, for example a VPC attachment.
+ type: string
+ NetworkInterfaceId:
+ description: The ID of the transit gateway attachment.
+ type: string
+ GroupMember:
+ description: Indicates that the resource is a transit gateway multicast group member.
+ type: boolean
+ GroupSource:
+ description: Indicates that the resource is a transit gateway multicast group member.
+ type: boolean
+ MemberType:
+ description: The member type (for example, static).
+ type: string
+ SourceType:
+ description: The source type.
+ type: string
required:
- - InstanceIds
- title: TerminateInstancesRequest
+ - TransitGatewayMulticastDomainId
+ - NetworkInterfaceId
+ - GroupIpAddress
+ x-stackql-resource-name: transit_gateway_multicast_group_source
+ description: The AWS::EC2::TransitGatewayMulticastGroupSource registers and deregisters members and sources (network interfaces) with the transit gateway multicast group
+ x-type-name: AWS::EC2::TransitGatewayMulticastGroupSource
+ x-stackql-primary-identifier:
+ - TransitGatewayMulticastDomainId
+ - GroupIpAddress
+ - NetworkInterfaceId
+ x-create-only-properties:
+ - TransitGatewayMulticastDomainId
+ - GroupIpAddress
+ - NetworkInterfaceId
+ x-read-only-properties:
+ - SubnetId
+ - ResourceId
+ - ResourceType
+ - GroupSource
+ - GroupMember
+ - MemberType
+ - SourceType
+ - TransitGatewayAttachmentId
+ x-required-properties:
+ - TransitGatewayMulticastDomainId
+ - NetworkInterfaceId
+ - GroupIpAddress
+ x-required-permissions:
+ create:
+ - ec2:RegisterTransitGatewayMulticastGroupSources
+ - ec2:SearchTransitGatewayMulticastGroups
+ read:
+ - ec2:SearchTransitGatewayMulticastGroups
+ delete:
+ - ec2:DeregisterTransitGatewayMulticastGroupSources
+ - ec2:SearchTransitGatewayMulticastGroups
+ list:
+ - ec2:SearchTransitGatewayMulticastGroups
+ PeeringAttachmentStatus:
+ additionalProperties: false
+ type: object
properties:
- InstanceId:
- allOf:
- - $ref: '#/components/schemas/InstanceIdStringList'
- - description: 'The IDs of the instances.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ThreadsPerCore:
- type: integer
- ThreadsPerCoreList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/ThreadsPerCore'
- - xml:
- name: item
- ThroughResourcesStatement:
+ Message:
+ description: The status message, if applicable.
+ type: string
+ Code:
+ description: The status code.
+ type: string
+ TransitGatewayPeeringAttachment:
type: object
properties:
- resourceStatement:
- allOf:
- - $ref: '#/components/schemas/ResourceStatement'
- - description: The resource statement.
- description: Describes a through resource statement.
- ThroughResourcesStatementRequest:
+ Status:
+ description: The status of the transit gateway peering attachment.
+ $ref: '#/components/schemas/PeeringAttachmentStatus'
+ TransitGatewayId:
+ description: The ID of the transit gateway.
+ type: string
+ PeerTransitGatewayId:
+ description: The ID of the peer transit gateway.
+ type: string
+ PeerAccountId:
+ description: The ID of the peer account
+ type: string
+ State:
+ description: The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
+ type: string
+ CreationTime:
+ format: date-time
+ description: The time the transit gateway peering attachment was created.
+ type: string
+ PeerRegion:
+ description: Peer Region
+ type: string
+ Tags:
+ description: The tags for the transit gateway peering attachment.
+ type: array
+ items:
+ $ref: '#/components/schemas/Tag'
+ TransitGatewayAttachmentId:
+ description: The ID of the transit gateway peering attachment.
+ type: string
+ required:
+ - TransitGatewayId
+ - PeerTransitGatewayId
+ - PeerAccountId
+ - PeerRegion
+ x-stackql-resource-name: transit_gateway_peering_attachment
+ description: The AWS::EC2::TransitGatewayPeeringAttachment type
+ x-type-name: AWS::EC2::TransitGatewayPeeringAttachment
+ x-stackql-primary-identifier:
+ - TransitGatewayAttachmentId
+ x-create-only-properties:
+ - TransitGatewayId
+ - PeerTransitGatewayId
+ - PeerRegion
+ - PeerAccountId
+ x-read-only-properties:
+ - TransitGatewayAttachmentId
+ - Status
+ - State
+ - CreationTime
+ x-required-properties:
+ - TransitGatewayId
+ - PeerTransitGatewayId
+ - PeerAccountId
+ - PeerRegion
+ x-required-permissions:
+ read:
+ - ec2:DescribeTransitGatewayPeeringAttachments
+ create:
+ - ec2:CreateTransitGatewayPeeringAttachment
+ - ec2:DescribeTransitGatewayPeeringAttachments
+ update:
+ - ec2:DescribeTransitGatewayPeeringAttachments
+ list:
+ - ec2:DescribeTransitGatewayPeeringAttachments
+ delete:
+ - ec2:DeleteTransitGatewayPeeringAttachment
+ - ec2:DescribeTransitGatewayPeeringAttachments
+ TransitGatewayRouteTable:
type: object
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/ResourceStatementRequest'
- - description: The resource statement.
- description: Describes a through resource statement.
- TotalLocalStorageGBRequest:
+ TransitGatewayRouteTableId:
+ description: Transit Gateway Route Table primary identifier
+ type: string
+ TransitGatewayId:
+ description: The ID of the transit gateway.
+ type: string
+ Tags:
+ type: array
+ description: Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted.
+ items:
+ $ref: '#/components/schemas/Tag'
+ x-insertionOrder: false
+ uniqueItems: false
+ required:
+ - TransitGatewayId
+ x-stackql-resource-name: transit_gateway_route_table
+ description: Resource Type definition for AWS::EC2::TransitGatewayRouteTable
+ x-type-name: AWS::EC2::TransitGatewayRouteTable
+ x-stackql-primary-identifier:
+ - TransitGatewayRouteTableId
+ x-create-only-properties:
+ - TransitGatewayId
+ - Tags
+ x-read-only-properties:
+ - TransitGatewayRouteTableId
+ x-required-properties:
+ - TransitGatewayId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:CreateTransitGatewayRouteTable
+ - ec2:CreateTags
+ - ec2:DescribeTransitGatewayRouteTables
+ read:
+ - ec2:DescribeTransitGatewayRouteTables
+ delete:
+ - ec2:DeleteTransitGatewayRouteTable
+ - ec2:DescribeTransitGatewayRouteTables
+ - ec2:GetTransitGatewayRouteTableAssociations
+ - ec2:DisassociateTransitGatewayRouteTable
+ list:
+ - ec2:DescribeTransitGatewayRouteTables
+ TransitGatewayRouteTableAssociation:
type: object
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Double'
- - description: 'The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.'
- description: 'The minimum and maximum amount of total local storage, in GB.'
- TrafficDirection:
- type: string
- enum:
- - ingress
- - egress
- TrafficMirrorFilterRuleList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorFilterRule'
- - xml:
- name: item
- TrafficMirrorFilterIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorFilterId'
- - xml:
- name: item
- TrafficMirrorRuleAction:
- type: string
- enum:
- - accept
- - reject
- TrafficMirrorPortRange:
+ TransitGatewayRouteTableId:
+ description: The ID of transit gateway route table.
+ type: string
+ TransitGatewayAttachmentId:
+ description: The ID of transit gateway attachment.
+ type: string
+ required:
+ - TransitGatewayRouteTableId
+ - TransitGatewayAttachmentId
+ x-stackql-resource-name: transit_gateway_route_table_association
+ description: Resource Type definition for AWS::EC2::TransitGatewayRouteTableAssociation
+ x-type-name: AWS::EC2::TransitGatewayRouteTableAssociation
+ x-stackql-primary-identifier:
+ - TransitGatewayRouteTableId
+ - TransitGatewayAttachmentId
+ x-create-only-properties:
+ - TransitGatewayRouteTableId
+ - TransitGatewayAttachmentId
+ x-required-properties:
+ - TransitGatewayRouteTableId
+ - TransitGatewayAttachmentId
+ x-replacement-strategy: delete_then_create
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:AssociateTransitGatewayRouteTable
+ - ec2:GetTransitGatewayRouteTableAssociations
+ read:
+ - ec2:GetTransitGatewayRouteTableAssociations
+ delete:
+ - ec2:GetTransitGatewayRouteTableAssociations
+ - ec2:DisassociateTransitGatewayRouteTable
+ list:
+ - ec2:GetTransitGatewayRouteTableAssociations
+ TransitGatewayVpcAttachment:
type: object
properties:
- fromPort:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
- toPort:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
- description: Describes the Traffic Mirror port range.
- TrafficMirrorFilterRuleFieldList:
- type: array
- items:
- $ref: '#/components/schemas/TrafficMirrorFilterRuleField'
- TrafficMirrorFilterRuleId:
- type: string
- TrafficMirrorPortRangeRequest:
+ Options:
+ description: The options for the transit gateway vpc attachment.
+ additionalProperties: false
+ type: object
+ properties:
+ Ipv6Support:
+ description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable'
+ type: string
+ ApplianceModeSupport:
+ description: 'Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable'
+ type: string
+ DnsSupport:
+ description: 'Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable'
+ type: string
+ TransitGatewayId:
+ type: string
+ VpcId:
+ type: string
+ RemoveSubnetIds:
+ uniqueItems: false
+ x-insertionOrder: false
+ type: array
+ items:
+ type: string
+ Id:
+ type: string
+ SubnetIds:
+ uniqueItems: false
+ x-insertionOrder: false
+ type: array
+ items:
+ type: string
+ AddSubnetIds:
+ uniqueItems: false
+ x-insertionOrder: false
+ type: array
+ items:
+ type: string
+ Tags:
+ uniqueItems: false
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/Tag'
+ required:
+ - SubnetIds
+ - VpcId
+ - TransitGatewayId
+ x-stackql-resource-name: transit_gateway_vpc_attachment
+ description: Resource Type definition for AWS::EC2::TransitGatewayVpcAttachment
+ x-type-name: AWS::EC2::TransitGatewayVpcAttachment
+ x-stackql-primary-identifier:
+ - Id
+ x-create-only-properties:
+ - TransitGatewayId
+ - SubnetIds
+ - VpcId
+ x-write-only-properties:
+ - AddSubnetIds
+ - RemoveSubnetIds
+ x-read-only-properties:
+ - Id
+ x-required-properties:
+ - SubnetIds
+ - VpcId
+ - TransitGatewayId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ tagProperty: /properties/Tags
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ read:
+ - ec2:DescribeTransitGatewayAttachments
+ - ec2:DescribeTransitGatewayVpcAttachments
+ - ec2:CreateTransitGatewayVpcAttachment
+ - ec2:DeleteTransitGatewayVpcAttachment
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ - ec2:DescribeTags
+ - ec2:DescribeTransitGatewayAttachments
+ - ec2:ModifyTransitGatewayVpcAttachment
+ create:
+ - ec2:DescribeTransitGatewayAttachments
+ - ec2:DescribeTransitGatewayVpcAttachments
+ - ec2:CreateTransitGatewayVpcAttachment
+ - ec2:DeleteTransitGatewayVpcAttachment
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ - ec2:DescribeTags
+ - ec2:DescribeTransitGatewayAttachments
+ - ec2:ModifyTransitGatewayVpcAttachment
+ update:
+ - ec2:DescribeTransitGatewayAttachments
+ - ec2:DescribeTransitGatewayVpcAttachments
+ - ec2:DescribeTags
+ - ec2:CreateTransitGatewayVpcAttachment
+ - ec2:CreateTags
+ - ec2:DeleteTransitGatewayVpcAttachment
+ - ec2:DeleteTags
+ - ec2:ModifyTransitGatewayVpcAttachment
+ list:
+ - ec2:DescribeTransitGatewayAttachments
+ - ec2:DescribeTransitGatewayVpcAttachments
+ - ec2:DescribeTags
+ - ec2:CreateTransitGatewayVpcAttachment
+ - ec2:CreateTags
+ - ec2:DeleteTransitGatewayVpcAttachment
+ - ec2:DeleteTags
+ - ec2:ModifyTransitGatewayVpcAttachment
+ delete:
+ - ec2:DescribeTransitGatewayAttachments
+ - ec2:DescribeTransitGatewayVpcAttachments
+ - ec2:CreateTransitGatewayVpcAttachment
+ - ec2:DeleteTransitGatewayVpcAttachment
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ - ec2:DescribeTags
+ - ec2:DescribeTransitGatewayAttachments
+ - ec2:ModifyTransitGatewayVpcAttachment
+ NetworkInterfaceOptions:
+ description: The options for network-interface type endpoint.
type: object
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
- description: Information about the Traffic Mirror filter rule port range.
- TrafficMirrorSessionFieldList:
- type: array
- items:
- $ref: '#/components/schemas/TrafficMirrorSessionField'
- TrafficMirrorSessionIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorSessionId'
- - xml:
- name: item
- TrafficMirrorTargetType:
- type: string
- enum:
- - network-interface
- - network-load-balancer
- - gateway-load-balancer-endpoint
- TrafficMirrorTargetIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TrafficMirrorTargetId'
- - xml:
- name: item
- TrafficMirroringMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- TransitAssociationGatewayId:
- type: string
- TransitGatewayState:
+ NetworkInterfaceId:
+ description: The ID of the network interface.
+ type: string
+ Port:
+ description: The IP port number.
+ type: integer
+ minimum: 1
+ maximum: 65535
+ Protocol:
+ description: The IP protocol.
+ type: string
+ additionalProperties: false
+ LoadBalancerOptions:
+ description: The load balancer details if creating the AWS Verified Access endpoint as load-balancertype.
+ type: object
+ properties:
+ LoadBalancerArn:
+ description: The ARN of the load balancer.
+ type: string
+ Port:
+ description: The IP port number.
+ type: integer
+ minimum: 1
+ maximum: 65535
+ Protocol:
+ description: The IP protocol.
+ type: string
+ SubnetIds:
+ description: The IDs of the subnets.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/SubnetId'
+ additionalProperties: false
+ SubnetId:
+ description: The IDs of the subnet.
+ type: string
+ SseSpecification:
+ description: The configuration options for customer provided KMS encryption.
+ type: object
+ properties:
+ KmsKeyArn:
+ description: KMS Key Arn used to encrypt the group policy
+ type: string
+ CustomerManagedKeyEnabled:
+ description: Whether to encrypt the policy with the provided key or disable encryption
+ type: boolean
+ additionalProperties: false
+ VerifiedAccessEndpoint:
+ type: object
+ properties:
+ VerifiedAccessEndpointId:
+ description: The ID of the AWS Verified Access endpoint.
+ type: string
+ VerifiedAccessGroupId:
+ description: The ID of the AWS Verified Access group.
+ type: string
+ VerifiedAccessInstanceId:
+ description: The ID of the AWS Verified Access instance.
+ type: string
+ Status:
+ description: The endpoint status.
+ type: string
+ SecurityGroupIds:
+ description: The IDs of the security groups for the endpoint.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/SecurityGroupId'
+ NetworkInterfaceOptions:
+ description: The options for network-interface type endpoint.
+ $ref: '#/components/schemas/NetworkInterfaceOptions'
+ LoadBalancerOptions:
+ description: The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
+ $ref: '#/components/schemas/LoadBalancerOptions'
+ EndpointType:
+ description: The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
+ type: string
+ EndpointDomain:
+ description: A DNS name that is generated for the endpoint.
+ type: string
+ EndpointDomainPrefix:
+ description: A custom identifier that gets prepended to a DNS name that is generated for the endpoint.
+ type: string
+ DeviceValidationDomain:
+ description: Returned if endpoint has a device trust provider attached.
+ type: string
+ DomainCertificateArn:
+ description: The ARN of a public TLS/SSL certificate imported into or created with ACM.
+ type: string
+ AttachmentType:
+ description: The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
+ type: string
+ ApplicationDomain:
+ description: The DNS name for users to reach your application.
+ type: string
+ CreationTime:
+ description: The creation time.
+ type: string
+ LastUpdatedTime:
+ description: The last updated time.
+ type: string
+ Description:
+ description: A description for the AWS Verified Access endpoint.
+ type: string
+ PolicyDocument:
+ description: The AWS Verified Access policy document.
+ type: string
+ PolicyEnabled:
+ description: The status of the Verified Access policy.
+ type: boolean
+ Tags:
+ description: An array of key-value pairs to apply to this resource.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ SseSpecification:
+ description: The configuration options for customer provided KMS encryption.
+ $ref: '#/components/schemas/SseSpecification'
+ required:
+ - ApplicationDomain
+ - AttachmentType
+ - DomainCertificateArn
+ - EndpointType
+ - VerifiedAccessGroupId
+ - EndpointDomainPrefix
+ x-stackql-resource-name: verified_access_endpoint
+ description: The AWS::EC2::VerifiedAccessEndpoint resource creates an AWS EC2 Verified Access Endpoint.
+ x-type-name: AWS::EC2::VerifiedAccessEndpoint
+ x-stackql-primary-identifier:
+ - VerifiedAccessEndpointId
+ x-create-only-properties:
+ - ApplicationDomain
+ - AttachmentType
+ - DomainCertificateArn
+ - EndpointDomainPrefix
+ - EndpointType
+ - SecurityGroupIds
+ - NetworkInterfaceOptions/NetworkInterfaceId
+ - LoadBalancerOptions/LoadBalancerArn
+ x-read-only-properties:
+ - VerifiedAccessEndpointId
+ - EndpointDomain
+ - CreationTime
+ - LastUpdatedTime
+ - Status
+ - DeviceValidationDomain
+ - VerifiedAccessInstanceId
+ x-required-properties:
+ - ApplicationDomain
+ - AttachmentType
+ - DomainCertificateArn
+ - EndpointType
+ - VerifiedAccessGroupId
+ - EndpointDomainPrefix
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateVerifiedAccessEndpoint
+ - ec2:DescribeVerifiedAccessEndpoints
+ - ec2:CreateTags
+ - ec2:DescribeTags
+ - iam:CreateServiceLinkedRole
+ - iam:ListRoles
+ - acm:GetCertificateWithPK
+ - acm:DescribeCertificate
+ - acm:CreateCertificateRelation
+ - sso:GetManagedApplicationInstance
+ - sso:GetPeregrineStatus
+ - sso:GetSharedSsoConfiguration
+ - sso:CreateManagedApplicationInstance
+ - ec2:DescribeSubnets
+ - ec2:DescribeSecurityGroups
+ - ec2:DescribeNetworkInterfaces
+ - ec2:DescribeAccountAttributes
+ - elasticloadbalancing:DescribeLoadBalancers
+ - elasticloadbalancing:DescribeListeners
+ - elasticloadbalancing:DescribeListenerCertificates
+ - acm:DeleteCertificateRelation
+ - ec2:DeleteTags
+ - ec2:DeleteVerifiedAccessEndpoint
+ - ec2:GetVerifiedAccessEndpointPolicy
+ - ec2:ModifyVerifiedAccessEndpoint
+ - ec2:ModifyVerifiedAccessEndpointPolicy
+ - sso:DeleteManagedApplicationInstance
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ read:
+ - ec2:DescribeVerifiedAccessEndpoints
+ - ec2:GetVerifiedAccessEndpointPolicy
+ - ec2:DescribeTags
+ - acm:CreateCertificateRelation
+ - acm:DeleteCertificateRelation
+ - acm:DescribeCertificate
+ - acm:GetCertificateWithPK
+ - ec2:CreateTags
+ - ec2:CreateVerifiedAccessEndpoint
+ - ec2:DeleteTags
+ - ec2:DeleteVerifiedAccessEndpoint
+ - ec2:DescribeAccountAttributes
+ - ec2:DescribeNetworkInterfaces
+ - ec2:DescribeSecurityGroups
+ - ec2:DescribeSubnets
+ - ec2:ModifyVerifiedAccessEndpoint
+ - ec2:ModifyVerifiedAccessEndpointPolicy
+ - elasticloadbalancing:DescribeListenerCertificates
+ - elasticloadbalancing:DescribeListeners
+ - elasticloadbalancing:DescribeLoadBalancers
+ - iam:CreateServiceLinkedRole
+ - iam:ListRoles
+ - sso:CreateManagedApplicationInstance
+ - sso:DeleteManagedApplicationInstance
+ - sso:GetManagedApplicationInstance
+ - sso:GetPeregrineStatus
+ - sso:GetSharedSsoConfiguration
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ update:
+ - ec2:ModifyVerifiedAccessEndpoint
+ - ec2:ModifyVerifiedAccessEndpointPolicy
+ - ec2:DescribeVerifiedAccessEndpoints
+ - ec2:GetVerifiedAccessEndpointPolicy
+ - ec2:DescribeTags
+ - ec2:DeleteTags
+ - ec2:CreateTags
+ - acm:GetCertificateWithPK
+ - acm:DescribeCertificate
+ - acm:CreateCertificateRelation
+ - acm:DeleteCertificateRelation
+ - sso:GetManagedApplicationInstance
+ - sso:GetPeregrineStatus
+ - sso:GetSharedSsoConfiguration
+ - sso:CreateManagedApplicationInstance
+ - sso:DeleteManagedApplicationInstance
+ - ec2:DescribeSubnets
+ - ec2:DescribeSecurityGroups
+ - ec2:DescribeNetworkInterfaces
+ - ec2:DescribeAccountAttributes
+ - elasticloadbalancing:DescribeLoadBalancers
+ - elasticloadbalancing:DescribeListeners
+ - elasticloadbalancing:DescribeListenerCertificates
+ - ec2:CreateVerifiedAccessEndpoint
+ - ec2:DeleteVerifiedAccessEndpoint
+ - iam:CreateServiceLinkedRole
+ - iam:ListRoles
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ delete:
+ - ec2:DescribeVerifiedAccessEndpoints
+ - ec2:DescribeTags
+ - ec2:DeleteVerifiedAccessEndpoint
+ - ec2:DeleteTags
+ - sso:DeleteManagedApplicationInstance
+ - acm:DeleteCertificateRelation
+ - acm:DescribeCertificate
+ - acm:CreateCertificateRelation
+ - acm:GetCertificateWithPK
+ - ec2:CreateTags
+ - ec2:CreateVerifiedAccessEndpoint
+ - ec2:DescribeAccountAttributes
+ - ec2:DescribeNetworkInterfaces
+ - ec2:DescribeSecurityGroups
+ - ec2:DescribeSubnets
+ - ec2:GetVerifiedAccessEndpointPolicy
+ - ec2:ModifyVerifiedAccessEndpoint
+ - ec2:ModifyVerifiedAccessEndpointPolicy
+ - elasticloadbalancing:DescribeListenerCertificates
+ - elasticloadbalancing:DescribeListeners
+ - elasticloadbalancing:DescribeLoadBalancers
+ - iam:CreateServiceLinkedRole
+ - iam:ListRoles
+ - sso:CreateManagedApplicationInstance
+ - sso:GetManagedApplicationInstance
+ - sso:GetPeregrineStatus
+ - sso:GetSharedSsoConfiguration
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ list:
+ - ec2:DescribeVerifiedAccessEndpoints
+ - ec2:DescribeTags
+ - acm:CreateCertificateRelation
+ - acm:DeleteCertificateRelation
+ - acm:DescribeCertificate
+ - acm:GetCertificateWithPK
+ - ec2:CreateTags
+ - ec2:CreateVerifiedAccessEndpoint
+ - ec2:DeleteTags
+ - ec2:DeleteVerifiedAccessEndpoint
+ - ec2:DescribeAccountAttributes
+ - ec2:DescribeNetworkInterfaces
+ - ec2:DescribeSecurityGroups
+ - ec2:DescribeSubnets
+ - ec2:GetVerifiedAccessEndpointPolicy
+ - ec2:ModifyVerifiedAccessEndpoint
+ - ec2:ModifyVerifiedAccessEndpointPolicy
+ - elasticloadbalancing:DescribeListenerCertificates
+ - elasticloadbalancing:DescribeListeners
+ - elasticloadbalancing:DescribeLoadBalancers
+ - iam:CreateServiceLinkedRole
+ - iam:ListRoles
+ - sso:CreateManagedApplicationInstance
+ - sso:DeleteManagedApplicationInstance
+ - sso:GetManagedApplicationInstance
+ - sso:GetPeregrineStatus
+ - sso:GetSharedSsoConfiguration
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ VerifiedAccessGroup:
+ type: object
+ properties:
+ VerifiedAccessGroupId:
+ description: The ID of the AWS Verified Access group.
+ type: string
+ VerifiedAccessInstanceId:
+ description: The ID of the AWS Verified Access instance.
+ type: string
+ VerifiedAccessGroupArn:
+ description: The ARN of the Verified Access group.
+ type: string
+ Owner:
+ description: The AWS account number that owns the group.
+ type: string
+ CreationTime:
+ description: Time this Verified Access Group was created.
+ type: string
+ LastUpdatedTime:
+ description: Time this Verified Access Group was last updated.
+ type: string
+ Description:
+ description: A description for the AWS Verified Access group.
+ type: string
+ PolicyDocument:
+ description: The AWS Verified Access policy document.
+ type: string
+ PolicyEnabled:
+ description: The status of the Verified Access policy.
+ type: boolean
+ Tags:
+ description: An array of key-value pairs to apply to this resource.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ SseSpecification:
+ description: The configuration options for customer provided KMS encryption.
+ $ref: '#/components/schemas/SseSpecification'
+ required:
+ - VerifiedAccessInstanceId
+ x-stackql-resource-name: verified_access_group
+ description: The AWS::EC2::VerifiedAccessGroup resource creates an AWS EC2 Verified Access Group.
+ x-type-name: AWS::EC2::VerifiedAccessGroup
+ x-stackql-primary-identifier:
+ - VerifiedAccessGroupId
+ x-read-only-properties:
+ - VerifiedAccessGroupId
+ - CreationTime
+ - LastUpdatedTime
+ - Owner
+ - VerifiedAccessGroupArn
+ x-required-properties:
+ - VerifiedAccessInstanceId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateVerifiedAccessGroup
+ - ec2:DescribeVerifiedAccessGroups
+ - ec2:GetVerifiedAccessGroupPolicy
+ - ec2:CreateTags
+ - ec2:DescribeTags
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ read:
+ - ec2:DescribeVerifiedAccessGroups
+ - ec2:GetVerifiedAccessGroupPolicy
+ - ec2:DescribeTags
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ update:
+ - ec2:ModifyVerifiedAccessGroup
+ - ec2:ModifyVerifiedAccessGroupPolicy
+ - ec2:DescribeVerifiedAccessGroups
+ - ec2:GetVerifiedAccessGroupPolicy
+ - ec2:DescribeTags
+ - ec2:DeleteTags
+ - ec2:CreateTags
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ delete:
+ - ec2:DeleteVerifiedAccessGroup
+ - ec2:DeleteTags
+ - ec2:DescribeVerifiedAccessGroups
+ - ec2:DescribeTags
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ list:
+ - ec2:DescribeVerifiedAccessGroups
+ - ec2:DescribeTags
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ VerifiedAccessTrustProvider:
+ type: object
+ properties:
+ TrustProviderType:
+ description: 'Type of trust provider. Possible values: user|device'
+ type: string
+ DeviceTrustProviderType:
+ description: 'The type of device-based trust provider. Possible values: jamf|crowdstrike'
+ type: string
+ UserTrustProviderType:
+ description: 'The type of device-based trust provider. Possible values: oidc|iam-identity-center'
+ type: string
+ OidcOptions:
+ $ref: '#/components/schemas/OidcOptions'
+ DeviceOptions:
+ $ref: '#/components/schemas/DeviceOptions'
+ PolicyReferenceName:
+ description: The identifier to be used when working with policy rules.
+ type: string
+ CreationTime:
+ description: The creation time.
+ type: string
+ LastUpdatedTime:
+ description: The last updated time.
+ type: string
+ VerifiedAccessTrustProviderId:
+ description: The ID of the Amazon Web Services Verified Access trust provider.
+ type: string
+ Description:
+ description: A description for the Amazon Web Services Verified Access trust provider.
+ type: string
+ Tags:
+ description: An array of key-value pairs to apply to this resource.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ SseSpecification:
+ description: The configuration options for customer provided KMS encryption.
+ type: object
+ properties:
+ KmsKeyArn:
+ description: KMS Key Arn used to encrypt the group policy
+ type: string
+ CustomerManagedKeyEnabled:
+ description: Whether to encrypt the policy with the provided key or disable encryption
+ type: boolean
+ additionalProperties: false
+ required:
+ - TrustProviderType
+ - PolicyReferenceName
+ x-stackql-resource-name: verified_access_trust_provider
+ description: The AWS::EC2::VerifiedAccessTrustProvider type describes a verified access trust provider
+ x-type-name: AWS::EC2::VerifiedAccessTrustProvider
+ x-stackql-primary-identifier:
+ - VerifiedAccessTrustProviderId
+ x-create-only-properties:
+ - PolicyReferenceName
+ - DeviceOptions
+ - DeviceTrustProviderType
+ - TrustProviderType
+ - UserTrustProviderType
+ x-read-only-properties:
+ - VerifiedAccessTrustProviderId
+ - CreationTime
+ - LastUpdatedTime
+ x-required-properties:
+ - TrustProviderType
+ - PolicyReferenceName
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateVerifiedAccessTrustProvider
+ - ec2:DescribeVerifiedAccessTrustProviders
+ - ec2:CreateTags
+ - ec2:DescribeTags
+ - sso:GetSharedSsoConfiguration
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ read:
+ - ec2:DescribeVerifiedAccessTrustProviders
+ - ec2:DescribeTags
+ - kms:DescribeKey
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ update:
+ - ec2:ModifyVerifiedAccessTrustProvider
+ - ec2:DescribeVerifiedAccessTrustProviders
+ - ec2:DescribeTags
+ - ec2:DeleteTags
+ - ec2:CreateTags
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ delete:
+ - ec2:DeleteVerifiedAccessTrustProvider
+ - ec2:DeleteTags
+ - ec2:DescribeVerifiedAccessTrustProviders
+ - ec2:DescribeTags
+ - kms:DescribeKey
+ - kms:RetireGrant
+ - kms:CreateGrant
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ list:
+ - ec2:DescribeVerifiedAccessTrustProviders
+ - ec2:DescribeTags
+ - kms:DescribeKey
+ - kms:GenerateDataKey
+ - kms:Decrypt
+ VerifiedAccessTrustProviderId:
+ description: The ID of the AWS Verified Access trust provider.
+ type: string
+ VerifiedAccessLogs:
+ description: The configuration options for AWS Verified Access instances.
+ type: object
+ properties:
+ LogVersion:
+ description: Select log version for Verified Access logs.
+ type: string
+ IncludeTrustContext:
+ description: Include claims from trust providers in Verified Access logs.
+ type: boolean
+ CloudWatchLogs:
+ description: Sends Verified Access logs to CloudWatch Logs.
+ type: object
+ properties:
+ Enabled:
+ description: Indicates whether logging is enabled.
+ type: boolean
+ LogGroup:
+ description: The ID of the CloudWatch Logs log group.
+ type: string
+ additionalProperties: false
+ KinesisDataFirehose:
+ description: Sends Verified Access logs to Kinesis.
+ type: object
+ properties:
+ Enabled:
+ description: Indicates whether logging is enabled.
+ type: boolean
+ DeliveryStream:
+ description: The ID of the delivery stream.
+ type: string
+ additionalProperties: false
+ S3:
+ description: Sends Verified Access logs to Amazon S3.
+ type: object
+ properties:
+ Enabled:
+ description: Indicates whether logging is enabled.
+ type: boolean
+ BucketName:
+ description: The bucket name.
+ type: string
+ BucketOwner:
+ description: The ID of the AWS account that owns the Amazon S3 bucket.
+ type: string
+ Prefix:
+ description: The bucket prefix.
+ type: string
+ additionalProperties: false
+ additionalProperties: false
+ VerifiedAccessInstance:
+ type: object
+ properties:
+ VerifiedAccessInstanceId:
+ description: The ID of the AWS Verified Access instance.
+ type: string
+ VerifiedAccessTrustProviders:
+ description: AWS Verified Access trust providers.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/VerifiedAccessTrustProvider'
+ VerifiedAccessTrustProviderIds:
+ description: The IDs of the AWS Verified Access trust providers.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/VerifiedAccessTrustProviderId'
+ CreationTime:
+ description: Time this Verified Access Instance was created.
+ type: string
+ LastUpdatedTime:
+ description: Time this Verified Access Instance was last updated.
+ type: string
+ Description:
+ description: A description for the AWS Verified Access instance.
+ type: string
+ LoggingConfigurations:
+ description: The configuration options for AWS Verified Access instances.
+ $ref: '#/components/schemas/VerifiedAccessLogs'
+ Tags:
+ description: An array of key-value pairs to apply to this resource.
+ type: array
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ FipsEnabled:
+ description: Indicates whether FIPS is enabled
+ type: boolean
+ x-stackql-resource-name: verified_access_instance
+ description: The AWS::EC2::VerifiedAccessInstance resource creates an AWS EC2 Verified Access Instance.
+ x-type-name: AWS::EC2::VerifiedAccessInstance
+ x-stackql-primary-identifier:
+ - VerifiedAccessInstanceId
+ x-read-only-properties:
+ - VerifiedAccessInstanceId
+ - CreationTime
+ - LastUpdatedTime
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateVerifiedAccessInstance
+ - ec2:AttachVerifiedAccessTrustProvider
+ - ec2:ModifyVerifiedAccessInstanceLoggingConfiguration
+ - ec2:DescribeVerifiedAccessInstances
+ - ec2:DescribeVerifiedAccessInstanceLoggingConfigurations
+ - ec2:CreateTags
+ - ec2:DescribeTags
+ - logs:CreateLogDelivery
+ - logs:GetLogDelivery
+ - logs:UpdateLogDelivery
+ - logs:PutDestination
+ - logs:DeleteLogDelivery
+ - logs:ListLogDeliveries
+ - logs:PutLogEvents
+ - logs:DescribeLogStreams
+ - s3:listBuckets
+ - s3:PutObject
+ - s3:GetBucketPolicy
+ - s3:PutBucketPolicy
+ - logs:DescribeLogGroups
+ - logs:PutResourcePolicy
+ - firehose:TagDeliveryStream
+ - logs:DescribeResourcePolicies
+ - iam:CreateServiceLinkedRole
+ - verified-access:AllowVerifiedAccess
+ read:
+ - ec2:DescribeVerifiedAccessInstances
+ - ec2:DescribeVerifiedAccessInstanceLoggingConfigurations
+ - ec2:DescribeTags
+ - logs:GetLogDelivery
+ - logs:ListLogDeliveries
+ update:
+ - ec2:ModifyVerifiedAccessInstance
+ - ec2:ModifyVerifiedAccessInstanceLoggingConfiguration
+ - ec2:DescribeVerifiedAccessInstances
+ - ec2:DescribeVerifiedAccessInstanceLoggingConfigurations
+ - ec2:DescribeTags
+ - ec2:AttachVerifiedAccessTrustProvider
+ - ec2:DetachVerifiedAccessTrustProvider
+ - ec2:DeleteTags
+ - ec2:CreateTags
+ - ec2:DescribeTags
+ - logs:CreateLogDelivery
+ - logs:GetLogDelivery
+ - logs:ListLogDeliveries
+ - logs:UpdateLogDelivery
+ - logs:DeleteLogDelivery
+ - logs:PutDestination
+ - logs:PutLogEvents
+ - logs:DescribeLogStreams
+ - s3:listBuckets
+ - s3:PutObject
+ - s3:GetBucketPolicy
+ - s3:PutBucketPolicy
+ - logs:DescribeLogGroups
+ - logs:PutResourcePolicy
+ - firehose:TagDeliveryStream
+ - iam:CreateServiceLinkedRole
+ - logs:DescribeResourcePolicies
+ delete:
+ - ec2:DeleteVerifiedAccessInstance
+ - ec2:DeleteTags
+ - ec2:DescribeVerifiedAccessInstances
+ - ec2:DescribeVerifiedAccessInstanceLoggingConfigurations
+ - ec2:DetachVerifiedAccessTrustProvider
+ - ec2:GetVerifiedAccessGroupPolicy
+ - ec2:DescribeTags
+ - logs:ListLogDeliveries
+ - logs:GetLogDelivery
+ - logs:DeleteLogDelivery
+ list:
+ - ec2:DescribeVerifiedAccessInstances
+ - ec2:DescribeTags
+ - logs:ListLogDeliveries
+ - logs:GetLogDelivery
+ OidcOptions:
+ description: The OpenID Connect details for an oidc -type, user-identity based trust provider.
+ type: object
+ properties:
+ Issuer:
+ type: string
+ description: The OIDC issuer.
+ AuthorizationEndpoint:
+ type: string
+ description: The OIDC authorization endpoint.
+ TokenEndpoint:
+ type: string
+ description: The OIDC token endpoint.
+ UserInfoEndpoint:
+ type: string
+ description: The OIDC user info endpoint.
+ ClientId:
+ type: string
+ description: The client identifier.
+ ClientSecret:
+ type: string
+ description: The client secret.
+ Scope:
+ type: string
+ description: OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to details of a user. Each scope returns a specific set of user attributes.
+ additionalProperties: false
+ DeviceOptions:
+ description: The options for device identity based trust providers.
+ type: object
+ properties:
+ TenantId:
+ type: string
+ description: The ID of the tenant application with the device-identity provider.
+ PublicSigningKeyUrl:
+ type: string
+ description: URL Verified Access will use to verify authenticity of the device tokens.
+ additionalProperties: false
+ VolumeId:
+ description: The ID of the Amazon EBS volume
type: string
- enum:
- - pending
- - available
- - modifying
- - deleting
- - deleted
- TransitGatewayOptions:
- type: object
- properties:
- amazonSideAsn:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
- transitGatewayCidrBlocks:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The transit gateway CIDR blocks.
- autoAcceptSharedAttachments:
- allOf:
- - $ref: '#/components/schemas/AutoAcceptSharedAttachmentsValue'
- - description: Indicates whether attachment requests are automatically accepted.
- defaultRouteTableAssociation:
- allOf:
- - $ref: '#/components/schemas/DefaultRouteTableAssociationValue'
- - description: Indicates whether resource attachments are automatically associated with the default association route table.
- associationDefaultRouteTableId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the default association route table.
- defaultRouteTablePropagation:
- allOf:
- - $ref: '#/components/schemas/DefaultRouteTablePropagationValue'
- - description: Indicates whether resource attachments automatically propagate routes to the default propagation route table.
- propagationDefaultRouteTableId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the default propagation route table.
- vpnEcmpSupport:
- allOf:
- - $ref: '#/components/schemas/VpnEcmpSupportValue'
- - description: Indicates whether Equal Cost Multipath Protocol support is enabled.
- dnsSupport:
- allOf:
- - $ref: '#/components/schemas/DnsSupportValue'
- - description: Indicates whether DNS support is enabled.
- multicastSupport:
- allOf:
- - $ref: '#/components/schemas/MulticastSupportValue'
- - description: Indicates whether multicast is enabled on the transit gateway
- description: Describes the options for a transit gateway.
- TransitGatewayAttachmentResourceType:
+ Id:
+ description: ''
type: string
- enum:
- - vpc
- - vpn
- - direct-connect-gateway
- - connect
- - peering
- - tgw-peering
- TransitGatewayAssociationState:
+ InstanceId:
+ description: The ID of the instance to which the volume attaches
type: string
- enum:
- - associating
- - associated
- - disassociating
- - disassociated
- TransitGatewayAttachmentState:
+ Device:
+ description: The device name
type: string
- enum:
- - initiating
- - initiatingRequest
- - pendingAcceptance
- - rollingBack
- - pending
- - available
- - modifying
- - deleting
- - deleted
- - failed
- - rejected
- - rejecting
- - failing
- TransitGatewayAttachmentAssociation:
- type: object
- properties:
- transitGatewayRouteTableId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the route table for the transit gateway.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAssociationState'
- - description: The state of the association.
- description: Describes an association.
- TransitGatewayAttachment:
- type: object
- properties:
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the attachment.
- transitGatewayId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway.
- transitGatewayOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the transit gateway.
- resourceOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the resource.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- - description: The resource type. Note that the tgw-peering resource type has been deprecated.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentState'
- - description: The attachment state. Note that the initiating state has been deprecated.
- association:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentAssociation'
- - description: The association.
- creationTime:
- allOf:
- - $ref: '#/components/schemas/DateTime'
- - description: The creation time.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: The tags for the attachment.
- description: Describes an attachment between a resource and a transit gateway.
- TransitGatewayAttachmentBgpConfiguration:
+ VolumeAttachment:
type: object
properties:
- transitGatewayAsn:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: The transit gateway Autonomous System Number (ASN).
- peerAsn:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: The peer Autonomous System Number (ASN).
- transitGatewayAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The interior BGP peer IP address for the transit gateway.
- peerAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The interior BGP peer IP address for the appliance.
- bgpStatus:
- allOf:
- - $ref: '#/components/schemas/BgpStatus'
- - description: The BGP status.
- description: The BGP configuration information.
- TransitGatewayAttachmentBgpConfigurationList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentBgpConfiguration'
- - xml:
- name: item
- TransitGatewayPropagationState:
- type: string
- enum:
- - enabling
- - enabled
- - disabling
- - disabled
- TransitGatewayAttachmentPropagation:
+ VolumeId:
+ $ref: '#/components/schemas/VolumeId'
+ description: The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone. This value can be a reference to an [AWS::EC2::Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume.
+ InstanceId:
+ $ref: '#/components/schemas/InstanceId'
+ description: The ID of the instance to which the volume attaches. This value can be a reference to an [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) resource, or it can be the physical ID of an existing EC2 instance.
+ Device:
+ $ref: '#/components/schemas/Device'
+ description: The device name (for example, ``/dev/sdh`` or ``xvdh``).
+ required:
+ - VolumeId
+ - InstanceId
+ x-stackql-resource-name: volume_attachment
+ description: |-
+ Attaches an Amazon EBS volume to a running instance and exposes it to the instance with the specified device name.
+ Before this resource can be deleted (and therefore the volume detached), you must first unmount the volume in the instance. Failure to do so results in the volume being stuck in the busy state while it is trying to detach, which could possibly damage the file system or the data it contains.
+ If an Amazon EBS volume is the root device of an instance, it cannot be detached while the instance is in the "running" state. To detach the root volume, stop the instance first.
+ If the root volume is detached from an instance with an MKT product code, then the product codes from that volume are no longer associated with the instance.
+ x-type-name: AWS::EC2::VolumeAttachment
+ x-stackql-primary-identifier:
+ - VolumeId
+ - InstanceId
+ x-create-only-properties:
+ - Device
+ - InstanceId
+ - VolumeId
+ x-required-properties:
+ - VolumeId
+ - InstanceId
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:AttachVolume
+ - ec2:DescribeVolumes
+ read:
+ - ec2:DescribeVolumes
+ delete:
+ - ec2:DetachVolume
+ - ec2:DescribeVolumes
+ list:
+ - ec2:DescribeVolumes
+ VPC:
type: object
properties:
- transitGatewayRouteTableId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the propagation route table.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPropagationState'
- - description: The state of the propagation route table.
- description: Describes a propagation route table.
- TransitGatewayConnectOptions:
+ VpcId:
+ description: ''
+ type: string
+ InstanceTenancy:
+ description: |-
+ The allowed tenancy of instances launched into the VPC.
+ + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.
+ + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch.
+
+ Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.
+ type: string
+ Ipv4NetmaskLength:
+ description: The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
+ type: integer
+ CidrBlockAssociations:
+ uniqueItems: false
+ description: ''
+ x-insertionOrder: false
+ type: array
+ items:
+ type: string
+ CidrBlock:
+ description: |-
+ The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``.
+ You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
+ type: string
+ Ipv4IpamPoolId:
+ description: |-
+ The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.
+ You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.
+ type: string
+ DefaultNetworkAcl:
+ description: ''
+ x-insertionOrder: false
+ type: string
+ EnableDnsSupport:
+ description: >-
+ Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your
+ VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
+ type: boolean
+ Ipv6CidrBlocks:
+ uniqueItems: false
+ description: ''
+ x-insertionOrder: false
+ type: array
+ items:
+ type: string
+ DefaultSecurityGroup:
+ description: ''
+ x-insertionOrder: false
+ type: string
+ EnableDnsHostnames:
+ description: |-
+ Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).
+ You can only enable DNS hostnames if you've enabled DNS support.
+ type: boolean
+ Tags:
+ uniqueItems: false
+ description: The tags for the VPC.
+ x-insertionOrder: false
+ type: array
+ items:
+ $ref: '#/components/schemas/Tag'
+ x-stackql-resource-name: vpc
+ description: |-
+ Specifies a virtual private cloud (VPC).
+ You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
+ For more information, see [Virtual private clouds (VPC)](https://docs.aws.amazon.com/vpc/latest/userguide/configure-your-vpc.html) in the *Amazon VPC User Guide*.
+ x-type-name: AWS::EC2::VPC
+ x-stackql-primary-identifier:
+ - VpcId
+ x-create-only-properties:
+ - CidrBlock
+ - Ipv4IpamPoolId
+ - Ipv4NetmaskLength
+ x-conditional-create-only-properties:
+ - InstanceTenancy
+ x-write-only-properties:
+ - Ipv4IpamPoolId
+ - Ipv4NetmaskLength
+ x-read-only-properties:
+ - CidrBlockAssociations
+ - DefaultNetworkAcl
+ - DefaultSecurityGroup
+ - Ipv6CidrBlocks
+ - VpcId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ tagProperty: /properties/Tags
+ cloudFormationSystemTags: true
+ x-required-permissions:
+ read:
+ - ec2:DescribeVpcs
+ - ec2:DescribeSecurityGroups
+ - ec2:DescribeNetworkAcls
+ - ec2:DescribeVpcAttribute
+ create:
+ - ec2:CreateVpc
+ - ec2:DescribeVpcs
+ - ec2:ModifyVpcAttribute
+ - ec2:CreateTags
+ update:
+ - ec2:CreateTags
+ - ec2:ModifyVpcAttribute
+ - ec2:DeleteTags
+ - ec2:ModifyVpcTenancy
+ list:
+ - ec2:DescribeVpcs
+ delete:
+ - ec2:DeleteVpc
+ - ec2:DescribeVpcs
+ VPCCidrBlock:
type: object
properties:
- protocol:
- allOf:
- - $ref: '#/components/schemas/ProtocolValue'
- - description: The tunnel protocol.
- description: Describes the Connect attachment options.
- TransitGatewayConnectPeerState:
- type: string
- enum:
- - pending
- - available
- - deleting
- - deleted
- TransitGatewayConnectPeerConfiguration:
+ CidrBlock:
+ type: string
+ description: An IPv4 CIDR block to associate with the VPC.
+ Ipv6Pool:
+ type: string
+ description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
+ Id:
+ type: string
+ description: The Id of the VPC associated CIDR Block.
+ VpcId:
+ type: string
+ description: The ID of the VPC.
+ Ipv6CidrBlock:
+ type: string
+ description: An IPv6 CIDR block from the IPv6 address pool.
+ Ipv4IpamPoolId:
+ type: string
+ description: The ID of the IPv4 IPAM pool to Associate a CIDR from to a VPC.
+ Ipv4NetmaskLength:
+ type: integer
+ description: The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
+ Ipv6IpamPoolId:
+ type: string
+ description: The ID of the IPv6 IPAM pool to Associate a CIDR from to a VPC.
+ Ipv6NetmaskLength:
+ type: integer
+ description: The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool.
+ AmazonProvidedIpv6CidrBlock:
+ type: boolean
+ description: Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.
+ required:
+ - VpcId
+ x-stackql-resource-name: vpc_cidr_block
+ description: Resource Type definition for AWS::EC2::VPCCidrBlock
+ x-type-name: AWS::EC2::VPCCidrBlock
+ x-stackql-primary-identifier:
+ - Id
+ - VpcId
+ x-create-only-properties:
+ - Ipv6Pool
+ - VpcId
+ - AmazonProvidedIpv6CidrBlock
+ - Ipv6CidrBlock
+ - CidrBlock
+ - Ipv4IpamPoolId
+ - Ipv4NetmaskLength
+ - Ipv6IpamPoolId
+ - Ipv6NetmaskLength
+ x-write-only-properties:
+ - Ipv4IpamPoolId
+ - Ipv4NetmaskLength
+ - Ipv6IpamPoolId
+ - Ipv6NetmaskLength
+ x-read-only-properties:
+ - Id
+ x-required-properties:
+ - VpcId
+ x-tagging:
+ taggable: false
+ x-required-permissions:
+ create:
+ - ec2:AssociateVpcCidrBlock
+ - ec2:DescribeVpcs
+ - ec2:AllocateIpamPoolCidr
+ read:
+ - ec2:DescribeVpcs
+ delete:
+ - ec2:DescribeVpcs
+ - ec2:DisassociateVpcCidrBlock
+ list:
+ - ec2:DescribeVpcs
+ VPCDHCPOptionsAssociation:
type: object
properties:
- transitGatewayAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Connect peer IP address on the transit gateway side of the tunnel.
- peerAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Connect peer IP address on the appliance side of the tunnel.
- insideCidrBlocks:
- allOf:
- - $ref: '#/components/schemas/InsideCidrBlocksStringList'
- - description: The range of interior BGP peer IP addresses.
- protocol:
- allOf:
- - $ref: '#/components/schemas/ProtocolValue'
- - description: The tunnel protocol.
- bgpConfigurations:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentBgpConfigurationList'
- - description: The BGP configuration details.
- description: Describes the Connect peer details.
- TransitGatewayConnectRequestBgpOptions:
+ DhcpOptionsId:
+ type: string
+ description: The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
+ VpcId:
+ type: string
+ description: The ID of the VPC.
+ required:
+ - VpcId
+ - DhcpOptionsId
+ x-stackql-resource-name: vpcdhcp_options_association
+ description: Associates a set of DHCP options with a VPC, or associates no DHCP options with the VPC.
+ x-type-name: AWS::EC2::VPCDHCPOptionsAssociation
+ x-stackql-primary-identifier:
+ - DhcpOptionsId
+ - VpcId
+ x-create-only-properties:
+ - DhcpOptionsId
+ - VpcId
+ x-required-properties:
+ - VpcId
+ - DhcpOptionsId
+ x-replacement-strategy: delete_then_create
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:AssociateDhcpOptions
+ update:
+ - ec2:AssociateDhcpOptions
+ delete:
+ - ec2:AssociateDhcpOptions
+ read:
+ - ec2:DescribeVpcs
+ list:
+ - ec2:DescribeVpcs
+ VPCEndpoint:
type: object
properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/Long'
- - description: The peer Autonomous System Number (ASN).
- description: The BGP options for the Connect attachment.
- TransitGatewayMaxResults:
- type: integer
- minimum: 5
- maximum: 1000
- TransitGatewayMulticastDomainOptions:
+ Id:
+ type: string
+ description: ''
+ CreationTimestamp:
+ type: string
+ description: ''
+ DnsEntries:
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ type: string
+ description: ''
+ NetworkInterfaceIds:
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ type: string
+ description: ''
+ PolicyDocument:
+ type: object
+ description: |-
+ An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.
+ For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.
+ PrivateDnsEnabled:
+ type: boolean
+ description: >-
+ Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC
+ endpoint service.
+ To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``.
+ This property is supported only for interface endpoints.
+ Default: ``false``
+ RouteTableIds:
+ type: array
+ description: The IDs of the route tables. Routing is supported only for gateway endpoints.
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ type: string
+ SecurityGroupIds:
+ type: array
+ description: The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ type: string
+ ServiceName:
+ type: string
+ description: The name of the endpoint service.
+ SubnetIds:
+ type: array
+ description: The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
+ uniqueItems: true
+ x-insertionOrder: false
+ items:
+ type: string
+ VpcEndpointType:
+ type: string
+ enum:
+ - Interface
+ - Gateway
+ - GatewayLoadBalancer
+ description: |-
+ The type of endpoint.
+ Default: Gateway
+ VpcId:
+ type: string
+ description: The ID of the VPC.
+ required:
+ - VpcId
+ - ServiceName
+ x-stackql-resource-name: vpc_endpoint
+ description: |-
+ Specifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS, an MKT Partner, or another AWS accounts in your organization. For more information, see the [User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/).
+ An endpoint of type ``Interface`` establishes connections between the subnets in your VPC and an AWS-service, your own service, or a service hosted by another AWS-account. With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces.
+ An endpoint of type ``gateway`` serves as a target for a route in your route table for traffic destined for S3 or DDB. You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to S3, see [W
+ x-type-name: AWS::EC2::VPCEndpoint
+ x-stackql-primary-identifier:
+ - Id
+ x-create-only-properties:
+ - ServiceName
+ - VpcEndpointType
+ - VpcId
+ x-read-only-properties:
+ - NetworkInterfaceIds
+ - CreationTimestamp
+ - DnsEntries
+ - Id
+ x-required-properties:
+ - VpcId
+ - ServiceName
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:CreateVpcEndpoint
+ - ec2:DescribeVpcEndpoints
+ read:
+ - ec2:DescribeVpcEndpoints
+ update:
+ - ec2:ModifyVpcEndpoint
+ - ec2:DescribeVpcEndpoints
+ delete:
+ - ec2:DeleteVpcEndpoints
+ - ec2:DescribeVpcEndpoints
+ list:
+ - ec2:DescribeVpcEndpoints
+ VPCEndpointConnectionNotification:
+ type: object
+ properties:
+ VPCEndpointConnectionNotificationId:
+ description: VPC Endpoint Connection ID generated by service
+ type: string
+ ConnectionEvents:
+ description: The endpoint events for which to receive notifications.
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ type: string
+ ConnectionNotificationArn:
+ description: The ARN of the SNS topic for the notifications.
+ type: string
+ ServiceId:
+ description: The ID of the endpoint service.
+ type: string
+ VPCEndpointId:
+ description: The ID of the endpoint.
+ type: string
+ required:
+ - ConnectionEvents
+ - ConnectionNotificationArn
+ x-stackql-resource-name: vpc_endpoint_connection_notification
+ description: Resource Type definition for AWS::EC2::VPCEndpointConnectionNotification
+ x-type-name: AWS::EC2::VPCEndpointConnectionNotification
+ x-stackql-primary-identifier:
+ - VPCEndpointConnectionNotificationId
+ x-create-only-properties:
+ - ServiceId
+ - VPCEndpointId
+ x-read-only-properties:
+ - VPCEndpointConnectionNotificationId
+ x-required-properties:
+ - ConnectionEvents
+ - ConnectionNotificationArn
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:CreateVpcEndpointConnectionNotification
+ read:
+ - ec2:DescribeVpcEndpointConnectionNotifications
+ update:
+ - ec2:ModifyVpcEndpointConnectionNotification
+ - ec2:DescribeVpcEndpointConnectionNotifications
+ delete:
+ - ec2:DeleteVpcEndpointConnectionNotifications
+ list:
+ - ec2:DescribeVpcEndpointConnectionNotifications
+ VPCEndpointService:
type: object
properties:
- igmpv2Support:
- allOf:
- - $ref: '#/components/schemas/Igmpv2SupportValue'
- - description: Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
- staticSourcesSupport:
- allOf:
- - $ref: '#/components/schemas/StaticSourcesSupportValue'
- - description: Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
- autoAcceptSharedAssociations:
- allOf:
- - $ref: '#/components/schemas/AutoAcceptSharedAssociationsValue'
- - description: Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
- description: Describes the options for a transit gateway multicast domain.
- TransitGatewayMulticastDomainState:
- type: string
- enum:
- - pending
- - available
- - deleting
- - deleted
- TransitGatewayMulticastDomainAssociation:
+ NetworkLoadBalancerArns:
+ type: array
+ uniqueItems: false
+ items:
+ type: string
+ ContributorInsightsEnabled:
+ type: boolean
+ PayerResponsibility:
+ type: string
+ ServiceId:
+ type: string
+ AcceptanceRequired:
+ type: boolean
+ GatewayLoadBalancerArns:
+ type: array
+ uniqueItems: false
+ items:
+ type: string
+ x-stackql-resource-name: vpc_endpoint_service
+ description: Resource Type definition for AWS::EC2::VPCEndpointService
+ x-type-name: AWS::EC2::VPCEndpointService
+ x-stackql-primary-identifier:
+ - ServiceId
+ x-write-only-properties:
+ - ContributorInsightsEnabled
+ x-read-only-properties:
+ - ServiceId
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:CreateVpcEndpointServiceConfiguration
+ - ec2:ModifyVpcEndpointServiceConfiguration
+ - ec2:ModifyVpcEndpointServicePayerResponsibility
+ - cloudwatch:ListManagedInsightRules
+ - cloudwatch:DeleteInsightRules
+ - cloudwatch:PutManagedInsightRules
+ - ec2:DescribeVpcEndpointServiceConfigurations
+ update:
+ - ec2:ModifyVpcEndpointServiceConfiguration
+ - ec2:DeleteVpcEndpointServiceConfigurations
+ - ec2:DescribeVpcEndpointServiceConfigurations
+ - ec2:ModifyVpcEndpointServicePayerResponsibility
+ - cloudwatch:ListManagedInsightRules
+ - cloudwatch:DeleteInsightRules
+ - cloudwatch:PutManagedInsightRules
+ read:
+ - ec2:DescribeVpcEndpointServiceConfigurations
+ - cloudwatch:ListManagedInsightRules
+ delete:
+ - ec2:DeleteVpcEndpointServiceConfigurations
+ - ec2:DescribeVpcEndpointServiceConfigurations
+ - cloudwatch:ListManagedInsightRules
+ - cloudwatch:DeleteInsightRules
+ list:
+ - ec2:DescribeVpcEndpointServiceConfigurations
+ - cloudwatch:ListManagedInsightRules
+ VPCEndpointServicePermissions:
type: object
properties:
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway attachment.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- - description: 'The type of resource, for example a VPC attachment.'
- resourceOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: ' The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.'
- subnet:
- allOf:
- - $ref: '#/components/schemas/SubnetAssociation'
- - description: The subnet associated with the transit gateway multicast domain.
- description: Describes the resources associated with the transit gateway multicast domain.
- TransitGatewayMulticastGroup:
+ AllowedPrincipals:
+ type: array
+ uniqueItems: false
+ items:
+ type: string
+ ServiceId:
+ type: string
+ required:
+ - ServiceId
+ x-stackql-resource-name: vpc_endpoint_service_permissions
+ description: Resource Type definition for AWS::EC2::VPCEndpointServicePermissions
+ x-type-name: AWS::EC2::VPCEndpointServicePermissions
+ x-stackql-primary-identifier:
+ - ServiceId
+ x-create-only-properties:
+ - ServiceId
+ x-required-properties:
+ - ServiceId
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:CreateVpcEndpointServicePermissions
+ - ec2:ModifyVpcEndpointServicePermissions
+ - ec2:DeleteVpcEndpointServicePermissions
+ - ec2:DescribeVpcEndpointServicePermissions
+ update:
+ - ec2:CreateVpcEndpointServicePermissions
+ - ec2:ModifyVpcEndpointServicePermissions
+ - ec2:DeleteVpcEndpointServicePermissions
+ - ec2:DescribeVpcEndpointServicePermissions
+ read:
+ - ec2:CreateVpcEndpointServicePermissions
+ - ec2:ModifyVpcEndpointServicePermissions
+ - ec2:DeleteVpcEndpointServicePermissions
+ - ec2:DescribeVpcEndpointServicePermissions
+ delete:
+ - ec2:CreateVpcEndpointServicePermissions
+ - ec2:ModifyVpcEndpointServicePermissions
+ - ec2:DeleteVpcEndpointServicePermissions
+ - ec2:DescribeVpcEndpointServicePermissions
+ list:
+ - ec2:CreateVpcEndpointServicePermissions
+ - ec2:ModifyVpcEndpointServicePermissions
+ - ec2:DeleteVpcEndpointServicePermissions
+ - ec2:DescribeVpcEndpointServicePermissions
+ VPCGatewayAttachment:
+ type: object
+ properties:
+ AttachmentType:
+ type: string
+ description: 'Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment '
+ InternetGatewayId:
+ type: string
+ description: The ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
+ VpcId:
+ type: string
+ description: The ID of the VPC.
+ VpnGatewayId:
+ type: string
+ description: The ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
+ required:
+ - VpcId
+ x-stackql-resource-name: vpc_gateway_attachment
+ description: Resource Type definition for AWS::EC2::VPCGatewayAttachment
+ x-type-name: AWS::EC2::VPCGatewayAttachment
+ x-stackql-primary-identifier:
+ - AttachmentType
+ - VpcId
+ x-create-only-properties:
+ - VpcId
+ x-read-only-properties:
+ - AttachmentType
+ x-required-properties:
+ - VpcId
+ x-replacement-strategy: delete_then_create
+ x-tagging:
+ taggable: false
+ tagOnCreate: false
+ tagUpdatable: false
+ cloudFormationSystemTags: false
+ x-required-permissions:
+ create:
+ - ec2:AttachInternetGateway
+ - ec2:AttachVpnGateway
+ - ec2:DescribeInternetGateways
+ - ec2:DescribeVpnGateways
+ read:
+ - ec2:DescribeInternetGateways
+ - ec2:DescribeVpnGateways
+ update:
+ - ec2:AttachInternetGateway
+ - ec2:AttachVpnGateway
+ - ec2:DetachInternetGateway
+ - ec2:DetachVpnGateway
+ - ec2:DescribeInternetGateways
+ - ec2:DescribeVpnGateways
+ delete:
+ - ec2:DetachInternetGateway
+ - ec2:DetachVpnGateway
+ - ec2:DescribeInternetGateways
+ - ec2:DescribeVpnGateways
+ list:
+ - ec2:DescribeInternetGateways
+ - ec2:DescribeVpnGateways
+ VPCPeeringConnection:
+ type: object
+ properties:
+ Id:
+ type: string
+ PeerOwnerId:
+ description: The AWS account ID of the owner of the accepter VPC.
+ type: string
+ PeerRegion:
+ description: The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
+ type: string
+ PeerRoleArn:
+ description: The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.
+ type: string
+ PeerVpcId:
+ description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
+ type: string
+ VpcId:
+ description: The ID of the VPC.
+ type: string
+ Tags:
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ required:
+ - VpcId
+ - PeerVpcId
+ x-stackql-resource-name: vpc_peering_connection
+ description: Resource Type definition for AWS::EC2::VPCPeeringConnection
+ x-type-name: AWS::EC2::VPCPeeringConnection
+ x-stackql-primary-identifier:
+ - Id
+ x-create-only-properties:
+ - PeerRegion
+ - PeerOwnerId
+ - PeerVpcId
+ - PeerRoleArn
+ - VpcId
+ x-write-only-properties:
+ - PeerRoleArn
+ x-read-only-properties:
+ - Id
+ x-required-properties:
+ - VpcId
+ - PeerVpcId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: true
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateVpcPeeringConnection
+ - ec2:DescribeVpcPeeringConnections
+ - ec2:AcceptVpcPeeringConnection
+ - ec2:CreateTags
+ - sts:AssumeRole
+ read:
+ - ec2:DescribeVpcPeeringConnections
+ update:
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ - ec2:DescribeVpcPeeringConnections
+ delete:
+ - ec2:DeleteVpcPeeringConnection
+ - ec2:DescribeVpcPeeringConnections
+ list:
+ - ec2:DescribeVpcPeeringConnections
+ VpnTunnelOptionsSpecification:
type: object
+ additionalProperties: false
properties:
- groupIpAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IP address assigned to the transit gateway multicast group.
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway attachment.
- subnetId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the subnet.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- - description: 'The type of resource, for example a VPC attachment.'
- resourceOwnerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: ' The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.'
- networkInterfaceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the transit gateway attachment.
- groupMember:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates that the resource is a transit gateway multicast group member.
- groupSource:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates that the resource is a transit gateway multicast group member.
- memberType:
- allOf:
- - $ref: '#/components/schemas/MembershipType'
- - description: 'The member type (for example, static).'
- sourceType:
- allOf:
- - $ref: '#/components/schemas/MembershipType'
- - description: The source type.
- description: Describes the transit gateway multicast group resources.
- TransitGatewayNetworkInterfaceIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/NetworkInterfaceId'
- - xml:
- name: item
- VpnEcmpSupportValue:
- type: string
- enum:
- - enable
- - disable
- TransitGatewayPrefixListAttachment:
+ PreSharedKey:
+ type: string
+ TunnelInsideCidr:
+ type: string
+ VPNConnection:
type: object
properties:
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentId'
- - description: The ID of the attachment.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- - description: The resource type. Note that the tgw-peering resource type has been deprecated.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- description: Describes a transit gateway prefix list attachment.
- TransitGatewayPrefixListReferenceState:
- type: string
- enum:
- - pending
- - available
- - modifying
- - deleting
- TransitGatewayRouteAttachmentList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayRouteAttachment'
- - xml:
- name: item
- TransitGatewayRouteType:
- type: string
- enum:
- - static
- - propagated
- TransitGatewayRouteState:
- type: string
- enum:
- - pending
- - active
- - blackhole
- - deleting
- - deleted
- TransitGatewayRouteAttachment:
+ VpnConnectionId:
+ description: The provider-assigned unique ID for this managed resource
+ type: string
+ CustomerGatewayId:
+ description: The ID of the customer gateway at your end of the VPN connection.
+ type: string
+ StaticRoutesOnly:
+ description: Indicates whether the VPN connection uses static routes only.
+ type: boolean
+ Tags:
+ description: Any tags assigned to the VPN connection.
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ TransitGatewayId:
+ description: The ID of the transit gateway associated with the VPN connection.
+ type: string
+ Type:
+ description: The type of VPN connection.
+ type: string
+ VpnGatewayId:
+ description: The ID of the virtual private gateway at the AWS side of the VPN connection.
+ type: string
+ VpnTunnelOptionsSpecifications:
+ description: The tunnel options for the VPN connection.
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/VpnTunnelOptionsSpecification'
+ required:
+ - Type
+ - CustomerGatewayId
+ x-stackql-resource-name: vpn_connection
+ description: Resource Type definition for AWS::EC2::VPNConnection
+ x-type-name: AWS::EC2::VPNConnection
+ x-stackql-primary-identifier:
+ - VpnConnectionId
+ x-create-only-properties:
+ - Type
+ - CustomerGatewayId
+ - VpnGatewayId
+ - TransitGatewayId
+ - VpnTunnelOptionsSpecifications
+ - StaticRoutesOnly
+ x-read-only-properties:
+ - VpnConnectionId
+ x-required-properties:
+ - Type
+ - CustomerGatewayId
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:DescribeVpnConnections
+ - ec2:CreateVpnConnection
+ - ec2:CreateTags
+ delete:
+ - ec2:DescribeVpnConnections
+ - ec2:DeleteVpnConnection
+ - ec2:DeleteTags
+ update:
+ - ec2:DescribeVpnConnections
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ read:
+ - ec2:DescribeVpnConnections
+ list:
+ - ec2:DescribeVpnConnections
+ VPNConnectionRoute:
type: object
properties:
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the attachment.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- - description: 'The resource type. Note that the tgw-peering resource type has been deprecated. '
- description: Describes a route attachment.
- TransitGatewayRouteTableState:
+ DestinationCidrBlock:
+ description: The CIDR block associated with the local subnet of the customer network.
+ type: string
+ VpnConnectionId:
+ description: The ID of the VPN connection.
+ type: string
+ required:
+ - DestinationCidrBlock
+ - VpnConnectionId
+ x-stackql-resource-name: vpn_connection_route
+ description: Resource Type definition for AWS::EC2::VPNConnectionRoute
+ x-type-name: AWS::EC2::VPNConnectionRoute
+ x-stackql-primary-identifier:
+ - DestinationCidrBlock
+ - VpnConnectionId
+ x-create-only-properties:
+ - DestinationCidrBlock
+ - VpnConnectionId
+ x-required-properties:
+ - DestinationCidrBlock
+ - VpnConnectionId
+ x-tagging:
+ taggable: false
+ x-required-permissions:
+ create:
+ - ec2:CreateVpnConnectionRoute
+ - ec2:DescribeVpnConnections
+ read:
+ - ec2:DescribeVpnConnections
+ delete:
+ - ec2:DeleteVpnConnectionRoute
+ - ec2:DescribeVpnConnections
+ list:
+ - ec2:DescribeVpnConnections
+ VPNGateway:
+ type: object
+ properties:
+ VPNGatewayId:
+ description: VPN Gateway ID generated by service
+ type: string
+ AmazonSideAsn:
+ description: The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
+ type: integer
+ format: int64
+ Tags:
+ description: Any tags assigned to the virtual private gateway.
+ type: array
+ x-insertionOrder: false
+ uniqueItems: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ Type:
+ description: The type of VPN connection the virtual private gateway supports.
+ type: string
+ required:
+ - Type
+ x-stackql-resource-name: vpn_gateway
+ description: Schema for EC2 VPN Gateway
+ x-type-name: AWS::EC2::VPNGateway
+ x-stackql-primary-identifier:
+ - VPNGatewayId
+ x-create-only-properties:
+ - AmazonSideAsn
+ - Type
+ x-read-only-properties:
+ - VPNGatewayId
+ x-required-properties:
+ - Type
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: true
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - ec2:CreateVpnGateway
+ - ec2:DescribeVpnGateways
+ read:
+ - ec2:DescribeVpnGateways
+ update:
+ - ec2:CreateTags
+ - ec2:DeleteTags
+ delete:
+ - ec2:DeleteVpnGateway
+ list:
+ - ec2:DescribeVpnGateways
+ region:
type: string
- enum:
- - pending
- - available
- - deleting
- - deleted
- TransitGatewayRouteTableAssociation:
- type: object
- properties:
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the attachment.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- - description: The resource type. Note that the tgw-peering resource type has been deprecated.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAssociationState'
- - description: The state of the association.
- description: Describes an association between a route table and a resource attachment.
- TransitGatewayRouteTablePropagation:
- type: object
- properties:
- transitGatewayAttachmentId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the attachment.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- resourceType:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- - description: The type of resource. Note that the tgw-peering resource type has been deprecated.
- state:
- allOf:
- - $ref: '#/components/schemas/TransitGatewayPropagationState'
- - description: The state of the resource.
- description: Describes a route table propagation.
- TransitGatewaySubnetIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/SubnetId'
- - xml:
- name: item
- TransitGatewayVpcAttachmentOptions:
- type: object
- properties:
- dnsSupport:
- allOf:
- - $ref: '#/components/schemas/DnsSupportValue'
- - description: Indicates whether DNS support is enabled.
- ipv6Support:
- allOf:
- - $ref: '#/components/schemas/Ipv6SupportValue'
- - description: Indicates whether IPv6 support is disabled.
- applianceModeSupport:
- allOf:
- - $ref: '#/components/schemas/ApplianceModeSupportValue'
- - description: Indicates whether appliance mode support is enabled.
- description: Describes the VPC attachment options.
- TrunkInterfaceAssociationIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TrunkInterfaceAssociationId'
- - xml:
- name: item
- TunnelInsideIpVersion:
+ description: The AWS region
+ outpostArn:
type: string
- enum:
- - ipv4
- - ipv6
- TunnelOption:
- type: object
- properties:
- outsideIpAddress:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The external IP address of the VPN tunnel.
- tunnelInsideCidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The range of inside IPv4 addresses for the tunnel.
- tunnelInsideIpv6Cidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The range of inside IPv6 addresses for the tunnel.
- preSharedKey:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
- phase1LifetimeSeconds:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The lifetime for phase 1 of the IKE negotiation, in seconds.'
- phase2LifetimeSeconds:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The lifetime for phase 2 of the IKE negotiation, in seconds.'
- rekeyMarginTimeSeconds:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: 'The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.'
- rekeyFuzzPercentage:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
- replayWindowSize:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of packets in an IKE replay window.
- dpdTimeoutSeconds:
- allOf:
- - $ref: '#/components/schemas/Integer'
- - description: The number of seconds after which a DPD timeout occurs.
- dpdTimeoutAction:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The action to take after a DPD timeout occurs.
- phase1EncryptionAlgorithmSet:
- allOf:
- - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsList'
- - description: The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
- phase2EncryptionAlgorithmSet:
- allOf:
- - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsList'
- - description: The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
- phase1IntegrityAlgorithmSet:
- allOf:
- - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsList'
- - description: The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
- phase2IntegrityAlgorithmSet:
- allOf:
- - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsList'
- - description: The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
- phase1DHGroupNumberSet:
- allOf:
- - $ref: '#/components/schemas/Phase1DHGroupNumbersList'
- - description: The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
- phase2DHGroupNumberSet:
- allOf:
- - $ref: '#/components/schemas/Phase2DHGroupNumbersList'
- - description: The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
- ikeVersionSet:
- allOf:
- - $ref: '#/components/schemas/IKEVersionsList'
- - description: The IKE versions that are permitted for the VPN tunnel.
- startupAction:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The action to take when the establishing the VPN tunnels for a VPN connection.
- description: The VPN tunnel options.
- TunnelOptionsList:
+ description: The Amazon Resource Name (ARN) of the Outpost.
+ ownerId:
+ type: string
+ description: The ID of the Amazon Web Services account that owns the resource.
+ tagSet:
type: array
- items:
- allOf:
- - $ref: '#/components/schemas/TunnelOption'
- - xml:
- name: item
- UnassignIpv6AddressesRequest:
+ description: Any tags assigned to the resource.
+ snapshots:
+ description: List of snapshots by region (requires `aws` provider to be installed)
type: object
- required:
+ additionalProperties: false
+ properties:
+ description:
+ type: string
+ description: The description for the snapshot.
+ dataEncryptionKeyId:
+ type: string
+ description: The data encryption key identifier for the snapshot.
+ encrypted:
+ type: boolean
+ description: Indicates whether the snapshot is encrypted.
+ kmsKeyId:
+ type: string
+ description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
+ outpostArn:
+ $ref: '#/components/schemas/outpostArn'
+ ownerAlias:
+ type: string
+ description: The Amazon Web Services owner alias.
+ ownerId:
+ $ref: '#/components/schemas/ownerId'
+ progress:
+ type: string
+ description: The progress of the snapshot, as a percentage.
+ restoreExpiryTime:
+ type: string
+ description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
+ snapshotId:
+ type: string
+ description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
+ startTime:
+ type: string
+ description: The time stamp when the snapshot was initiated.
+ status:
+ type: string
+ description: The snapshot state.
+ statusMessage:
+ type: string
+ description: Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details.
+ storageTier:
+ type: string
+ description: The storage tier in which the snapshot is stored.
+ tagSet:
+ $ref: '#/components/schemas/tagSet'
+ volumeId:
+ type: string
+ description: The ID of the volume that was used to create the snapshot.
+ volumeSize:
+ type: integer
+ description: The size of the volume, in GiB.
+ region:
+ $ref: '#/components/schemas/region'
+ x-example-where-clause: WHERE region = 'DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- UnsuccessfulInstanceCreditSpecificationErrorCode:
- type: string
- enum:
- - InvalidInstanceID.Malformed
- - InvalidInstanceID.NotFound
- - IncorrectInstanceState
- - InstanceCreditSpecification.NotSupported
- UnsuccessfulInstanceCreditSpecificationItemError:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationErrorCode'
- - description: The error code.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The applicable error message.
- description: Information about the error for the burstable performance instance whose credit option for CPU usage was not modified.
- UnsuccessfulInstanceCreditSpecificationItem:
- type: object
- properties:
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance.
- error:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationItemError'
- - description: The applicable error for the burstable performance instance whose credit option for CPU usage was not modified.
- description: Describes the burstable performance instance whose credit option for CPU usage was not modified.
- UnsuccessfulItemError:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The error code.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The error message accompanying the error code.
- description: 'Information about the error that occurred. For more information about errors, see Error codes.'
- UnsuccessfulItem:
- type: object
- properties:
- error:
- allOf:
- - $ref: '#/components/schemas/UnsuccessfulItemError'
- - description: Information about the error.
- resourceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the resource.
- description: Information about items that were not successfully processed in a batch call.
- UpdateSecurityGroupRuleDescriptionsEgressRequest:
- type: object
- title: UpdateSecurityGroupRuleDescriptionsEgressRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/IpPermissionList'
- - description: The IP permissions for the security group rule. You must specify either the IP permissions or the description.
- SecurityGroupRuleDescription:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRuleDescriptionList'
- - description: The description for the egress security group rules. You must specify either the description or the IP permissions.
- UpdateSecurityGroupRuleDescriptionsIngressRequest:
- type: object
- title: UpdateSecurityGroupRuleDescriptionsIngressRequest
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/IpPermissionList'
- - description: The IP permissions for the security group rule. You must specify either IP permissions or a description.
- SecurityGroupRuleDescription:
- allOf:
- - $ref: '#/components/schemas/SecurityGroupRuleDescriptionList'
- - description: '[VPC only] The description for the ingress security group rules. You must specify either a description or IP permissions.'
- UsageClassType:
- type: string
- enum:
- - spot
- - on-demand
- UserIdGroupPair:
- type: object
- properties:
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
' - groupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the security group. - groupName: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
' - peeringStatus: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The status of a VPC peering connection, if applicable.' - userId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
' - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the VPC for the referenced security group, if applicable.' - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the VPC peering connection, if applicable.' - description: Describes a security group and Amazon Web Services account ID pair. - VCpuCount: - type: integer - VCpuCountRangeRequest: - type: object - required: - - Min - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of vCPUs. To specify no maximum limit, omit this parameter.' - description: The minimum and maximum number of vCPUs. - VgwTelemetry: - type: object - properties: - acceptedRouteCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of accepted routes. - lastStatusChange: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The date and time of the last change in status. - outsideIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The Internet-routable IP address of the virtual private gateway's outside interface. - status: - allOf: - - $ref: '#/components/schemas/TelemetryStatus' - - description: The status of the VPN tunnel. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'If an error occurs, a description of the error.' - certificateArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate. - description: Describes telemetry for a VPN tunnel. - VgwTelemetryList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VgwTelemetry' - - xml: - name: item - VirtualizationTypeSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/VirtualizationType' - - xml: - name: item - minItems: 0 - maxItems: 2 - VolumeAttachmentList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeAttachment' - - xml: - name: item - VolumeState: - type: string - enum: - - creating - - available - - in-use - - deleting - - deleted - - error - VolumeAttachmentState: - type: string - enum: - - attaching - - attached - - detaching - - detached - - busy - VolumeAttributeName: - type: string - enum: - - autoEnableIO - - productCodes - VolumeModificationState: - type: string - enum: - - modifying - - optimizing - - completed - - failed - VolumeStatusAction: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The code identifying the operation, for example,enable-volume-io.'
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the operation.
- eventId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the event associated with this operation.
- eventType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The event type associated with this operation.
- description: Describes a volume status operation code.
- VolumeStatusActionsList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusAction'
- - xml:
- name: item
- VolumeStatusAttachmentStatus:
- type: object
- properties:
- ioPerformance:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The maximum IOPS supported by the attached instance.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the attached instance.
- description: Information about the instances to which the volume is attached.
- VolumeStatusAttachmentStatusList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusAttachmentStatus'
- - xml:
- name: item
- VolumeStatusName:
- type: string
- enum:
- - io-enabled
- - io-performance
- VolumeStatusDetails:
- type: object
- properties:
- name:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusName'
- - description: The name of the volume status.
- status:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The intended status of the volume status.
- description: Describes a volume status.
- VolumeStatusDetailsList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusDetails'
- - xml:
- name: item
- VolumeStatusEvent:
- type: object
- properties:
- description:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: A description of the event.
- eventId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of this event.
- eventType:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The type of this event.
- notAfter:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The latest end time of the event.
- notBefore:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The earliest start time of the event.
- instanceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the instance associated with the event.
- description: Describes a volume status event.
- VolumeStatusEventsList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusEvent'
- - xml:
- name: item
- VolumeStatusInfoStatus:
- type: string
- enum:
- - ok
- - impaired
- - insufficient-data
- VolumeStatusInfo:
- type: object
- properties:
- details:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusDetailsList'
- - description: The details of the volume status.
- status:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusInfoStatus'
- - description: The status of the volume.
- description: Describes the status of a volume.
- VolumeStatusItem:
- type: object
- properties:
- actionsSet:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusActionsList'
- - description: The details of the operation.
- availabilityZone:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Availability Zone of the volume.
- outpostArn:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Amazon Resource Name (ARN) of the Outpost.
- eventsSet:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusEventsList'
- - description: A list of events associated with the volume.
- volumeId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The volume ID.
- volumeStatus:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusInfo'
- - description: The volume status.
- attachmentStatuses:
- allOf:
- - $ref: '#/components/schemas/VolumeStatusAttachmentStatusList'
- - description: Information about the instances to which the volume is attached.
- description: Describes the volume status.
- VpcState:
- type: string
- enum:
- - pending
- - available
- VpcIpv6CidrBlockAssociationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation'
- - xml:
- name: item
- VpcCidrBlockAssociationSet:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcCidrBlockAssociation'
- - xml:
- name: item
- VpcAttachmentList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcAttachment'
- - xml:
- name: item
- VpcAttributeName:
- type: string
- enum:
- - enableDnsSupport
- - enableDnsHostnames
- VpcCidrBlockState:
- type: object
- properties:
- state:
- allOf:
- - $ref: '#/components/schemas/VpcCidrBlockStateCode'
- - description: The state of the CIDR block.
- statusMessage:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A message about the status of the CIDR block, if applicable.'
- description: Describes the state of a CIDR block.
- VpcCidrBlockStateCode:
- type: string
- enum:
- - associating
- - associated
- - disassociating
- - disassociated
- - failing
- - failed
- VpcClassicLink:
- type: object
- properties:
- classicLinkEnabled:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the VPC is enabled for ClassicLink.
- tagSet:
- allOf:
- - $ref: '#/components/schemas/TagList'
- - description: Any tags assigned to the VPC.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- description: Describes whether a VPC is enabled for ClassicLink.
- VpcEndpointType:
- type: string
- enum:
- - Interface
- - Gateway
- - GatewayLoadBalancer
- VpcEndpointConnection:
- type: object
- properties:
- serviceId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the service to which the endpoint is connected.
- vpcEndpointId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC endpoint.
- vpcEndpointOwner:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the VPC endpoint.
- vpcEndpointState:
- allOf:
- - $ref: '#/components/schemas/State'
- - description: The state of the VPC endpoint.
- creationTimestamp:
- allOf:
- - $ref: '#/components/schemas/MillisecondDateTime'
- - description: The date and time that the VPC endpoint was created.
- dnsEntrySet:
- allOf:
- - $ref: '#/components/schemas/DnsEntrySet'
- - description: The DNS entries for the VPC endpoint.
- networkLoadBalancerArnSet:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The Amazon Resource Names (ARNs) of the network load balancers for the service.
- gatewayLoadBalancerArnSet:
- allOf:
- - $ref: '#/components/schemas/ValueStringList'
- - description: The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
- ipAddressType:
- allOf:
- - $ref: '#/components/schemas/IpAddressType'
- - description: The IP address type for the endpoint.
- description: Describes a VPC endpoint connection to a service.
- VpcPeeringConnectionVpcInfo:
- type: object
- properties:
- cidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv4 CIDR block for the VPC.
- ipv6CidrBlockSet:
- allOf:
- - $ref: '#/components/schemas/Ipv6CidrBlockSet'
- - description: The IPv6 CIDR block for the VPC.
- cidrBlockSet:
- allOf:
- - $ref: '#/components/schemas/CidrBlockSet'
- - description: Information about the IPv4 CIDR blocks for the VPC.
- ownerId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the Amazon Web Services account that owns the VPC.
- peeringOptions:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnectionOptionsDescription'
- - description: Information about the VPC peering connection options for the accepter or requester VPC.
- vpcId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The ID of the VPC.
- region:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The Region in which the VPC is located.
- description: Describes a VPC in a VPC peering connection.
- VpcPeeringConnectionStateReason:
- type: object
- properties:
- code:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnectionStateReasonCode'
- - description: The status of the VPC peering connection.
- message:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'A message that provides more information about the status, if applicable.'
- description: Describes the status of a VPC peering connection.
- VpcPeeringConnectionIdList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpcPeeringConnectionId'
- - xml:
- name: item
- VpcPeeringConnectionOptionsDescription:
- type: object
- properties:
- allowDnsResolutionFromRemoteVpc:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
- allowEgressFromLocalClassicLinkToRemoteVpc:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
- allowEgressFromLocalVpcToRemoteClassicLink:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
- description: Describes the VPC peering connection options.
- VpcPeeringConnectionStateReasonCode:
- type: string
- enum:
- - initiating-request
- - pending-acceptance
- - active
- - deleted
- - rejected
- - failed
- - expired
- - provisioning
- - deleting
- VpcTenancy:
- type: string
- enum:
- - default
- VpnState:
- type: string
- enum:
- - pending
- - available
- - deleting
- - deleted
- VpnConnectionOptions:
- type: object
- properties:
- enableAcceleration:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether acceleration is enabled for the VPN connection.
- staticRoutesOnly:
- allOf:
- - $ref: '#/components/schemas/Boolean'
- - description: Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
- localIpv4NetworkCidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
- remoteIpv4NetworkCidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
- localIpv6NetworkCidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
- remoteIpv6NetworkCidr:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
- tunnelInsideIpVersion:
- allOf:
- - $ref: '#/components/schemas/TunnelInsideIpVersion'
- - description: Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
- tunnelOptionSet:
- allOf:
- - $ref: '#/components/schemas/TunnelOptionsList'
- - description: Indicates the VPN tunnel options.
- description: Describes VPN connection options.
- VpnStaticRouteList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/VpnStaticRoute'
- - xml:
- name: item
- VpnConnectionDeviceType:
- type: object
- properties:
- vpnConnectionDeviceTypeId:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Customer gateway device identifier.
- vendor:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Customer gateway device vendor.
- platform:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Customer gateway device platform.
- software:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: Customer gateway device software version.
- description: 'List of customer gateway devices that have a sample configuration file available for use. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.'
- VpnConnectionDeviceTypeId:
- type: string
- VpnStaticRouteSource:
- type: string
- enum:
- - Static
- VpnStaticRoute:
- type: object
- properties:
- destinationCidrBlock:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: The CIDR block associated with the local subnet of the customer data center.
- source:
- allOf:
- - $ref: '#/components/schemas/VpnStaticRouteSource'
- - description: Indicates how the routes were provided.
- state:
- allOf:
- - $ref: '#/components/schemas/VpnState'
- - description: The current state of the static route.
- description: Describes a static route for a VPN connection.
- VpnTunnelOptionsSpecification:
- type: object
- properties:
- undefined:
- allOf:
- - $ref: '#/components/schemas/String'
- - description: 'The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
- ZoneIdStringList:
- type: array
- items:
- allOf:
- - $ref: '#/components/schemas/String'
- - xml:
- name: ZoneId
-security:
- - hmac: []
-x-stackQL-config:
- queryParamTranspose:
- algorithm: AWSCanonical
- requestTranslate:
- algorithm: get_query_to_post_form_utf_8
+ config:
+ views:
+ select:
+ predicate: sqlDialect == "sqlite3"
+ ddl: |-
+ SELECT
+ region,
+ data__Identifier,
+ JSON_EXTRACT(Properties, '$.GroupIpAddress') as group_ip_address,
+ JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id,
+ JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id,
+ JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id,
+ JSON_EXTRACT(Properties, '$.ResourceId') as resource_id,
+ JSON_EXTRACT(Properties, '$.ResourceType') as resource_type,
+ JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id,
+ JSON_EXTRACT(Properties, '$.GroupMember') as group_member,
+ JSON_EXTRACT(Properties, '$.GroupSource') as group_source,
+ JSON_EXTRACT(Properties, '$.MemberType') as member_type,
+ JSON_EXTRACT(Properties, '$.SourceType') as source_type
+ FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember'
+ AND data__Identifier = 'Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the Amazon Web Services Cloud. Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the Amazon Web Services Cloud where you can launch Amazon Web Services resources in a virtual network that you''ve defined. Amazon Elastic Block Store (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available and reliable storage volumes that can be attached to any running instance and used like a hard drive.
To learn more, see the following resources:
Amazon EC2: AmazonEC2 product page, Amazon EC2 documentation
Amazon EBS: Amazon EBS product page, Amazon EBS documentation
Amazon VPC: Amazon VPC product page, Amazon VPC documentation
Amazon Web Services VPN: Amazon Web Services VPN product page, Amazon Web Services VPN documentation
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ReservedInstanceId
+ in: query
+ required: true
+ description: The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservationId'
+ - xml:
+ name: ReservedInstanceId
+ - name: TargetConfiguration
+ in: query
+ required: false
+ description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TargetConfigurationRequest'
+ - xml:
+ name: TargetConfigurationRequest
+ 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'
+ post:
+ x-aws-operation-name: AcceptReservedInstancesExchangeQuote
+ operationId: POST_AcceptReservedInstancesExchangeQuote
+ description: Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AcceptReservedInstancesExchangeQuoteResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AcceptReservedInstancesExchangeQuoteRequest'
+ parameters: []
+ /?Action=AcceptTransitGatewayMulticastDomainAssociations&Version=2016-11-15:
+ get:
+ x-aws-operation-name: AcceptTransitGatewayMulticastDomainAssociations
+ operationId: GET_AcceptTransitGatewayMulticastDomainAssociations
+ description: Accepts a request to associate subnets with a transit gateway multicast domain.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AcceptTransitGatewayMulticastDomainAssociationsResult'
+ parameters:
+ - name: TransitGatewayMulticastDomainId
+ in: query
+ required: false
+ description: The ID of the transit gateway multicast domain.
+ schema:
+ type: string
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: false
+ description: The ID of the transit gateway attachment.
+ schema:
+ type: string
+ - name: SubnetIds
+ in: query
+ required: false
+ description: The IDs of the subnets to associate with the transit gateway multicast domain.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AcceptTransitGatewayMulticastDomainAssociations
+ operationId: POST_AcceptTransitGatewayMulticastDomainAssociations
+ description: Accepts a request to associate subnets with a transit gateway multicast domain.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AcceptTransitGatewayMulticastDomainAssociationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AcceptTransitGatewayMulticastDomainAssociationsRequest'
+ parameters: []
+ /?Action=AcceptTransitGatewayPeeringAttachment&Version=2016-11-15:
+ get:
+ x-aws-operation-name: AcceptTransitGatewayPeeringAttachment
+ operationId: GET_AcceptTransitGatewayPeeringAttachment
+ description: Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentResult'
+ parameters:
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: true
+ description: The ID of the transit gateway attachment.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AcceptTransitGatewayPeeringAttachment
+ operationId: POST_AcceptTransitGatewayPeeringAttachment
+ description: Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentRequest'
+ parameters: []
+ /?Action=AcceptTransitGatewayVpcAttachment&Version=2016-11-15:
+ get:
+ x-aws-operation-name: AcceptTransitGatewayVpcAttachment
+ operationId: GET_AcceptTransitGatewayVpcAttachment
+ description: Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AcceptTransitGatewayVpcAttachment
+ operationId: POST_AcceptTransitGatewayVpcAttachment
+ description: Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ServiceId
+ in: query
+ required: true
+ description: The ID of the VPC endpoint service.
+ schema:
+ type: string
+ - name: VpcEndpointId
+ in: query
+ required: true
+ description: The IDs of one or more interface VPC endpoints.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointId'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: AcceptVpcEndpointConnections
+ operationId: POST_AcceptVpcEndpointConnections
+ description: Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AcceptVpcEndpointConnectionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AcceptVpcEndpointConnectionsRequest'
+ parameters: []
+ /?Action=AcceptVpcPeeringConnection&Version=2016-11-15:
+ get:
+ x-aws-operation-name: AcceptVpcPeeringConnection
+ operationId: GET_AcceptVpcPeeringConnection
+ description: 'Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AcceptVpcPeeringConnectionResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcPeeringConnectionId
+ in: query
+ required: false
+ description: The ID of the VPC peering connection. You must specify this parameter in the request.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: AcceptVpcPeeringConnection
+ operationId: POST_AcceptVpcPeeringConnection
+ description: 'Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AcceptVpcPeeringConnectionResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AcceptVpcPeeringConnectionRequest' + parameters: [] + /?Action=AdvertiseByoipCidr&Version=2016-11-15: + get: + x-aws-operation-name: AdvertiseByoipCidr + operationId: GET_AdvertiseByoipCidr + description: 'Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.
It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AdvertiseByoipCidrResult' + parameters: + - name: Cidr + in: query + required: true + description: 'The address range, in CIDR notation. This must be the exact range that you provisioned. You can''t advertise only a portion of the provisioned range.' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AdvertiseByoipCidr
+ operationId: POST_AdvertiseByoipCidr
+ description: 'Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.
It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AdvertiseByoipCidrResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AdvertiseByoipCidrRequest' + parameters: [] + /?Action=AllocateAddress&Version=2016-11-15: + get: + x-aws-operation-name: AllocateAddress + operationId: GET_AllocateAddress + description: 'Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.
You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AllocateAddressResult' + parameters: + - name: Domain + in: query + required: false + description: 'Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.
Address parameter instead.'
+ schema:
+ type: string
+ - name: NetworkBorderGroup
+ in: query
+ required: false
+ description: 'A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use DescribeAvailabilityZones to view the network border groups.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to assign to the Elastic IP address.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: AllocateAddress
+ operationId: POST_AllocateAddress
+ description: 'Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.
You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AllocateAddressResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AllocateAddressRequest' + parameters: [] + /?Action=AllocateHosts&Version=2016-11-15: + get: + x-aws-operation-name: AllocateHosts + operationId: GET_AllocateHosts + description: 'Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AllocateHostsResult' + parameters: + - name: AutoPlacement + in: query + required: false + description: 'Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.
Default: on
Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
' + schema: + type: string + - name: InstanceFamily + in: query + required: false + description: 'Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
' + schema: + type: string + - name: Quantity + in: query + required: true + description: The number of Dedicated Hosts to allocate to your account with these parameters. + schema: + type: integer + - name: TagSpecification + in: query + required: false + description: The tags to apply to the Dedicated Host during creation. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: HostRecovery + in: query + required: false + description: 'Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.
Default: off
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamPoolId
+ in: query
+ required: true
+ description: The ID of the IPAM pool from which you would like to allocate a CIDR.
+ schema:
+ type: string
+ - name: Cidr
+ in: query
+ required: false
+ description: 'The CIDR you would like to allocate from the IPAM pool. Note the following:
If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible values: Any available IPv4 or IPv6 CIDR.
' + schema: + type: string + - name: NetmaskLength + in: query + required: false + description: 'The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:
If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
' + schema: + type: integer + - name: ClientToken + in: query + required: false + description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' + schema: + type: string + - name: Description + in: query + required: false + description: A description for the allocation. + schema: + type: string + - name: PreviewNextCidr + in: query + required: false + description: A preview of the next available CIDR in a pool. + schema: + type: boolean + - name: DisallowedCidr + in: query + required: false + description: Exclude a particular CIDR range from being returned by the pool. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + 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' + post: + x-aws-operation-name: AllocateIpamPoolCidr + operationId: POST_AllocateIpamPoolCidr + description: 'Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide. ' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AllocateIpamPoolCidrResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AllocateIpamPoolCidrRequest' + parameters: [] + /?Action=ApplySecurityGroupsToClientVpnTargetNetwork&Version=2016-11-15: + get: + x-aws-operation-name: ApplySecurityGroupsToClientVpnTargetNetwork + operationId: GET_ApplySecurityGroupsToClientVpnTargetNetwork + description: Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkResult' + parameters: + - name: ClientVpnEndpointId + in: query + required: true + description: The ID of the Client VPN endpoint. + schema: + type: string + - name: VpcId + in: query + required: true + description: The ID of the VPC in which the associated target network is located. + schema: + type: string + - name: SecurityGroupId + in: query + required: true + description: The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SecurityGroupId' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ApplySecurityGroupsToClientVpnTargetNetwork
+ operationId: POST_ApplySecurityGroupsToClientVpnTargetNetwork
+ description: Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkRequest'
+ parameters: []
+ /?Action=AssignIpv6Addresses&Version=2016-11-15:
+ get:
+ x-aws-operation-name: AssignIpv6Addresses
+ operationId: GET_AssignIpv6Addresses
+ description: 'Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet''s IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssignIpv6AddressesResult' + parameters: + - name: Ipv6AddressCount + in: query + required: false + description: The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. + schema: + type: integer + - name: Ipv6Addresses + in: query + required: false + description: One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + - name: Ipv6PrefixCount + in: query + required: false + description: The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use theIpv6Prefixes option.
+ schema:
+ type: integer
+ - name: Ipv6Prefix
+ in: query
+ required: false
+ description: One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: NetworkInterfaceId
+ in: query
+ required: true
+ description: The ID of the network interface.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: AssignIpv6Addresses
+ operationId: POST_AssignIpv6Addresses
+ description: 'Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet''s IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssignIpv6AddressesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AssignIpv6AddressesRequest' + parameters: [] + /?Action=AssignPrivateIpAddresses&Version=2016-11-15: + get: + x-aws-operation-name: AssignPrivateIpAddresses + operationId: GET_AssignPrivateIpAddresses + description: 'Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet''s CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssignPrivateIpAddressesResult' + parameters: + - name: AllowReassignment + in: query + required: false + description: Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface. + schema: + type: boolean + - name: NetworkInterfaceId + in: query + required: true + description: The ID of the network interface. + schema: + type: string + - name: PrivateIpAddress + in: query + required: false + description: 'One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can''t specify this parameter when also specifying a number of secondary IP addresses.
If you don''t specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: PrivateIpAddress + - name: SecondaryPrivateIpAddressCount + in: query + required: false + description: The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. + schema: + type: integer + - name: Ipv4Prefix + in: query + required: false + description: One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use theIpv4PrefixCount option.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: Ipv4PrefixCount
+ in: query
+ required: false
+ description: The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
+ schema:
+ type: integer
+ 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'
+ post:
+ x-aws-operation-name: AssignPrivateIpAddresses
+ operationId: POST_AssignPrivateIpAddresses
+ description: 'Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet''s CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssignPrivateIpAddressesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AssignPrivateIpAddressesRequest' + parameters: [] + /?Action=AssociateAddress&Version=2016-11-15: + get: + x-aws-operation-name: AssociateAddress + operationId: GET_AssociateAddress + description: 'Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[VPC in an EC2-Classic account] If you don''t specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NetworkInterfaceId
+ in: query
+ required: false
+ description: '[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
' + schema: + type: string + - name: PrivateIpAddress + in: query + required: false + description: '[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.' + schema: + type: string + 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' + post: + x-aws-operation-name: AssociateAddress + operationId: POST_AssociateAddress + description: 'Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[VPC in an EC2-Classic account] If you don''t specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that''s in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that''s associated with it.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateClientVpnTargetNetworkResult' + parameters: + - name: ClientVpnEndpointId + in: query + required: true + description: The ID of the Client VPN endpoint. + schema: + type: string + - name: SubnetId + in: query + required: true + description: The ID of the subnet to associate with the Client VPN endpoint. + schema: + type: string + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AssociateClientVpnTargetNetwork
+ operationId: POST_AssociateClientVpnTargetNetwork
+ description: 'Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that''s in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that''s associated with it.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateClientVpnTargetNetworkResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateClientVpnTargetNetworkRequest' + parameters: [] + /?Action=AssociateDhcpOptions&Version=2016-11-15: + get: + x-aws-operation-name: AssociateDhcpOptions + operationId: GET_AssociateDhcpOptions + description: 'Associates a set of DHCP options (that you''ve previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don''t need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + parameters: + - name: DhcpOptionsId + in: query + required: true + description: 'The ID of the DHCP options set, ordefault to associate no DHCP options with the VPC.'
+ schema:
+ type: string
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AssociateDhcpOptions
+ operationId: POST_AssociateDhcpOptions
+ description: 'Associates a set of DHCP options (that you''ve previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don''t need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateDhcpOptionsRequest' + parameters: [] + /?Action=AssociateEnclaveCertificateIamRole&Version=2016-11-15: + get: + x-aws-operation-name: AssociateEnclaveCertificateIamRole + operationId: GET_AssociateEnclaveCertificateIamRole + description: 'Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.
When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AssociateEnclaveCertificateIamRole
+ operationId: POST_AssociateEnclaveCertificateIamRole
+ description: 'Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.
When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide.
Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateInstanceEventWindowResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceEventWindowId
+ in: query
+ required: true
+ description: The ID of the event window.
+ schema:
+ type: string
+ - name: AssociationTarget
+ in: query
+ required: true
+ description: One or more targets associated with the specified event window.
+ schema:
+ type: object
+ properties:
+ InstanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdList'
+ - description: 'The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can''t specify the Instance ID parameter; you must use the Dedicated Host ID parameter.'
+ InstanceTag:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window.
+ DedicatedHostId:
+ allOf:
+ - $ref: '#/components/schemas/DedicatedHostIdList'
+ - description: The IDs of the Dedicated Hosts to associate with the event window.
+ description: 'One or more targets associated with the specified event window. Only one type of target (instance ID, instance tag, or Dedicated Host ID) can be associated with an event window.'
+ 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'
+ post:
+ x-aws-operation-name: AssociateInstanceEventWindow
+ operationId: POST_AssociateInstanceEventWindow
+ description: 'Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateInstanceEventWindowResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateInstanceEventWindowRequest' + parameters: [] + /?Action=AssociateRouteTable&Version=2016-11-15: + get: + x-aws-operation-name: AssociateRouteTable + operationId: GET_AssociateRouteTable + description: 'Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateRouteTableResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: RouteTableId
+ in: query
+ required: true
+ description: The ID of the route table.
+ schema:
+ type: string
+ - name: SubnetId
+ in: query
+ required: false
+ description: The ID of the subnet.
+ schema:
+ type: string
+ - name: GatewayId
+ in: query
+ required: false
+ description: The ID of the internet gateway or virtual private gateway.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: AssociateRouteTable
+ operationId: POST_AssociateRouteTable
+ description: 'Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateRouteTableResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateRouteTableRequest' + parameters: [] + /?Action=AssociateSubnetCidrBlock&Version=2016-11-15: + get: + x-aws-operation-name: AssociateSubnetCidrBlock + operationId: GET_AssociateSubnetCidrBlock + description: Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateSubnetCidrBlockResult' + parameters: + - name: Ipv6CidrBlock + in: query + required: true + description: The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length. + schema: + type: string + - name: SubnetId + in: query + required: true + description: The ID of your subnet. + schema: + type: string + 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' + post: + x-aws-operation-name: AssociateSubnetCidrBlock + operationId: POST_AssociateSubnetCidrBlock + description: Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateSubnetCidrBlockResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateSubnetCidrBlockRequest' + parameters: [] + /?Action=AssociateTransitGatewayMulticastDomain&Version=2016-11-15: + get: + x-aws-operation-name: AssociateTransitGatewayMulticastDomain + operationId: GET_AssociateTransitGatewayMulticastDomain + description: 'Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainResult' + parameters: + - name: TransitGatewayMulticastDomainId + in: query + required: false + description: The ID of the transit gateway multicast domain. + schema: + type: string + - name: TransitGatewayAttachmentId + in: query + required: false + description: The ID of the transit gateway attachment to associate with the transit gateway multicast domain. + schema: + type: string + - name: SubnetIds + in: query + required: false + description: The IDs of the subnets to associate with the transit gateway multicast domain. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SubnetId' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AssociateTransitGatewayMulticastDomain
+ operationId: POST_AssociateTransitGatewayMulticastDomain
+ description: 'Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainRequest' + parameters: [] + /?Action=AssociateTransitGatewayRouteTable&Version=2016-11-15: + get: + x-aws-operation-name: AssociateTransitGatewayRouteTable + operationId: GET_AssociateTransitGatewayRouteTable + description: Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateTransitGatewayRouteTableResult' + parameters: + - name: TransitGatewayRouteTableId + in: query + required: true + description: The ID of the transit gateway route table. + schema: + type: string + - name: TransitGatewayAttachmentId + in: query + required: true + description: The ID of the attachment. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AssociateTransitGatewayRouteTable
+ operationId: POST_AssociateTransitGatewayRouteTable
+ description: Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AssociateTransitGatewayRouteTableResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AssociateTransitGatewayRouteTableRequest'
+ parameters: []
+ /?Action=AssociateTrunkInterface&Version=2016-11-15:
+ get:
+ x-aws-operation-name: AssociateTrunkInterface
+ operationId: GET_AssociateTrunkInterface
+ description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Associates a branch network interface with a trunk network interface.
Before you create the association, run the create-network-interface command and set --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AssociateTrunkInterface
+ operationId: POST_AssociateTrunkInterface
+ description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Associates a branch network interface with a trunk network interface.
Before you create the association, run the create-network-interface command and set --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.
You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and subnet sizing in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateVpcCidrBlockResult' + parameters: + - name: AmazonProvidedIpv6CidrBlock + in: query + required: false + description: 'Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.' + schema: + type: boolean + - name: CidrBlock + in: query + required: false + description: An IPv4 CIDR block to associate with the VPC. + schema: + type: string + - name: VpcId + in: query + required: true + description: The ID of the VPC. + schema: + type: string + - name: Ipv6CidrBlockNetworkBorderGroup + in: query + required: false + description:The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
You can have one IPv6 CIDR block association per network border group.
+ schema: + type: string + - name: Ipv6Pool + in: query + required: false + description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. + schema: + type: string + - name: Ipv6CidrBlock + in: query + required: false + description: 'An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
' + schema: + type: string + - name: Ipv4IpamPoolId + in: query + required: false + description: 'Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.' + schema: + type: string + - name: Ipv4NetmaskLength + in: query + required: false + description: 'The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide. ' + schema: + type: integer + - name: Ipv6IpamPoolId + in: query + required: false + description: 'Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.' + schema: + type: string + - name: Ipv6NetmaskLength + in: query + required: false + description: 'The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide. ' + schema: + type: integer + 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' + post: + x-aws-operation-name: AssociateVpcCidrBlock + operationId: POST_AssociateVpcCidrBlock + description: 'Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.
You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and subnet sizing in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateVpcCidrBlockResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AssociateVpcCidrBlockRequest' + parameters: [] + /?Action=AttachClassicLinkVpc&Version=2016-11-15: + get: + x-aws-operation-name: AttachClassicLinkVpc + operationId: GET_AttachClassicLinkVpc + description: 'Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC''s security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that''s in the running state. An instance is automatically unlinked from a VPC when it''s stopped - you can link it to the VPC again when you restart it.
After you''ve linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AttachClassicLinkVpcResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: SecurityGroupId
+ in: query
+ required: true
+ description: The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: groupId
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
+ schema:
+ type: string
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of a ClassicLink-enabled VPC.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: AttachClassicLinkVpc
+ operationId: POST_AttachClassicLinkVpc
+ description: 'Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC''s security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that''s in the running state. An instance is automatically unlinked from a VPC when it''s stopped - you can link it to the VPC again when you restart it.
After you''ve linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AttachClassicLinkVpcResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AttachClassicLinkVpcRequest' + parameters: [] + /?Action=AttachInternetGateway&Version=2016-11-15: + get: + x-aws-operation-name: AttachInternetGateway + operationId: GET_AttachInternetGateway + description: 'Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.' + responses: + '200': + description: Success + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InternetGatewayId
+ in: query
+ required: true
+ description: The ID of the internet gateway.
+ schema:
+ type: string
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: AttachInternetGateway
+ operationId: POST_AttachInternetGateway
+ description: 'Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AttachInternetGatewayRequest'
+ parameters: []
+ /?Action=AttachNetworkInterface&Version=2016-11-15:
+ get:
+ x-aws-operation-name: AttachNetworkInterface
+ operationId: GET_AttachNetworkInterface
+ description: Attaches a network interface to an instance.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AttachNetworkInterfaceResult'
+ parameters:
+ - name: DeviceIndex
+ in: query
+ required: true
+ description: The index of the device for the network interface attachment.
+ schema:
+ type: integer
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance.
+ schema:
+ type: string
+ - name: NetworkInterfaceId
+ in: query
+ required: true
+ description: The ID of the network interface.
+ schema:
+ type: string
+ - name: NetworkCardIndex
+ in: query
+ required: false
+ description: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
+ schema:
+ type: integer
+ 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'
+ post:
+ x-aws-operation-name: AttachNetworkInterface
+ operationId: POST_AttachNetworkInterface
+ description: Attaches a network interface to an instance.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AttachNetworkInterfaceResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AttachNetworkInterfaceRequest'
+ parameters: []
+ /?Action=AttachVolume&Version=2016-11-15:
+ get:
+ x-aws-operation-name: AttachVolume
+ operationId: GET_AttachVolume
+ description: 'Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
After you attach an EBS volume, you must make it available. For more information, see Make an EBS volume available for use.
If a volume has an Amazon Web Services Marketplace product code:
The volume can be attached only to a stopped instance.
Amazon Web Services Marketplace product codes are copied from the volume to the instance.
You must be subscribed to the product.
The instance type and operating system of the instance must support the product. For example, you can''t detach a volume from a Windows instance and attach it to a Linux instance.
For more information, see Attach an Amazon EBS volume to an instance in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/VolumeAttachment' + parameters: + - name: Device + in: query + required: true + description: 'The device name (for example,/dev/sdh or xvdh).'
+ schema:
+ type: string
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance.
+ schema:
+ type: string
+ - name: VolumeId
+ in: query
+ required: true
+ description: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AttachVolume
+ operationId: POST_AttachVolume
+ description: 'Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
After you attach an EBS volume, you must make it available. For more information, see Make an EBS volume available for use.
If a volume has an Amazon Web Services Marketplace product code:
The volume can be attached only to a stopped instance.
Amazon Web Services Marketplace product codes are copied from the volume to the instance.
You must be subscribed to the product.
The instance type and operating system of the instance must support the product. For example, you can''t detach a volume from a Windows instance and attach it to a Linux instance.
For more information, see Attach an Amazon EBS volume to an instance in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/VolumeAttachment' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AttachVolumeRequest' + parameters: [] + /?Action=AttachVpnGateway&Version=2016-11-15: + get: + x-aws-operation-name: AttachVpnGateway + operationId: GET_AttachVpnGateway + description: 'Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AttachVpnGatewayResult' + parameters: + - name: VpcId + in: query + required: true + description: The ID of the VPC. + schema: + type: string + - name: VpnGatewayId + in: query + required: true + description: The ID of the virtual private gateway. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AttachVpnGateway
+ operationId: POST_AttachVpnGateway
+ description: 'Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AttachVpnGatewayResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AttachVpnGatewayRequest' + parameters: [] + /?Action=AuthorizeClientVpnIngress&Version=2016-11-15: + get: + x-aws-operation-name: AuthorizeClientVpnIngress + operationId: GET_AuthorizeClientVpnIngress + description: Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AuthorizeClientVpnIngressResult' + parameters: + - name: ClientVpnEndpointId + in: query + required: true + description: The ID of the Client VPN endpoint. + schema: + type: string + - name: TargetNetworkCidr + in: query + required: true + description: 'The IPv4 address range, in CIDR notation, of the network for which access is being authorized.' + schema: + type: string + - name: AccessGroupId + in: query + required: false + description: 'The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required ifAuthorizeAllGroups is false or not specified.'
+ schema:
+ type: string
+ - name: AuthorizeAllGroups
+ in: query
+ required: false
+ description: Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.
+ schema:
+ type: boolean
+ - name: Description
+ in: query
+ required: false
+ description: A brief description of the authorization rule.
+ schema:
+ type: string
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: AuthorizeClientVpnIngress
+ operationId: POST_AuthorizeClientVpnIngress
+ description: Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AuthorizeClientVpnIngressResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/AuthorizeClientVpnIngressRequest'
+ parameters: []
+ /?Action=AuthorizeSecurityGroupEgress&Version=2016-11-15:
+ get:
+ x-aws-operation-name: AuthorizeSecurityGroupEgress
+ operationId: GET_AuthorizeSecurityGroupEgress
+ description: '[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified source security groups.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For information about VPC security group quotas, see Amazon VPC quotas.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AuthorizeSecurityGroupEgressResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: GroupId
+ in: query
+ required: true
+ description: The ID of the security group.
+ schema:
+ type: string
+ - name: IpPermissions
+ in: query
+ required: false
+ description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpPermission'
+ - xml:
+ name: item
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags applied to the security group rule.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: CidrIp
+ in: query
+ required: false
+ description: Not supported. Use a set of IP permissions to specify the CIDR.
+ schema:
+ type: string
+ - name: FromPort
+ in: query
+ required: false
+ description: Not supported. Use a set of IP permissions to specify the port.
+ schema:
+ type: integer
+ - name: IpProtocol
+ in: query
+ required: false
+ description: Not supported. Use a set of IP permissions to specify the protocol name or number.
+ schema:
+ type: string
+ - name: ToPort
+ in: query
+ required: false
+ description: Not supported. Use a set of IP permissions to specify the port.
+ schema:
+ type: integer
+ - name: SourceSecurityGroupName
+ in: query
+ required: false
+ description: Not supported. Use a set of IP permissions to specify a destination security group.
+ schema:
+ type: string
+ - name: SourceSecurityGroupOwnerId
+ in: query
+ required: false
+ description: Not supported. Use a set of IP permissions to specify a destination security group.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: AuthorizeSecurityGroupEgress
+ operationId: POST_AuthorizeSecurityGroupEgress
+ description: '[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified source security groups.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For information about VPC security group quotas, see Amazon VPC quotas.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AuthorizeSecurityGroupEgressResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AuthorizeSecurityGroupEgressRequest' + parameters: [] + /?Action=AuthorizeSecurityGroupIngress&Version=2016-11-15: + get: + x-aws-operation-name: AuthorizeSecurityGroupIngress + operationId: GET_AuthorizeSecurityGroupIngress + description: 'Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
For more information about VPC security group quotas, see Amazon VPC quotas.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AuthorizeSecurityGroupIngressResult' + parameters: + - name: CidrIp + in: query + required: false + description: 'The IPv4 address range, in CIDR format. You can''t specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' + schema: + type: string + - name: FromPort + in: query + required: false + description: 'The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' + schema: + type: integer + - name: GroupId + in: query + required: false + description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.' + schema: + type: string + - name: GroupName + in: query + required: false + description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.' + schema: + type: string + - name: IpPermissions + in: query + required: false + description: The sets of IP permissions. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/IpPermission' + - xml: + name: item + - name: IpProtocol + in: query + required: false + description: 'The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.
[VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' + schema: + type: string + - name: SourceSecurityGroupName + in: query + required: false + description: '[EC2-Classic, default VPC] The name of the source security group. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.' + schema: + type: string + - name: SourceSecurityGroupOwnerId + in: query + required: false + description: '[nondefault VPC] The Amazon Web Services account ID for the source security group, if the source security group is in a different account. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.' + schema: + type: string + - name: ToPort + in: query + required: false + description: 'The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' + schema: + type: integer + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: TagSpecification
+ in: query
+ required: false
+ description: '[VPC Only] The tags applied to the security group rule.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: AuthorizeSecurityGroupIngress
+ operationId: POST_AuthorizeSecurityGroupIngress
+ description: 'Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
For more information about VPC security group quotas, see Amazon VPC quotas.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/AuthorizeSecurityGroupIngressResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AuthorizeSecurityGroupIngressRequest' + parameters: [] + /?Action=BundleInstance&Version=2016-11-15: + get: + x-aws-operation-name: BundleInstance + operationId: GET_BundleInstance + description: 'Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
The ID of the instance to bundle.
Type: String
Default: None
Required: Yes
' + schema: + type: string + - name: Storage + in: query + required: true + description: 'The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.' + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/S3Storage' + - description: An Amazon S3 storage location. + description: Describes the storage location for an instance store-backed AMI. + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: BundleInstance
+ operationId: POST_BundleInstance
+ description: 'Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CancelBundleTask
+ operationId: POST_CancelBundleTask
+ description: Cancels a bundling operation for an instance store-backed Windows instance.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CancelBundleTaskResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CancelBundleTaskRequest'
+ parameters: []
+ /?Action=CancelCapacityReservation&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CancelCapacityReservation
+ operationId: GET_CancelCapacityReservation
+ description: 'Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation''s state to cancelled.
Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CancelCapacityReservationResult' + parameters: + - name: CapacityReservationId + in: query + required: true + description: The ID of the Capacity Reservation to be cancelled. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CancelCapacityReservation
+ operationId: POST_CancelCapacityReservation
+ description: 'Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation''s state to cancelled.
Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CancelCapacityReservationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CancelCapacityReservationRequest' + parameters: [] + /?Action=CancelCapacityReservationFleets&Version=2016-11-15: + get: + x-aws-operation-name: CancelCapacityReservationFleets + operationId: GET_CancelCapacityReservationFleets + description: 'Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:
The Capacity Reservation Fleet''s status changes to cancelled.
The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.
The Fleet stops creating new Capacity Reservations.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: CapacityReservationFleetId
+ in: query
+ required: true
+ description: The IDs of the Capacity Reservation Fleets to cancel.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationFleetId'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: CancelCapacityReservationFleets
+ operationId: POST_CancelCapacityReservationFleets
+ description: 'Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:
The Capacity Reservation Fleet''s status changes to cancelled.
The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.
The Fleet stops creating new Capacity Reservations.
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
' + responses: + '200': + description: Success + parameters: + - name: ConversionTaskId + in: query + required: true + description: The ID of the conversion task. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ReasonMessage
+ in: query
+ required: false
+ description: The reason for canceling the conversion task.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CancelConversionTask
+ operationId: POST_CancelConversionTask
+ description: 'Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CancelConversionRequest' + parameters: [] + /?Action=CancelExportTask&Version=2016-11-15: + get: + x-aws-operation-name: CancelExportTask + operationId: GET_CancelExportTask + description: 'Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.' + responses: + '200': + description: Success + parameters: + - name: ExportTaskId + in: query + required: true + description: The ID of the export task. This is the ID returned byCreateInstanceExportTask.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CancelExportTask
+ operationId: POST_CancelExportTask
+ description: 'Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.'
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CancelExportTaskRequest'
+ parameters: []
+ /?Action=CancelImportTask&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CancelImportTask
+ operationId: GET_CancelImportTask
+ description: Cancels an in-process import virtual machine or import snapshot task.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CancelImportTaskResult'
+ parameters:
+ - name: CancelReason
+ in: query
+ required: false
+ description: The reason for canceling the task.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ImportTaskId
+ in: query
+ required: false
+ description: The ID of the import image or import snapshot task to be canceled.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CancelImportTask
+ operationId: POST_CancelImportTask
+ description: Cancels an in-process import virtual machine or import snapshot task.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CancelImportTaskResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CancelImportTaskRequest'
+ parameters: []
+ /?Action=CancelReservedInstancesListing&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CancelReservedInstancesListing
+ operationId: GET_CancelReservedInstancesListing
+ description: 'Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CancelReservedInstancesListingResult' + parameters: + - name: ReservedInstancesListingId + in: query + required: true + description: The ID of the Reserved Instance listing. + schema: + type: string + 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' + post: + x-aws-operation-name: CancelReservedInstancesListing + operationId: POST_CancelReservedInstancesListing + description: 'Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CancelReservedInstancesListingResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CancelReservedInstancesListingRequest' + parameters: [] + /?Action=CancelSpotFleetRequests&Version=2016-11-15: + get: + x-aws-operation-name: CancelSpotFleetRequests + operationId: GET_CancelSpotFleetRequests + description: 'Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: SpotFleetRequestId
+ in: query
+ required: true
+ description: The IDs of the Spot Fleet requests.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetRequestId'
+ - xml:
+ name: item
+ - name: TerminateInstances
+ in: query
+ required: true
+ description: Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CancelSpotFleetRequests
+ operationId: POST_CancelSpotFleetRequests
+ description: 'Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: SpotInstanceRequestId
+ in: query
+ required: true
+ description: One or more Spot Instance request IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SpotInstanceRequestId'
+ - xml:
+ name: SpotInstanceRequestId
+ 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'
+ post:
+ x-aws-operation-name: CancelSpotInstanceRequests
+ operationId: POST_CancelSpotInstanceRequests
+ description: Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ConfirmProductInstance
+ operationId: POST_ConfirmProductInstance
+ description: Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ConfirmProductInstanceResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ConfirmProductInstanceRequest'
+ parameters: []
+ /?Action=CopyFpgaImage&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CopyFpgaImage
+ operationId: GET_CopyFpgaImage
+ description: Copies the specified Amazon FPGA Image (AFI) to the current Region.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CopyFpgaImageResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: SourceFpgaImageId
+ in: query
+ required: true
+ description: The ID of the source AFI.
+ schema:
+ type: string
+ - name: Description
+ in: query
+ required: false
+ description: The description for the new AFI.
+ schema:
+ type: string
+ - name: Name
+ in: query
+ required: false
+ description: The name for the new AFI. The default is the name of the source AFI.
+ schema:
+ type: string
+ - name: SourceRegion
+ in: query
+ required: true
+ description: The Region that contains the source AFI.
+ schema:
+ type: string
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.'
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CopyFpgaImage
+ operationId: POST_CopyFpgaImage
+ description: Copies the specified Amazon FPGA Image (AFI) to the current Region.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CopyFpgaImageResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CopyFpgaImageRequest'
+ parameters: []
+ /?Action=CopyImage&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CopyImage
+ operationId: GET_CopyImage
+ description: 'Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can''t copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CopyImageResult' + parameters: + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.' + schema: + type: string + - name: Description + in: query + required: false + description: A description for the new AMI in the destination Region. + schema: + type: string + - name: Encrypted + in: query + required: false + description: 'Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key usingKmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.'
+ schema:
+ type: boolean
+ - name: KmsKeyId
+ in: query
+ required: false
+ description: 'The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to true.
You can specify a KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.
The specified KMS key must exist in the destination Region.
Amazon EBS does not support asymmetric KMS keys.
' + schema: + type: string + - name: Name + in: query + required: true + description: The name of the new AMI in the destination Region. + schema: + type: string + - name: SourceImageId + in: query + required: true + description: The ID of the AMI to copy. + schema: + type: string + - name: SourceRegion + in: query + required: true + description: The name of the Region that contains the AMI to copy. + schema: + type: string + - name: DestinationOutpostArn + in: query + required: false + description: 'The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copying AMIs from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CopyImage
+ operationId: POST_CopyImage
+ description: 'Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can''t copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CopyImageResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CopyImageRequest' + parameters: [] + /?Action=CopySnapshot&Version=2016-11-15: + get: + x-aws-operation-name: CopySnapshot + operationId: GET_CopySnapshot + description: 'Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can''t copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copy an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CopySnapshotResult' + parameters: + - name: Description + in: query + required: false + description: A description for the EBS snapshot. + schema: + type: string + - name: DestinationOutpostArn + in: query + required: false + description: 'The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
' + schema: + type: string + - name: DestinationRegion + in: query + required: false + description: 'The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is specified using the --region parameter or the default Region in your Amazon Web Services configuration file.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
' + schema: + type: string + - name: PresignedUrl + in: query + required: false + description: 'When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.
The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using Amazon Web Services Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CopySnapshot
+ operationId: POST_CopySnapshot
+ description: 'Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can''t copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copy an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CopySnapshotResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CopySnapshotRequest' + parameters: [] + /?Action=CreateCapacityReservation&Version=2016-11-15: + get: + x-aws-operation-name: CreateCapacityReservation + operationId: GET_CreateCapacityReservation + description: 'Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateCapacityReservationResult' + parameters: + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.' + schema: + type: string + - name: InstanceType + in: query + required: true + description: 'The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.' + schema: + type: string + - name: InstancePlatform + in: query + required: true + description: The type of operating system for which to reserve capacity. + schema: + type: string + enum: + - Linux/UNIX + - Red Hat Enterprise Linux + - SUSE Linux + - Windows + - Windows with SQL Server + - Windows with SQL Server Enterprise + - Windows with SQL Server Standard + - Windows with SQL Server Web + - Linux with SQL Server Standard + - Linux with SQL Server Web + - Linux with SQL Server Enterprise + - RHEL with SQL Server Standard + - RHEL with SQL Server Enterprise + - RHEL with SQL Server Web + - RHEL with HA + - RHEL with HA and SQL Server Standard + - RHEL with HA and SQL Server Enterprise + - name: AvailabilityZone + in: query + required: false + description: The Availability Zone in which to create the Capacity Reservation. + schema: + type: string + - name: AvailabilityZoneId + in: query + required: false + description: The ID of the Availability Zone in which to create the Capacity Reservation. + schema: + type: string + - name: Tenancy + in: query + required: false + description: 'Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
The number of instances for which to reserve capacity.
Valid range: 1 - 1000
' + schema: + type: integer + - name: EbsOptimized + in: query + required: false + description: Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance. + schema: + type: boolean + - name: EphemeralStorage + in: query + required: false + description: 'Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.' + schema: + type: boolean + - name: EndDate + in: query + required: false + description: 'The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.
You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.
If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default: open
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: OutpostArn
+ in: query
+ required: false
+ description: The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
+ schema:
+ type: string
+ pattern: '^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$'
+ - name: PlacementGroupArn
+ in: query
+ required: false
+ description: 'The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.'
+ schema:
+ type: string
+ pattern: '^arn:aws([a-z-]+)?:ec2:[a-z\d-]+:\d{12}:placement-group/([^\s].+[^\s]){1,255}$'
+ 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'
+ post:
+ x-aws-operation-name: CreateCapacityReservation
+ operationId: POST_CreateCapacityReservation
+ description: 'Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateCapacityReservationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateCapacityReservationRequest' + parameters: [] + /?Action=CreateCapacityReservationFleet&Version=2016-11-15: + get: + x-aws-operation-name: CreateCapacityReservationFleet + operationId: GET_CreateCapacityReservationFleet + description: 'Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateCapacityReservationFleetResult' + parameters: + - name: AllocationStrategy + in: query + required: false + description: 'The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. Currently, only the prioritized allocation strategy is supported. For more information, see Allocation strategy in the Amazon EC2 User Guide.
Valid values: prioritized
Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:
default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateCapacityReservationFleet
+ operationId: POST_CreateCapacityReservationFleet
+ description: 'Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateCapacityReservationFleetResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateCapacityReservationFleetRequest'
+ parameters: []
+ /?Action=CreateCarrierGateway&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateCarrierGateway
+ operationId: GET_CreateCarrierGateway
+ description: 'Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateCarrierGatewayResult'
+ parameters:
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC to associate with the carrier gateway.
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to associate with the carrier gateway.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CreateCarrierGateway
+ operationId: POST_CreateCarrierGateway
+ description: 'Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateCarrierGatewayResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateCarrierGatewayRequest'
+ parameters: []
+ /?Action=CreateClientVpnEndpoint&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateClientVpnEndpoint
+ operationId: GET_CreateClientVpnEndpoint
+ description: Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateClientVpnEndpointResult'
+ parameters:
+ - name: ClientCidrBlock
+ in: query
+ required: true
+ description: 'The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.'
+ schema:
+ type: string
+ - name: ServerCertificateArn
+ in: query
+ required: true
+ description: 'The ARN of the server certificate. For more information, see the Certificate Manager User Guide.'
+ schema:
+ type: string
+ - name: Authentication
+ in: query
+ required: true
+ description: Information about the authentication method to be used to authenticate clients.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ClientVpnAuthenticationRequest'
+ - name: ConnectionLogOptions
+ in: query
+ required: true
+ description: 'Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
The transport protocol to be used by the VPN session.
Default value: udp
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
Indicates whether split-tunnel is enabled on the Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
' + schema: + type: boolean + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply to the Client VPN endpoint during creation.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: SecurityGroupId
+ in: query
+ required: false
+ description: The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: item
+ - name: VpcId
+ in: query
+ required: false
+ description: 'The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.'
+ schema:
+ type: string
+ - name: SelfServicePortal
+ in: query
+ required: false
+ description: 'Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
The IPv4 address range, in CIDR notation, of the route destination. For example:
To add a route for Internet access, enter 0.0.0.0/0
To add a route for a peered VPC, enter the peered VPC''s IPv4 CIDR range
To add a route for an on-premises network, enter the Amazon Web Services Site-to-Site VPN connection''s IPv4 CIDR range
To add a route for the local network, enter the client CIDR range
The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.
Alternatively, if you''re adding a route for the local network, specify local.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateClientVpnRoute
+ operationId: POST_CreateClientVpnRoute
+ description: Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateClientVpnRouteResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateClientVpnRouteRequest'
+ parameters: []
+ /?Action=CreateCustomerGateway&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateCustomerGateway
+ operationId: GET_CreateCustomerGateway
+ description: 'Provides information to Amazon Web Services about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the Amazon Web Services side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway''s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device''s BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don''t have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn''t create a new customer gateway.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateCustomerGatewayResult' + parameters: + - name: BgpAsn + in: query + required: true + description: 'For devices that support BGP, the customer gateway''s BGP ASN.
Default: 65000
' + schema: + type: integer + - name: IpAddress + in: query + required: false + description: The Internet-routable IP address for the customer gateway's outside interface. The address must be static. + schema: + type: string + - name: CertificateArn + in: query + required: false + description: The Amazon Resource Name (ARN) for the customer gateway certificate. + schema: + type: string + - name: Type + in: query + required: true + description: The type of VPN connection that this customer gateway supports (ipsec.1).
+ schema:
+ type: string
+ enum:
+ - ipsec.1
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply to the customer gateway.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: DeviceName
+ in: query
+ required: false
+ description: 'A name for the customer gateway device.
Length Constraints: Up to 255 characters.
' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateCustomerGateway
+ operationId: POST_CreateCustomerGateway
+ description: 'Provides information to Amazon Web Services about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the Amazon Web Services side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway''s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device''s BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don''t have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn''t create a new customer gateway.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateCustomerGatewayResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateCustomerGatewayRequest' + parameters: [] + /?Action=CreateDefaultSubnet&Version=2016-11-15: + get: + x-aws-operation-name: CreateDefaultSubnet + operationId: GET_CreateDefaultSubnet + description: 'Creates a default subnet with a size/20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a default subnet in the Amazon Virtual Private Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateDefaultSubnetResult'
+ parameters:
+ - name: AvailabilityZone
+ in: query
+ required: true
+ description: The Availability Zone in which to create the default subnet.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Ipv6Native
+ in: query
+ required: false
+ description: 'Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateDefaultSubnet
+ operationId: POST_CreateDefaultSubnet
+ description: 'Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a default subnet in the Amazon Virtual Private Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateDefaultSubnetResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateDefaultSubnetRequest'
+ parameters: []
+ /?Action=CreateDefaultVpc&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateDefaultVpc
+ operationId: GET_CreateDefaultVpc
+ description: 'Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and default subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateDefaultVpcResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateDefaultVpc
+ operationId: POST_CreateDefaultVpc
+ description: 'Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and default subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateDefaultVpcResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateDefaultVpcRequest' + parameters: [] + /?Action=CreateDhcpOptions&Version=2016-11-15: + get: + x-aws-operation-name: CreateDhcpOptions + operationId: GET_CreateDhcpOptions + description: 'Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.
domain-name - If you''re using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you''re using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateDhcpOptions
+ operationId: POST_CreateDhcpOptions
+ description: 'Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.
domain-name - If you''re using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you''re using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC for which to create the egress-only internet gateway.
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to assign to the egress-only internet gateway.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: CreateEgressOnlyInternetGateway
+ operationId: POST_CreateEgressOnlyInternetGateway
+ description: '[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateEgressOnlyInternetGatewayResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateEgressOnlyInternetGatewayRequest'
+ parameters: []
+ /?Action=CreateFleet&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateFleet
+ operationId: GET_CreateFleet
+ description: 'Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see EC2 Fleet in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateFleetResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.'
+ schema:
+ type: string
+ - name: SpotOptions
+ in: query
+ required: false
+ description: Describes the configuration of Spot Instances in an EC2 Fleet.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The maximum amount per hour for Spot Instances that you're willing to pay.
+ description: Describes the configuration of Spot Instances in an EC2 Fleet request.
+ - name: OnDemandOptions
+ in: query
+ required: false
+ description: Describes the configuration of On-Demand Instances in an EC2 Fleet.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The maximum amount per hour for On-Demand Instances that you're willing to pay.
+ description: Describes the configuration of On-Demand Instances in an EC2 Fleet.
+ - name: ExcessCapacityTerminationPolicy
+ in: query
+ required: false
+ description: Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
+ schema:
+ type: string
+ enum:
+ - no-termination
+ - termination
+ - name: LaunchTemplateConfigs
+ in: query
+ required: true
+ description: The configuration for the EC2 Fleet.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/FleetLaunchTemplateConfigRequest'
+ - xml:
+ name: item
+ minItems: 0
+ maxItems: 50
+ - name: TargetCapacitySpecification
+ in: query
+ required: true
+ description: The number of units to request.
+ schema:
+ type: object
+ required:
+ - TotalTargetCapacity
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TargetCapacityUnitType'
+ - description: 'The unit for the target capacity.
Default: units (translates to number of instances)
The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.
The fleet type. The default value is maintain.
maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.
request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.
instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.
For more information, see EC2 Fleet request types in the Amazon EC2 User Guide.
' + schema: + type: string + enum: + - request + - maintain + - instant + - name: ValidFrom + in: query + required: false + description: 'The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.' + schema: + type: string + format: date-time + - name: ValidUntil + in: query + required: false + description: 'The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.' + schema: + type: string + format: date-time + - name: ReplaceUnhealthyInstances + in: query + required: false + description: 'Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of typemaintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.'
+ schema:
+ type: boolean
+ - name: TagSpecification
+ in: query
+ required: false
+ description: 'The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tagging your resources.
If the fleet type is instant, specify a resource type of fleet to tag the fleet or instance to tag the instances at launch.
If the fleet type is maintain or request, specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance. To tag instances at launch, specify the tags in a launch template.
Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see EC2 Fleet in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateFleetResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateFleetRequest' + parameters: [] + /?Action=CreateFlowLogs&Version=2016-11-15: + get: + x-aws-operation-name: CreateFlowLogs + operationId: GET_CreateFlowLogs + description: 'Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon Virtual Private Cloud User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateFlowLogsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ - name: DeliverLogsPermissionArn
+ in: query
+ required: false
+ description: 'The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
The ID of the subnet, network interface, or VPC for which you want to create a flow log.
Constraints: Maximum of 1000 resources
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/FlowLogResourceId' + - xml: + name: item + - name: ResourceType + in: query + required: true + description: 'The type of resource for which to create the flow log. For example, if you specified a VPC ID for theResourceId property, specify VPC for this property.'
+ schema:
+ type: string
+ enum:
+ - VPC
+ - Subnet
+ - NetworkInterface
+ - name: TrafficType
+ in: query
+ required: true
+ description: 'The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.'
+ schema:
+ type: string
+ enum:
+ - ACCEPT
+ - REJECT
+ - ALL
+ - name: LogDestinationType
+ in: query
+ required: false
+ description: 'The type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
Default: cloud-watch-logs
The destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.
If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.
If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.
The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow log records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.
Specify the fields using the ${field-id} format, separated by spaces. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.
The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
Default: 600
' + schema: + type: integer + - name: DestinationOptions + in: query + required: false + description: The destination options. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default isfalse.
+ description: Describes the destination options for a flow log.
+ 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'
+ post:
+ x-aws-operation-name: CreateFlowLogs
+ operationId: POST_CreateFlowLogs
+ description: 'Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon Virtual Private Cloud User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateFlowLogsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateFlowLogsRequest' + parameters: [] + /?Action=CreateFpgaImage&Version=2016-11-15: + get: + x-aws-operation-name: CreateFpgaImage + operationId: GET_CreateFpgaImage + description: 'Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateFpgaImageResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InputStorageLocation
+ in: query
+ required: true
+ description: The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The key.
+ description: Describes a storage location in Amazon S3.
+ - name: LogsStorageLocation
+ in: query
+ required: false
+ description: The location in Amazon S3 for the output logs.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The key.
+ description: Describes a storage location in Amazon S3.
+ - name: Description
+ in: query
+ required: false
+ description: A description for the AFI.
+ schema:
+ type: string
+ - name: Name
+ in: query
+ required: false
+ description: A name for the AFI.
+ schema:
+ type: string
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply to the FPGA image during creation.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: CreateFpgaImage
+ operationId: POST_CreateFpgaImage
+ description: 'Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateFpgaImageResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateFpgaImageRequest' + parameters: [] + /?Action=CreateImage&Version=2016-11-15: + get: + x-aws-operation-name: CreateImage + operationId: GET_CreateImage + description: 'Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can''t guarantee the file system integrity of the created image.
If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateImageResult' + parameters: + - name: BlockDeviceMapping + in: query + required: false + description: 'The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/BlockDeviceMapping' + - xml: + name: BlockDeviceMapping + - name: Description + in: query + required: false + description: A description for the new image. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance.
+ schema:
+ type: string
+ - name: Name
+ in: query
+ required: true
+ description: 'A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)
' + schema: + type: string + - name: NoReboot + in: query + required: false + description: 'By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can''t guarantee the file system integrity of the created image.
Default: false (follow standard reboot process)
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
To tag the AMI, the value for ResourceType must be image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + 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' + post: + x-aws-operation-name: CreateImage + operationId: POST_CreateImage + description: 'Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can''t guarantee the file system integrity of the created image.
If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateImageResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateImageRequest' + parameters: [] + /?Action=CreateInstanceEventWindow&Version=2016-11-15: + get: + x-aws-operation-name: CreateInstanceEventWindow + operationId: GET_CreateInstanceEventWindow + description: 'Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.
You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.
You can create up to 200 event windows per Amazon Web Services Region.
When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.
Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.
Event windows are not applicable for:
Expedited scheduled events and network maintenance events.
Unscheduled maintenance such as AutoRecovery and unplanned reboots.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateInstanceEventWindowResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Name
+ in: query
+ required: false
+ description: The name of the event window.
+ schema:
+ type: string
+ - name: TimeRange
+ in: query
+ required: false
+ description: 'The time range for the event window. If you specify a time range, you can''t specify a cron expression.'
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest'
+ - name: CronExpression
+ in: query
+ required: false
+ description: 'The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can''t specify a time range.
Constraints:
Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
' + schema: + type: string + - name: TagSpecification + in: query + required: false + description: The tags to apply to the event window. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + 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' + post: + x-aws-operation-name: CreateInstanceEventWindow + operationId: POST_CreateInstanceEventWindow + description: 'Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.
You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.
You can create up to 200 event windows per Amazon Web Services Region.
When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.
Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.
Event windows are not applicable for:
Expedited scheduled events and network maintenance events.
Unscheduled maintenance such as AutoRecovery and unplanned reboots.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateInstanceEventWindowResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateInstanceEventWindowRequest' + parameters: [] + /?Action=CreateInstanceExportTask&Version=2016-11-15: + get: + x-aws-operation-name: CreateInstanceExportTask + operationId: GET_CreateInstanceExportTask + description: 'Exports a running or stopped instance to an Amazon S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateInstanceExportTaskResult' + parameters: + - name: Description + in: query + required: false + description: A description for the conversion task or the resource being exported. The maximum length is 255 characters. + schema: + type: string + - name: ExportToS3 + in: query + required: true + description: The format and location for an export instance task. + schema: + type: object + properties: + containerFormat: + allOf: + - $ref: '#/components/schemas/ContainerFormat' + - description: 'The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.' + diskImageFormat: + allOf: + - $ref: '#/components/schemas/DiskImageFormat' + - description: The format for the exported image. + s3Bucket: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services accountvm-import-export@amazon.com.
+ s3Prefix:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
+ description: Describes an export instance task.
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance.
+ schema:
+ type: string
+ - name: TargetEnvironment
+ in: query
+ required: true
+ description: The target virtualization environment.
+ schema:
+ type: string
+ enum:
+ - citrix
+ - vmware
+ - microsoft
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply to the export instance task during creation.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: CreateInstanceExportTask
+ operationId: POST_CreateInstanceExportTask
+ description: 'Exports a running or stopped instance to an Amazon S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateInstanceExportTaskResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateInstanceExportTaskRequest' + parameters: [] + /?Action=CreateInternetGateway&Version=2016-11-15: + get: + x-aws-operation-name: CreateInternetGateway + operationId: GET_CreateInternetGateway + description: 'Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateInternetGatewayResult' + parameters: + - name: TagSpecification + in: query + required: false + description: The tags to assign to the internet gateway. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateInternetGateway
+ operationId: POST_CreateInternetGateway
+ description: 'Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateInternetGatewayResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateInternetGatewayRequest' + parameters: [] + /?Action=CreateIpam&Version=2016-11-15: + get: + x-aws-operation-name: CreateIpam + operationId: GET_CreateIpam + description: 'Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateIpamResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Description
+ in: query
+ required: false
+ description: A description for the IPAM.
+ schema:
+ type: string
+ - name: OperatingRegion
+ in: query
+ required: false
+ description: 'The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' + schema: + type: array + items: + $ref: '#/components/schemas/AddIpamOperatingRegion' + minItems: 0 + maxItems: 50 + - name: TagSpecification + in: query + required: false + description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CreateIpam
+ operationId: POST_CreateIpam
+ description: 'Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateIpamResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateIpamRequest' + parameters: [] + /?Action=CreateIpamPool&Version=2016-11-15: + get: + x-aws-operation-name: CreateIpamPool + operationId: GET_CreateIpamPool + description: 'Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateIpamPoolResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamScopeId
+ in: query
+ required: true
+ description: The ID of the scope in which you would like to create the IPAM pool.
+ schema:
+ type: string
+ - name: Locale
+ in: query
+ required: false
+ description: 'In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM''s home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
' + schema: + type: string + - name: SourceIpamPoolId + in: query + required: false + description: The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range. + schema: + type: string + - name: Description + in: query + required: false + description: A description for the IPAM pool. + schema: + type: string + - name: AddressFamily + in: query + required: true + description: The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool. + schema: + type: string + enum: + - ipv4 + - ipv6 + - name: AutoImport + in: query + required: false + description: 'If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
' + schema: + type: boolean + - name: PubliclyAdvertisable + in: query + required: false + description: Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set toipv4.
+ schema:
+ type: boolean
+ - name: AllocationMinNetmaskLength
+ in: query
+ required: false
+ description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
+ schema:
+ type: integer
+ minimum: 0
+ maximum: 128
+ - name: AllocationMaxNetmaskLength
+ in: query
+ required: false
+ description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
+ schema:
+ type: integer
+ minimum: 0
+ maximum: 128
+ - name: AllocationDefaultNetmaskLength
+ in: query
+ required: false
+ description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.'
+ schema:
+ type: integer
+ minimum: 0
+ maximum: 128
+ - name: AllocationResourceTag
+ in: query
+ required: false
+ description: 'Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/RequestIpamResourceTag'
+ - xml:
+ name: item
+ - name: TagSpecification
+ in: query
+ required: false
+ description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
+ schema:
+ type: string
+ - name: AwsService
+ in: query
+ required: false
+ description: 'Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.'
+ schema:
+ type: string
+ enum:
+ - ec2
+ 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'
+ post:
+ x-aws-operation-name: CreateIpamPool
+ operationId: POST_CreateIpamPool
+ description: 'Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateIpamPoolResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateIpamPoolRequest' + parameters: [] + /?Action=CreateIpamScope&Version=2016-11-15: + get: + x-aws-operation-name: CreateIpamScope + operationId: GET_CreateIpamScope + description: 'Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see Add a scope in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateIpamScopeResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamId
+ in: query
+ required: true
+ description: The ID of the IPAM for which you're creating this scope.
+ schema:
+ type: string
+ - name: Description
+ in: query
+ required: false
+ description: A description for the scope you're creating.
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CreateIpamScope
+ operationId: POST_CreateIpamScope
+ description: 'Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see Add a scope in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateIpamScopeResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateIpamScopeRequest' + parameters: [] + /?Action=CreateKeyPair&Version=2016-11-15: + get: + x-aws-operation-name: CreateKeyPair + operationId: GET_CreateKeyPair + description: 'Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.
The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.
You can have up to 5,000 key pairs per Amazon Web Services Region.
For more information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/KeyPair' + parameters: + - name: KeyName + in: query + required: true + description: 'A unique name for the key pair.
Constraints: Up to 255 ASCII characters
' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: KeyType
+ in: query
+ required: false
+ description: 'The type of key pair. Note that ED25519 keys are not supported for Windows instances.
Default: rsa
The format of the key pair.
Default: pem
Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.
The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.
You can have up to 5,000 key pairs per Amazon Web Services Region.
For more information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/KeyPair' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateKeyPairRequest' + parameters: [] + /?Action=CreateLaunchTemplate&Version=2016-11-15: + get: + x-aws-operation-name: CreateLaunchTemplate + operationId: GET_CreateLaunchTemplate + description: 'Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateLaunchTemplateResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraint: Maximum 128 ASCII characters.
' + schema: + type: string + - name: LaunchTemplateName + in: query + required: true + description: A name for the launch template. + schema: + type: string + pattern: '[a-zA-Z0-9\(\)\.\-/_]+' + minLength: 3 + maxLength: 128 + - name: VersionDescription + in: query + required: false + description: A description for the first version of the launch template. + schema: + type: string + minLength: 0 + maxLength: 255 + - name: LaunchTemplateData + in: query + required: true + description: The information for the launch template. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecificationRequest' + - description: The name or Amazon Resource Name (ARN) of an IAM instance profile. + BlockDeviceMapping: + allOf: + - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingRequestList' + - description: The block device mapping. + NetworkInterface: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance at Launch (Linux) or Adding User Data (Windows).
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
' + TagSpecification: + allOf: + - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequestList' + - description: 'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.' + ElasticGpuSpecification: + allOf: + - $ref: '#/components/schemas/ElasticGpuSpecificationList' + - description: An elastic GPU to associate with the instance. + ElasticInferenceAccelerator: + allOf: + - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorList' + - description: ' The elastic inference accelerator for the instance. ' + SecurityGroupId: + allOf: + - $ref: '#/components/schemas/SecurityGroupIdStringList' + - description: 'One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.' + SecurityGroup: + allOf: + - $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationRequest' + - description: 'The Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults toopen, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
+ LicenseSpecification:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptionsRequest'
+ - description: The maintenance options for the instance.
+ description: The information to include in the launch template.
You must specify at least one parameter for the launch template data.
Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateLaunchTemplateResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateLaunchTemplateRequest' + parameters: [] + /?Action=CreateLaunchTemplateVersion&Version=2016-11-15: + get: + x-aws-operation-name: CreateLaunchTemplateVersion + operationId: GET_CreateLaunchTemplateVersion + description: 'Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.
For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateLaunchTemplateVersionResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraint: Maximum 128 ASCII characters.
' + schema: + type: string + - name: LaunchTemplateId + in: query + required: false + description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request. + schema: + type: string + - name: LaunchTemplateName + in: query + required: false + description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. + schema: + type: string + pattern: '[a-zA-Z0-9\(\)\.\-/_]+' + minLength: 3 + maxLength: 128 + - name: SourceVersion + in: query + required: false + description: 'The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify inLaunchTemplateData. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.'
+ schema:
+ type: string
+ - name: VersionDescription
+ in: query
+ required: false
+ description: A description for the version of the launch template.
+ schema:
+ type: string
+ minLength: 0
+ maxLength: 255
+ - name: LaunchTemplateData
+ in: query
+ required: true
+ description: The information for the launch template.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecificationRequest'
+ - description: The name or Amazon Resource Name (ARN) of an IAM instance profile.
+ BlockDeviceMapping:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingRequestList'
+ - description: The block device mapping.
+ NetworkInterface:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance at Launch (Linux) or Adding User Data (Windows).
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
' + TagSpecification: + allOf: + - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequestList' + - description: 'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.' + ElasticGpuSpecification: + allOf: + - $ref: '#/components/schemas/ElasticGpuSpecificationList' + - description: An elastic GPU to associate with the instance. + ElasticInferenceAccelerator: + allOf: + - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorList' + - description: ' The elastic inference accelerator for the instance. ' + SecurityGroupId: + allOf: + - $ref: '#/components/schemas/SecurityGroupIdStringList' + - description: 'One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.' + SecurityGroup: + allOf: + - $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationRequest' + - description: 'The Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults toopen, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
+ LicenseSpecification:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptionsRequest'
+ - description: The maintenance options for the instance.
+ description: The information to include in the launch template.
You must specify at least one parameter for the launch template data.
Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.
For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateLaunchTemplateVersionResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateLaunchTemplateVersionRequest' + parameters: [] + /?Action=CreateLocalGatewayRoute&Version=2016-11-15: + get: + x-aws-operation-name: CreateLocalGatewayRoute + operationId: GET_CreateLocalGatewayRoute + description: Creates a static route for the specified local gateway route table. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateLocalGatewayRouteResult' + parameters: + - name: DestinationCidrBlock + in: query + required: true + description: The CIDR range used for destination matches. Routing decisions are based on the most specific match. + schema: + type: string + - name: LocalGatewayRouteTableId + in: query + required: true + description: The ID of the local gateway route table. + schema: + type: string + - name: LocalGatewayVirtualInterfaceGroupId + in: query + required: true + description: The ID of the virtual interface group. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateLocalGatewayRoute
+ operationId: POST_CreateLocalGatewayRoute
+ description: Creates a static route for the specified local gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateLocalGatewayRouteResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateLocalGatewayRouteRequest'
+ parameters: []
+ /?Action=CreateLocalGatewayRouteTableVpcAssociation&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateLocalGatewayRouteTableVpcAssociation
+ operationId: GET_CreateLocalGatewayRouteTableVpcAssociation
+ description: Associates the specified VPC with the specified local gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateLocalGatewayRouteTableVpcAssociationResult'
+ parameters:
+ - name: LocalGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the local gateway route table.
+ schema:
+ type: string
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC.
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to assign to the local gateway route table VPC association.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateLocalGatewayRouteTableVpcAssociation
+ operationId: POST_CreateLocalGatewayRouteTableVpcAssociation
+ description: Associates the specified VPC with the specified local gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateLocalGatewayRouteTableVpcAssociationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateLocalGatewayRouteTableVpcAssociationRequest'
+ parameters: []
+ /?Action=CreateManagedPrefixList&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateManagedPrefixList
+ operationId: GET_CreateManagedPrefixList
+ description: Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateManagedPrefixListResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PrefixListName
+ in: query
+ required: true
+ description: 'A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
The IP address type.
Valid Values: IPv4 | IPv6
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Up to 255 UTF-8 characters in length.
' + schema: + type: string + 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' + post: + x-aws-operation-name: CreateManagedPrefixList + operationId: POST_CreateManagedPrefixList + description: Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateManagedPrefixListResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateManagedPrefixListRequest' + parameters: [] + /?Action=CreateNatGateway&Version=2016-11-15: + get: + x-aws-operation-name: CreateNatGateway + operationId: GET_CreateNatGateway + description: 'Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.
With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.
With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.
For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNatGatewayResult' + parameters: + - name: AllocationId + in: query + required: false + description: '[Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.' + schema: + type: string + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
Constraint: Maximum 64 ASCII characters.
' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: SubnetId
+ in: query
+ required: true
+ description: The subnet in which to create the NAT gateway.
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to assign to the NAT gateway.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: ConnectivityType
+ in: query
+ required: false
+ description: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
+ schema:
+ type: string
+ enum:
+ - private
+ - public
+ 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'
+ post:
+ x-aws-operation-name: CreateNatGateway
+ operationId: POST_CreateNatGateway
+ description: 'Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.
With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.
With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.
For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNatGatewayResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNatGatewayRequest' + parameters: [] + /?Action=CreateNetworkAcl&Version=2016-11-15: + get: + x-aws-operation-name: CreateNetworkAcl + operationId: GET_CreateNetworkAcl + description: 'Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkAclResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC.
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to assign to the network ACL.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: CreateNetworkAcl
+ operationId: POST_CreateNetworkAcl
+ description: 'Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkAclResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkAclRequest' + parameters: [] + /?Action=CreateNetworkAclEntry&Version=2016-11-15: + get: + x-aws-operation-name: CreateNetworkAclEntry + operationId: GET_CreateNetworkAclEntry + description: 'Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can''t modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + parameters: + - name: CidrBlock + in: query + required: false + description: 'The IPv4 network range to allow or deny, in CIDR notation (for example172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.'
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Egress
+ in: query
+ required: true
+ description: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
+ schema:
+ type: boolean
+ - name: Icmp
+ in: query
+ required: false
+ description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.'
+ schema:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The ICMP code. A value of -1 means all codes for the specified ICMP type.
+ type:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The ICMP type. A value of -1 means all types.
+ description: Describes the ICMP type and code.
+ - name: Ipv6CidrBlock
+ in: query
+ required: false
+ description: 'The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).'
+ schema:
+ type: string
+ - name: NetworkAclId
+ in: query
+ required: true
+ description: The ID of the network ACL.
+ schema:
+ type: string
+ - name: PortRange
+ in: query
+ required: false
+ description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).'
+ schema:
+ type: object
+ properties:
+ from:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The first port in the range.
+ to:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The last port in the range.
+ description: Describes a range of ports.
+ - name: Protocol
+ in: query
+ required: true
+ description: 'The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.'
+ schema:
+ type: string
+ - name: RuleAction
+ in: query
+ required: true
+ description: Indicates whether to allow or deny the traffic that matches the rule.
+ schema:
+ type: string
+ enum:
+ - allow
+ - deny
+ - name: RuleNumber
+ in: query
+ required: true
+ description: 'The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
' + schema: + type: integer + 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' + post: + x-aws-operation-name: CreateNetworkAclEntry + operationId: POST_CreateNetworkAclEntry + description: 'Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can''t modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkAclEntryRequest' + parameters: [] + /?Action=CreateNetworkInsightsAccessScope&Version=2016-11-15: + get: + x-aws-operation-name: CreateNetworkInsightsAccessScope + operationId: GET_CreateNetworkInsightsAccessScope + description: 'Creates a Network Access Scope.
Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeResult' + parameters: + - name: MatchPath + in: query + required: false + description: The paths to match. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/AccessScopePathRequest' + - xml: + name: item + - name: ExcludePath + in: query + required: false + description: The paths to exclude. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/AccessScopePathRequest' + - xml: + name: item + - name: ClientToken + in: query + required: true + description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' + schema: + type: string + - name: TagSpecification + in: query + required: false + description: The tags to apply. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateNetworkInsightsAccessScope
+ operationId: POST_CreateNetworkInsightsAccessScope
+ description: 'Creates a Network Access Scope.
Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeRequest' + parameters: [] + /?Action=CreateNetworkInsightsPath&Version=2016-11-15: + get: + x-aws-operation-name: CreateNetworkInsightsPath + operationId: GET_CreateNetworkInsightsPath + description: 'Creates a path to analyze for reachability.
Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see What is Reachability Analyzer.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkInsightsPathResult' + parameters: + - name: SourceIp + in: query + required: false + description: The IP address of the Amazon Web Services resource that is the source of the path. + schema: + type: string + pattern: '^([0-9]{1,3}.){3}[0-9]{1,3}$' + minLength: 0 + maxLength: 15 + - name: DestinationIp + in: query + required: false + description: The IP address of the Amazon Web Services resource that is the destination of the path. + schema: + type: string + pattern: '^([0-9]{1,3}.){3}[0-9]{1,3}$' + minLength: 0 + maxLength: 15 + - name: Source + in: query + required: true + description: The Amazon Web Services resource that is the source of the path. + schema: + type: string + - name: Destination + in: query + required: true + description: The Amazon Web Services resource that is the destination of the path. + schema: + type: string + - name: Protocol + in: query + required: true + description: The protocol. + schema: + type: string + enum: + - tcp + - udp + - name: DestinationPort + in: query + required: false + description: The destination port. + schema: + type: integer + minimum: 1 + maximum: 65535 + - name: TagSpecification + in: query + required: false + description: The tags to add to the path. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: true
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CreateNetworkInsightsPath
+ operationId: POST_CreateNetworkInsightsPath
+ description: 'Creates a path to analyze for reachability.
Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see What is Reachability Analyzer.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkInsightsPathResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkInsightsPathRequest' + parameters: [] + /?Action=CreateNetworkInterface&Version=2016-11-15: + get: + x-aws-operation-name: CreateNetworkInterface + operationId: GET_CreateNetworkInterface + description: 'Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkInterfaceResult' + parameters: + - name: Description + in: query + required: false + description: A description for the network interface. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: SecurityGroupId
+ in: query
+ required: false
+ description: The IDs of one or more security groups.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: SecurityGroupId
+ - name: Ipv6AddressCount
+ in: query
+ required: false
+ description: 'The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can''t use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.'
+ schema:
+ type: integer
+ - name: Ipv6Addresses
+ in: query
+ required: false
+ description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIpv6Address'
+ - xml:
+ name: item
+ - name: PrivateIpAddress
+ in: query
+ required: false
+ description: 'The primary private IPv4 address of the network interface. If you don''t specify an IPv4 address, Amazon EC2 selects one for you from the subnet''s IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).'
+ schema:
+ type: string
+ - name: PrivateIpAddresses
+ in: query
+ required: false
+ description: One or more private IPv4 addresses.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PrivateIpAddressSpecification'
+ - xml:
+ name: item
+ - name: SecondaryPrivateIpAddressCount
+ in: query
+ required: false
+ description: 'The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet''s IPv4 CIDR range. You can''t specify this option and specify more than one private IP address using privateIpAddresses.
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.
' + schema: + type: integer + - name: Ipv4Prefix + in: query + required: false + description: One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use theIpv4PrefixCount option.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PrefixSpecificationRequest'
+ - xml:
+ name: item
+ - name: Ipv4PrefixCount
+ in: query
+ required: false
+ description: The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
+ schema:
+ type: integer
+ - name: Ipv6Prefix
+ in: query
+ required: false
+ description: One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6PrefixSpecificationRequest'
+ - xml:
+ name: item
+ - name: Ipv6PrefixCount
+ in: query
+ required: false
+ description: The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.
+ schema:
+ type: integer
+ - name: InterfaceType
+ in: query
+ required: false
+ description: The type of network interface. The default is interface.
The only supported values are efa and trunk.
Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkInterfaceResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkInterfaceRequest' + parameters: [] + /?Action=CreateNetworkInterfacePermission&Version=2016-11-15: + get: + x-aws-operation-name: CreateNetworkInterfacePermission + operationId: GET_CreateNetworkInterfacePermission + description: 'Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single Amazon Web Services account only, and only one account at a time.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkInterfacePermissionResult' + parameters: + - name: NetworkInterfaceId + in: query + required: true + description: The ID of the network interface. + schema: + type: string + - name: AwsAccountId + in: query + required: false + description: The Amazon Web Services account ID. + schema: + type: string + - name: AwsService + in: query + required: false + description: The Amazon Web Service. Currently not supported. + schema: + type: string + - name: Permission + in: query + required: true + description: The type of permission to grant. + schema: + type: string + enum: + - INSTANCE-ATTACH + - EIP-ASSOCIATE + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateNetworkInterfacePermission
+ operationId: POST_CreateNetworkInterfacePermission
+ description: 'Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single Amazon Web Services account only, and only one account at a time.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkInterfacePermissionResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateNetworkInterfacePermissionRequest' + parameters: [] + /?Action=CreatePlacementGroup&Version=2016-11-15: + get: + x-aws-operation-name: CreatePlacementGroup + operationId: GET_CreatePlacementGroup + description: 'Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement groups in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreatePlacementGroupResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: GroupName
+ in: query
+ required: false
+ description: 'A name for the placement group. Must be unique within the scope of your account for the Region.
Constraints: Up to 255 ASCII characters
' + schema: + type: string + - name: Strategy + in: query + required: false + description: The placement strategy. + schema: + type: string + enum: + - cluster + - spread + - partition + - name: PartitionCount + in: query + required: false + description: The number of partitions. Valid only when Strategy is set topartition.
+ schema:
+ type: integer
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply to the new placement group.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: CreatePlacementGroup
+ operationId: POST_CreatePlacementGroup
+ description: 'Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement groups in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreatePlacementGroupResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreatePlacementGroupRequest' + parameters: [] + /?Action=CreatePublicIpv4Pool&Version=2016-11-15: + get: + x-aws-operation-name: CreatePublicIpv4Pool + operationId: GET_CreatePublicIpv4Pool + description: 'Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreatePublicIpv4PoolResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: TagSpecification
+ in: query
+ required: false
+ description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: CreatePublicIpv4Pool
+ operationId: POST_CreatePublicIpv4Pool
+ description: 'Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreatePublicIpv4PoolResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreatePublicIpv4PoolRequest'
+ parameters: []
+ /?Action=CreateReplaceRootVolumeTask&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateReplaceRootVolumeTask
+ operationId: GET_CreateReplaceRootVolumeTask
+ description: 'Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot.
For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateReplaceRootVolumeTaskResult' + parameters: + - name: InstanceId + in: query + required: true + description: The ID of the instance for which to replace the root volume. + schema: + type: string + - name: SnapshotId + in: query + required: false + description: 'The ID of the snapshot from which to restore the replacement root volume. If you want to restore the volume to the initial launch state, omit this parameter.' + schema: + type: string + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring idempotency.' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply to the root volume replacement task.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: CreateReplaceRootVolumeTask
+ operationId: POST_CreateReplaceRootVolumeTask
+ description: 'Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot.
For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateReplaceRootVolumeTaskResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateReplaceRootVolumeTaskRequest' + parameters: [] + /?Action=CreateReservedInstancesListing&Version=2016-11-15: + get: + x-aws-operation-name: CreateReservedInstancesListing + operationId: GET_CreateReservedInstancesListing + description: 'Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.
The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateReservedInstancesListingResult' + parameters: + - name: ClientToken + in: query + required: true + description: 'Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.' + schema: + type: string + - name: InstanceCount + in: query + required: true + description: The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call. + schema: + type: integer + - name: PriceSchedules + in: query + required: true + description: A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/PriceScheduleSpecification' + - xml: + name: item + - name: ReservedInstancesId + in: query + required: true + description: The ID of the active Standard Reserved Instance. + schema: + type: string + 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' + post: + x-aws-operation-name: CreateReservedInstancesListing + operationId: POST_CreateReservedInstancesListing + description: 'Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.
The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateReservedInstancesListingResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateReservedInstancesListingRequest' + parameters: [] + /?Action=CreateRestoreImageTask&Version=2016-11-15: + get: + x-aws-operation-name: CreateRestoreImageTask + operationId: GET_CreateRestoreImageTask + description: 'Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateRestoreImageTaskResult' + parameters: + - name: Bucket + in: query + required: true + description: The name of the Amazon S3 bucket that contains the stored AMI object. + schema: + type: string + - name: ObjectKey + in: query + required: true + description: The name of the stored AMI object in the bucket. + schema: + type: string + - name: Name + in: query + required: false + description: 'The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.' + schema: + type: string + - name: TagSpecification + in: query + required: false + description: 'The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.
To tag the AMI, the value for ResourceType must be image.
To tag the snapshots, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateRestoreImageTask
+ operationId: POST_CreateRestoreImageTask
+ description: 'Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateRestoreImageTaskResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateRestoreImageTaskRequest' + parameters: [] + /?Action=CreateRoute&Version=2016-11-15: + get: + x-aws-operation-name: CreateRoute + operationId: GET_CreateRoute + description: 'Creates a route in a route table within a VPC.
You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateRouteResult' + parameters: + - name: DestinationCidrBlock + in: query + required: false + description: 'The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify100.68.0.18/18, we modify it to 100.68.0.0/18.'
+ schema:
+ type: string
+ - name: DestinationIpv6CidrBlock
+ in: query
+ required: false
+ description: The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
+ schema:
+ type: string
+ - name: DestinationPrefixListId
+ in: query
+ required: false
+ description: The ID of a prefix list used for the destination match.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcEndpointId
+ in: query
+ required: false
+ description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
+ schema:
+ type: string
+ - name: EgressOnlyInternetGatewayId
+ in: query
+ required: false
+ description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
+ schema:
+ type: string
+ - name: GatewayId
+ in: query
+ required: false
+ description: The ID of an internet gateway or virtual private gateway attached to your VPC.
+ schema:
+ type: string
+ - name: InstanceId
+ in: query
+ required: false
+ description: The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
+ schema:
+ type: string
+ - name: NatGatewayId
+ in: query
+ required: false
+ description: '[IPv4 traffic only] The ID of a NAT gateway.'
+ schema:
+ type: string
+ - name: TransitGatewayId
+ in: query
+ required: false
+ description: The ID of a transit gateway.
+ schema:
+ type: string
+ - name: LocalGatewayId
+ in: query
+ required: false
+ description: The ID of the local gateway.
+ schema:
+ type: string
+ - name: CarrierGatewayId
+ in: query
+ required: false
+ description: The ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
+ schema: + type: string + - name: NetworkInterfaceId + in: query + required: false + description: The ID of a network interface. + schema: + type: string + - name: RouteTableId + in: query + required: true + description: The ID of the route table for the route. + schema: + type: string + - name: VpcPeeringConnectionId + in: query + required: false + description: The ID of a VPC peering connection. + schema: + type: string + - name: CoreNetworkArn + in: query + required: false + description: The Amazon Resource Name (ARN) of the core network. + schema: + type: string + 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' + post: + x-aws-operation-name: CreateRoute + operationId: POST_CreateRoute + description: 'Creates a route in a route table within a VPC.
You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateRouteResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateRouteRequest' + parameters: [] + /?Action=CreateRouteTable&Version=2016-11-15: + get: + x-aws-operation-name: CreateRouteTable + operationId: GET_CreateRouteTable + description: 'Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateRouteTableResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC.
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to assign to the route table.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: CreateRouteTable
+ operationId: POST_CreateRouteTable
+ description: 'Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateRouteTableResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateRouteTableRequest' + parameters: [] + /?Action=CreateSecurityGroup&Version=2016-11-15: + get: + x-aws-operation-name: CreateSecurityGroup + operationId: GET_CreateSecurityGroup + description: 'Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can''t have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don''t specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.
For more information about VPC security group limits, see Amazon VPC Limits.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateSecurityGroupResult' + parameters: + - name: GroupDescription + in: query + required: true + description: 'A description for the security group. This is informational only.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' + schema: + type: string + - name: GroupName + in: query + required: true + description: 'The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg-.
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' + schema: + type: string + - name: VpcId + in: query + required: false + description: '[EC2-VPC] The ID of the VPC. Required for EC2-VPC.' + schema: + type: string + - name: TagSpecification + in: query + required: false + description: The tags to assign to the security group. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateSecurityGroup
+ operationId: POST_CreateSecurityGroup
+ description: 'Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can''t have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don''t specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.
For more information about VPC security group limits, see Amazon VPC Limits.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateSecurityGroupResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateSecurityGroupRequest' + parameters: [] + /?Action=CreateSnapshot&Version=2016-11-15: + get: + x-aws-operation-name: CreateSnapshot + operationId: GET_CreateSnapshot + description: 'Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.
To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/Snapshot' + parameters: + - name: Description + in: query + required: false + description: A description for the snapshot. + schema: + type: string + - name: OutpostArn + in: query + required: false + description: 'The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.
To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.
To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.
To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.
For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.
' + schema: + type: string + - name: VolumeId + in: query + required: true + description: The ID of the Amazon EBS volume. + schema: + type: string + - name: TagSpecification + in: query + required: false + description: The tags to apply to the snapshot during creation. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateSnapshot
+ operationId: POST_CreateSnapshot
+ description: 'Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.
To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/Snapshot' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateSnapshotRequest' + parameters: [] + /?Action=CreateSnapshots&Version=2016-11-15: + get: + x-aws-operation-name: CreateSnapshots + operationId: GET_CreateSnapshots + description: 'Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters.
You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateSnapshotsResult' + parameters: + - name: Description + in: query + required: false + description: ' A description propagated to every snapshot specified by the instance.' + schema: + type: string + - name: InstanceSpecification + in: query + required: true + description: The instance to specify which volumes should be included in the snapshots. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Excludes the root volume from being snapshotted. + description: The instance details to specify which volumes should be snapshotted. + - name: OutpostArn + in: query + required: false + description: 'The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.
To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.
To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.
To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.
For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.
' + schema: + type: string + - name: TagSpecification + in: query + required: false + description: Tags to apply to every snapshot specified by the instance. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: CopyTagsFromSource
+ in: query
+ required: false
+ description: Copies the tags from the specified volume to corresponding snapshot.
+ schema:
+ type: string
+ enum:
+ - volume
+ 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'
+ post:
+ x-aws-operation-name: CreateSnapshots
+ operationId: POST_CreateSnapshots
+ description: 'Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters.
You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateSnapshotsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateSnapshotsRequest' + parameters: [] + /?Action=CreateSpotDatafeedSubscription&Version=2016-11-15: + get: + x-aws-operation-name: CreateSpotDatafeedSubscription + operationId: GET_CreateSpotDatafeedSubscription + description: 'Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateSpotDatafeedSubscriptionResult' + parameters: + - name: Bucket + in: query + required: true + description: 'The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Prefix
+ in: query
+ required: false
+ description: The prefix for the data feed file names.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CreateSpotDatafeedSubscription
+ operationId: POST_CreateSpotDatafeedSubscription
+ description: 'Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateSpotDatafeedSubscriptionResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateSpotDatafeedSubscriptionRequest'
+ parameters: []
+ /?Action=CreateStoreImageTask&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateStoreImageTask
+ operationId: GET_CreateStoreImageTask
+ description: 'Stores an AMI as a single object in an Amazon S3 bucket.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateStoreImageTaskResult' + parameters: + - name: ImageId + in: query + required: true + description: The ID of the AMI. + schema: + type: string + - name: Bucket + in: query + required: true + description: 'The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed. ' + schema: + type: string + - name: S3ObjectTag + in: query + required: false + description: 'The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. ' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/S3ObjectTag' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateStoreImageTask
+ operationId: POST_CreateStoreImageTask
+ description: 'Stores an AMI as a single object in an Amazon S3 bucket.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateStoreImageTaskResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateStoreImageTaskRequest' + parameters: [] + /?Action=CreateSubnet&Version=2016-11-15: + get: + x-aws-operation-name: CreateSubnet + operationId: GET_CreateSubnet + description: 'Creates a subnet in a specified VPC.
You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can''t change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.
If you''ve associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.
Amazon Web Services reserves both the first four and the last IPv4 address in each subnet''s CIDR block. They''re not available for use.
If you add more than one subnet to a VPC, they''re set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It''s therefore possible to have a subnet with no running instances (they''re all stopped), but no remaining IP addresses available.
For more information about subnets, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateSubnetResult' + parameters: + - name: TagSpecification + in: query + required: false + description: The tags to assign to the subnet. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: AvailabilityZone + in: query + required: false + description: 'The Availability Zone or Local Zone for the subnet.
Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.
To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide.
To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.
' + schema: + type: string + - name: AvailabilityZoneId + in: query + required: false + description: The AZ ID or the Local Zone ID of the subnet. + schema: + type: string + - name: CidrBlock + in: query + required: false + description: 'The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
This parameter is not supported for an IPv6 only subnet.
' + schema: + type: string + - name: Ipv6CidrBlock + in: query + required: false + description: 'The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
This parameter is required for an IPv6 only subnet.
' + schema: + type: string + - name: OutpostArn + in: query + required: false + description: 'The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.' + schema: + type: string + - name: VpcId + in: query + required: true + description: The ID of the VPC. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Ipv6Native
+ in: query
+ required: false
+ description: Indicates whether to create an IPv6 only subnet.
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateSubnet
+ operationId: POST_CreateSubnet
+ description: 'Creates a subnet in a specified VPC.
You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can''t change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.
If you''ve associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.
Amazon Web Services reserves both the first four and the last IPv4 address in each subnet''s CIDR block. They''re not available for use.
If you add more than one subnet to a VPC, they''re set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It''s therefore possible to have a subnet with no running instances (they''re all stopped), but no remaining IP addresses available.
For more information about subnets, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateSubnetResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateSubnetRequest' + parameters: [] + /?Action=CreateSubnetCidrReservation&Version=2016-11-15: + get: + x-aws-operation-name: CreateSubnetCidrReservation + operationId: GET_CreateSubnetCidrReservation + description: 'Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateSubnetCidrReservationResult' + parameters: + - name: SubnetId + in: query + required: true + description: The ID of the subnet. + schema: + type: string + - name: Cidr + in: query + required: true + description: The IPv4 or IPV6 CIDR range to reserve. + schema: + type: string + - name: ReservationType + in: query + required: true + description: 'The type of reservation.
The following are valid values:
prefix: The Amazon EC2 Prefix Delegation feature assigns the IP addresses to network interfaces that are associated with an instance. For information about Prefix Delegation, see Prefix Delegation for Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
explicit: You manually assign the IP addresses to resources that reside in your subnet.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to assign to the subnet CIDR reservation.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: CreateSubnetCidrReservation
+ operationId: POST_CreateSubnetCidrReservation
+ description: 'Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateSubnetCidrReservationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateSubnetCidrReservationRequest'
+ parameters: []
+ /?Action=CreateTags&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateTags
+ operationId: GET_CreateTags
+ description: 'Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users'' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ResourceId
+ in: query
+ required: true
+ description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' + schema: + type: array + items: + $ref: '#/components/schemas/TaggableResourceId' + - name: Tag + in: query + required: true + description: 'The tags. Thevalue parameter is required, but if you don''t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Tag'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: CreateTags
+ operationId: POST_CreateTags
+ description: 'Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users'' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTagsRequest' + parameters: [] + /?Action=CreateTrafficMirrorFilter&Version=2016-11-15: + get: + x-aws-operation-name: CreateTrafficMirrorFilter + operationId: GET_CreateTrafficMirrorFilter + description: 'Creates a Traffic Mirror filter.
A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorFilterResult' + parameters: + - name: Description + in: query + required: false + description: The description of the Traffic Mirror filter. + schema: + type: string + - name: TagSpecification + in: query + required: false + description: The tags to assign to a Traffic Mirror filter. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CreateTrafficMirrorFilter
+ operationId: POST_CreateTrafficMirrorFilter
+ description: 'Creates a Traffic Mirror filter.
A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorFilterResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorFilterRequest' + parameters: [] + /?Action=CreateTrafficMirrorFilterRule&Version=2016-11-15: + get: + x-aws-operation-name: CreateTrafficMirrorFilterRule + operationId: GET_CreateTrafficMirrorFilterRule + description:Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleResult' + parameters: + - name: TrafficMirrorFilterId + in: query + required: true + description: The ID of the filter that this rule is associated with. + schema: + type: string + - name: TrafficDirection + in: query + required: true + description: The type of traffic. + schema: + type: string + enum: + - ingress + - egress + - name: RuleNumber + in: query + required: true + description: The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number. + schema: + type: integer + - name: RuleAction + in: query + required: true + description: The action to take on the filtered traffic. + schema: + type: string + enum: + - accept + - reject + - name: DestinationPortRange + in: query + required: false + description: The destination port range. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. + description: Information about the Traffic Mirror filter rule port range. + - name: SourcePortRange + in: query + required: false + description: The source port range. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. + description: Information about the Traffic Mirror filter rule port range. + - name: Protocol + in: query + required: false + description: 'The protocol, for example UDP, to assign to the Traffic Mirror rule.
For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.
' + schema: + type: integer + - name: DestinationCidrBlock + in: query + required: true + description: The destination CIDR block to assign to the Traffic Mirror rule. + schema: + type: string + - name: SourceCidrBlock + in: query + required: true + description: The source CIDR block to assign to the Traffic Mirror rule. + schema: + type: string + - name: Description + in: query + required: false + description: The description of the Traffic Mirror rule. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CreateTrafficMirrorFilterRule
+ operationId: POST_CreateTrafficMirrorFilterRule
+ description: Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleRequest' + parameters: [] + /?Action=CreateTrafficMirrorSession&Version=2016-11-15: + get: + x-aws-operation-name: CreateTrafficMirrorSession + operationId: GET_CreateTrafficMirrorSession + description: 'Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorSessionResult' + parameters: + - name: NetworkInterfaceId + in: query + required: true + description: The ID of the source network interface. + schema: + type: string + - name: TrafficMirrorTargetId + in: query + required: true + description: The ID of the Traffic Mirror target. + schema: + type: string + - name: TrafficMirrorFilterId + in: query + required: true + description: The ID of the Traffic Mirror filter. + schema: + type: string + - name: PacketLength + in: query + required: false + description: 'The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.
If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
+ schema: + type: integer + - name: VirtualNetworkId + in: query + required: false + description: 'The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify aVirtualNetworkId, an account-wide unique id is chosen at random.'
+ schema:
+ type: integer
+ - name: Description
+ in: query
+ required: false
+ description: The description of the Traffic Mirror session.
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to assign to a Traffic Mirror session.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CreateTrafficMirrorSession
+ operationId: POST_CreateTrafficMirrorSession
+ description: 'Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorSessionResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorSessionRequest' + parameters: [] + /?Action=CreateTrafficMirrorTarget&Version=2016-11-15: + get: + x-aws-operation-name: CreateTrafficMirrorTarget + operationId: GET_CreateTrafficMirrorTarget + description: 'Creates a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.
To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorTargetResult' + parameters: + - name: NetworkInterfaceId + in: query + required: false + description: The network interface ID that is associated with the target. + schema: + type: string + - name: NetworkLoadBalancerArn + in: query + required: false + description: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target. + schema: + type: string + - name: Description + in: query + required: false + description: The description of the Traffic Mirror target. + schema: + type: string + - name: TagSpecification + in: query + required: false + description: The tags to assign to the Traffic Mirror target. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ - name: GatewayLoadBalancerEndpointId
+ in: query
+ required: false
+ description: The ID of the Gateway Load Balancer endpoint.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CreateTrafficMirrorTarget
+ operationId: POST_CreateTrafficMirrorTarget
+ description: 'Creates a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.
To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorTargetResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTrafficMirrorTargetRequest' + parameters: [] + /?Action=CreateTransitGateway&Version=2016-11-15: + get: + x-aws-operation-name: CreateTransitGateway + operationId: GET_CreateTransitGateway + description: 'Creates a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment.
To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayResult' + parameters: + - name: Description + in: query + required: false + description: A description of the transit gateway. + schema: + type: string + - name: Options + in: query + required: false + description: The transit gateway options. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/TransitGatewayCidrBlockStringList' + - description: 'One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.' + description: Describes the options for a transit gateway. + - name: TagSpecification + in: query + required: false + description: The tags to apply to the transit gateway. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateTransitGateway
+ operationId: POST_CreateTransitGateway
+ description: 'Creates a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment.
To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayRequest' + parameters: [] + /?Action=CreateTransitGatewayConnect&Version=2016-11-15: + get: + x-aws-operation-name: CreateTransitGatewayConnect + operationId: GET_CreateTransitGatewayConnect + description:Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayConnectResult' + parameters: + - name: TransportTransitGatewayAttachmentId + in: query + required: true + description: The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment. + schema: + type: string + - name: Options + in: query + required: true + description: The Connect attachment options. + schema: + type: object + required: + - Protocol + properties: + undefined: + allOf: + - $ref: '#/components/schemas/ProtocolValue' + - description: The tunnel protocol. + description: The options for a Connect attachment. + - name: TagSpecification + in: query + required: false + description: The tags to apply to the Connect attachment. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateTransitGatewayConnect
+ operationId: POST_CreateTransitGatewayConnect
+ description: Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayConnectResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayConnectRequest' + parameters: [] + /?Action=CreateTransitGatewayConnectPeer&Version=2016-11-15: + get: + x-aws-operation-name: CreateTransitGatewayConnectPeer + operationId: GET_CreateTransitGatewayConnectPeer + description: 'Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
For more information, see Connect peers in the Transit Gateways Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayConnectPeerResult' + parameters: + - name: TransitGatewayAttachmentId + in: query + required: true + description: The ID of the Connect attachment. + schema: + type: string + - name: TransitGatewayAddress + in: query + required: false + description: 'The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.' + schema: + type: string + - name: PeerAddress + in: query + required: true + description: The peer IP address (GRE outer IP address) on the appliance side of the Connect peer. + schema: + type: string + - name: BgpOptions + in: query + required: false + description: The BGP options for the Connect peer. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Long' + - description: The peer Autonomous System Number (ASN). + description: The BGP options for the Connect attachment. + - name: InsideCidrBlocks + in: query + required: true + description: 'The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply to the Connect peer.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateTransitGatewayConnectPeer
+ operationId: POST_CreateTransitGatewayConnectPeer
+ description: 'Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
For more information, see Connect peers in the Transit Gateways Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayConnectPeerResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayConnectPeerRequest' + parameters: [] + /?Action=CreateTransitGatewayMulticastDomain&Version=2016-11-15: + get: + x-aws-operation-name: CreateTransitGatewayMulticastDomain + operationId: GET_CreateTransitGatewayMulticastDomain + description: 'Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainResult' + parameters: + - name: TransitGatewayId + in: query + required: true + description: The ID of the transit gateway. + schema: + type: string + - name: Options + in: query + required: false + description: The options for the transit gateway multicast domain. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/AutoAcceptSharedAssociationsValue' + - description: Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain. + description: The options for the transit gateway multicast domain. + - name: TagSpecification + in: query + required: false + description: The tags for the transit gateway multicast domain. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateTransitGatewayMulticastDomain
+ operationId: POST_CreateTransitGatewayMulticastDomain
+ description: 'Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainRequest' + parameters: [] + /?Action=CreateTransitGatewayPeeringAttachment&Version=2016-11-15: + get: + x-aws-operation-name: CreateTransitGatewayPeeringAttachment + operationId: GET_CreateTransitGatewayPeeringAttachment + description: 'Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different Amazon Web Services account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentResult' + parameters: + - name: TransitGatewayId + in: query + required: true + description: The ID of the transit gateway. + schema: + type: string + - name: PeerTransitGatewayId + in: query + required: true + description: The ID of the peer transit gateway with which to create the peering attachment. + schema: + type: string + - name: PeerAccountId + in: query + required: true + description: The ID of the Amazon Web Services account that owns the peer transit gateway. + schema: + type: string + - name: PeerRegion + in: query + required: true + description: The Region where the peer transit gateway is located. + schema: + type: string + - name: TagSpecification + in: query + required: false + description: The tags to apply to the transit gateway peering attachment. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateTransitGatewayPeeringAttachment
+ operationId: POST_CreateTransitGatewayPeeringAttachment
+ description: 'Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different Amazon Web Services account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentRequest' + parameters: [] + /?Action=CreateTransitGatewayPrefixListReference&Version=2016-11-15: + get: + x-aws-operation-name: CreateTransitGatewayPrefixListReference + operationId: GET_CreateTransitGatewayPrefixListReference + description: Creates a reference (route) to a prefix list in a specified transit gateway route table. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceResult' + parameters: + - name: TransitGatewayRouteTableId + in: query + required: true + description: The ID of the transit gateway route table. + schema: + type: string + - name: PrefixListId + in: query + required: true + description: The ID of the prefix list that is used for destination matches. + schema: + type: string + - name: TransitGatewayAttachmentId + in: query + required: false + description: The ID of the attachment to which traffic is routed. + schema: + type: string + - name: Blackhole + in: query + required: false + description: Indicates whether to drop traffic that matches this route. + schema: + type: boolean + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateTransitGatewayPrefixListReference
+ operationId: POST_CreateTransitGatewayPrefixListReference
+ description: Creates a reference (route) to a prefix list in a specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceRequest'
+ parameters: []
+ /?Action=CreateTransitGatewayRoute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateTransitGatewayRoute
+ operationId: GET_CreateTransitGatewayRoute
+ description: Creates a static route for the specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateTransitGatewayRouteResult'
+ parameters:
+ - name: DestinationCidrBlock
+ in: query
+ required: true
+ description: The CIDR range used for destination matches. Routing decisions are based on the most specific match.
+ schema:
+ type: string
+ - name: TransitGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the transit gateway route table.
+ schema:
+ type: string
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: false
+ description: The ID of the attachment.
+ schema:
+ type: string
+ - name: Blackhole
+ in: query
+ required: false
+ description: Indicates whether to drop traffic that matches this route.
+ schema:
+ type: boolean
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateTransitGatewayRoute
+ operationId: POST_CreateTransitGatewayRoute
+ description: Creates a static route for the specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateTransitGatewayRouteResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateTransitGatewayRouteRequest'
+ parameters: []
+ /?Action=CreateTransitGatewayRouteTable&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateTransitGatewayRouteTable
+ operationId: GET_CreateTransitGatewayRouteTable
+ description: Creates a route table for the specified transit gateway.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateTransitGatewayRouteTableResult'
+ parameters:
+ - name: TransitGatewayId
+ in: query
+ required: true
+ description: The ID of the transit gateway.
+ schema:
+ type: string
+ - name: TagSpecifications
+ in: query
+ required: false
+ description: The tags to apply to the transit gateway route table.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateTransitGatewayRouteTable
+ operationId: POST_CreateTransitGatewayRouteTable
+ description: Creates a route table for the specified transit gateway.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateTransitGatewayRouteTableResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/CreateTransitGatewayRouteTableRequest'
+ parameters: []
+ /?Action=CreateTransitGatewayVpcAttachment&Version=2016-11-15:
+ get:
+ x-aws-operation-name: CreateTransitGatewayVpcAttachment
+ operationId: GET_CreateTransitGatewayVpcAttachment
+ description: 'Attaches the specified VPC to the specified transit gateway.
If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.
To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentResult' + parameters: + - name: TransitGatewayId + in: query + required: true + description: The ID of the transit gateway. + schema: + type: string + - name: VpcId + in: query + required: true + description: The ID of the VPC. + schema: + type: string + - name: SubnetIds + in: query + required: true + description: 'The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SubnetId' + - xml: + name: item + - name: Options + in: query + required: false + description: The VPC attachment options. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/ApplianceModeSupportValue' + - description: 'Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default isdisable.'
+ description: Describes the options for a VPC attachment.
+ - name: TagSpecifications
+ in: query
+ required: false
+ description: The tags to apply to the VPC attachment.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateTransitGatewayVpcAttachment
+ operationId: POST_CreateTransitGatewayVpcAttachment
+ description: 'Attaches the specified VPC to the specified transit gateway.
If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.
To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentRequest' + parameters: [] + /?Action=CreateVolume&Version=2016-11-15: + get: + x-aws-operation-name: CreateVolume + operationId: GET_CreateVolume + description: 'Creates an EBS volume that can be attached to an instance in the same Availability Zone.
You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Create an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/Volume' + parameters: + - name: AvailabilityZone + in: query + required: true + description: The Availability Zone in which to create the volume. + schema: + type: string + - name: Encrypted + in: query + required: false + description: 'Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
' + schema: + type: boolean + - name: Iops + in: query + required: false + description: 'The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System. Other instance families support performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
' + schema: + type: string + - name: OutpostArn + in: query + required: false + description: The Amazon Resource Name (ARN) of the Outpost. + schema: + type: string + - name: Size + in: query + required: false + description: 'The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: gp2
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply to the volume during creation.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: MultiAttachEnabled
+ in: query
+ required: false
+ description: 'Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.'
+ schema:
+ type: boolean
+ - name: Throughput
+ in: query
+ required: false
+ description: 'The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
' + schema: + type: integer + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.' + schema: + type: string + 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' + post: + x-aws-operation-name: CreateVolume + operationId: POST_CreateVolume + description: 'Creates an EBS volume that can be attached to an instance in the same Availability Zone.
You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Create an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/Volume' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVolumeRequest' + parameters: [] + /?Action=CreateVpc&Version=2016-11-15: + get: + x-aws-operation-name: CreateVpc + operationId: GET_CreateVpc + description: 'Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon''s pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
You can specify the instance tenancy value for the VPC when you create it. You can''t change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpcResult' + parameters: + - name: CidrBlock + in: query + required: false + description: 'The IPv4 network range for the VPC, in CIDR notation. For example,10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.'
+ schema:
+ type: string
+ - name: AmazonProvidedIpv6CidrBlock
+ in: query
+ required: false
+ description: 'Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.'
+ schema:
+ type: boolean
+ - name: Ipv6Pool
+ in: query
+ required: false
+ description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
+ schema:
+ type: string
+ - name: Ipv6CidrBlock
+ in: query
+ required: false
+ description: 'The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
' + schema: + type: string + - name: Ipv4IpamPoolId + in: query + required: false + description: 'The ID of an IPv4 IPAM pool you want to use for allocating this VPC''s CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide. ' + schema: + type: string + - name: Ipv4NetmaskLength + in: query + required: false + description: 'The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.' + schema: + type: integer + - name: Ipv6IpamPoolId + in: query + required: false + description: 'The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.' + schema: + type: string + - name: Ipv6NetmaskLength + in: query + required: false + description: 'The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.' + schema: + type: integer + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceTenancy
+ in: query
+ required: false
+ description: 'The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon''s pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
You can specify the instance tenancy value for the VPC when you create it. You can''t change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpcResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpcRequest' + parameters: [] + /?Action=CreateVpcEndpoint&Version=2016-11-15: + get: + x-aws-operation-name: CreateVpcEndpoint + operationId: GET_CreateVpcEndpoint + description: 'Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the Amazon Web Services PrivateLink Guide.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpcEndpointResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcEndpointType
+ in: query
+ required: false
+ description: 'The type of endpoint.
Default: Gateway
' + schema: + type: string + enum: + - Interface + - Gateway + - GatewayLoadBalancer + - name: VpcId + in: query + required: true + description: The ID of the VPC in which the endpoint will be used. + schema: + type: string + - name: ServiceName + in: query + required: true + description: 'The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.' + schema: + type: string + - name: PolicyDocument + in: query + required: false + description: '(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.' + schema: + type: string + - name: RouteTableId + in: query + required: false + description: (Gateway endpoint) One or more route table IDs. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/RouteTableId' + - xml: + name: item + - name: SubnetId + in: query + required: false + description: '(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SubnetId' + - xml: + name: item + - name: SecurityGroupId + in: query + required: false + description: (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SecurityGroupId' + - xml: + name: item + - name: IpAddressType + in: query + required: false + description: The IP address type for the endpoint. + schema: + type: string + enum: + - ipv4 + - dualstack + - ipv6 + - name: DnsOptions + in: query + required: false + description: The DNS options for the endpoint. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/DnsRecordIpType' + - description: The DNS records created for the endpoint. + description: Describes the DNS options for an endpoint. + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' + schema: + type: string + - name: PrivateDnsEnabled + in: query + required: false + description: '(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
Default: true
Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
You can create a connection notification for interface endpoints only.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ServiceId
+ in: query
+ required: false
+ description: The ID of the endpoint service.
+ schema:
+ type: string
+ - name: VpcEndpointId
+ in: query
+ required: false
+ description: The ID of the endpoint.
+ schema:
+ type: string
+ - name: ConnectionNotificationArn
+ in: query
+ required: true
+ description: The ARN of the SNS topic for the notifications.
+ schema:
+ type: string
+ - name: ConnectionEvents
+ in: query
+ required: true
+ description: 'One or more endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: CreateVpcEndpointConnectionNotification
+ operationId: POST_CreateVpcEndpointConnectionNotification
+ description: 'Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
You can create a connection notification for interface endpoints only.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationRequest' + parameters: [] + /?Action=CreateVpcEndpointServiceConfiguration&Version=2016-11-15: + get: + x-aws-operation-name: CreateVpcEndpointServiceConfiguration + operationId: GET_CreateVpcEndpointServiceConfiguration + description: 'Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, IAM users, and IAM roles) can connect.
Before you create an endpoint service, you must create one of the following for your service:
A Network Load Balancer. Service consumers connect to your service using an interface endpoint.
A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint.
If you set the private DNS name, you must prove that you own the private DNS domain name.
For more information, see the Amazon Web Services PrivateLink Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: AcceptanceRequired
+ in: query
+ required: false
+ description: Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.
+ schema:
+ type: boolean
+ - name: PrivateDnsName
+ in: query
+ required: false
+ description: (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
+ schema:
+ type: string
+ - name: NetworkLoadBalancerArn
+ in: query
+ required: false
+ description: The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: GatewayLoadBalancerArn
+ in: query
+ required: false
+ description: The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: SupportedIpAddressType
+ in: query
+ required: false
+ description: The supported IP address types. The possible values are ipv4 and ipv6.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to associate with the service.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: CreateVpcEndpointServiceConfiguration
+ operationId: POST_CreateVpcEndpointServiceConfiguration
+ description: 'Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, IAM users, and IAM roles) can connect.
Before you create an endpoint service, you must create one of the following for your service:
A Network Load Balancer. Service consumers connect to your service using an interface endpoint.
A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint.
If you set the private DNS name, you must prove that you own the private DNS domain name.
For more information, see the Amazon Web Services PrivateLink Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationRequest' + parameters: [] + /?Action=CreateVpcPeeringConnection&Version=2016-11-15: + get: + x-aws-operation-name: CreateVpcPeeringConnection + operationId: GET_CreateVpcPeeringConnection + description: 'Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide.
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PeerOwnerId
+ in: query
+ required: false
+ description: 'The Amazon Web Services account ID of the owner of the accepter VPC.
Default: Your Amazon Web Services account ID
' + schema: + type: string + - name: PeerVpcId + in: query + required: false + description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. + schema: + type: string + - name: VpcId + in: query + required: false + description: The ID of the requester VPC. You must specify this parameter in the request. + schema: + type: string + - name: PeerRegion + in: query + required: false + description: 'The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
' + schema: + type: string + - name: TagSpecification + in: query + required: false + description: The tags to assign to the peering connection. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + 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' + post: + x-aws-operation-name: CreateVpcPeeringConnection + operationId: POST_CreateVpcPeeringConnection + description: 'Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide.
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1.
The response includes information that you need to give to your network administrator to configure your customer gateway.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpnConnectionResult' + parameters: + - name: CustomerGatewayId + in: query + required: true + description: The ID of the customer gateway. + schema: + type: string + - name: Type + in: query + required: true + description: The type of VPN connection (ipsec.1).
+ schema:
+ type: string
+ - name: VpnGatewayId
+ in: query
+ required: false
+ description: 'The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.'
+ schema:
+ type: string
+ - name: TransitGatewayId
+ in: query
+ required: false
+ description: 'The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.'
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Options
+ in: query
+ required: false
+ description: The options for the VPN connection.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicate whether to enable acceleration for the VPN connection.
Default: false
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1.
The response includes information that you need to give to your network administrator to configure your customer gateway.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpnConnectionResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpnConnectionRequest' + parameters: [] + /?Action=CreateVpnConnectionRoute&Version=2016-11-15: + get: + x-aws-operation-name: CreateVpnConnectionRoute + operationId: GET_CreateVpnConnectionRoute + description: 'Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + parameters: + - name: DestinationCidrBlock + in: query + required: true + description: The CIDR block associated with the local subnet of the customer network. + schema: + type: string + - name: VpnConnectionId + in: query + required: true + description: The ID of the VPN connection. + schema: + type: string + 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' + post: + x-aws-operation-name: CreateVpnConnectionRoute + operationId: POST_CreateVpnConnectionRoute + description: 'Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpnConnectionRouteRequest' + parameters: [] + /?Action=CreateVpnGateway&Version=2016-11-15: + get: + x-aws-operation-name: CreateVpnGateway + operationId: GET_CreateVpnGateway + description: 'Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpnGatewayResult' + parameters: + - name: AvailabilityZone + in: query + required: false + description: The Availability Zone for the virtual private gateway. + schema: + type: string + - name: Type + in: query + required: true + description: The type of VPN connection this virtual private gateway supports. + schema: + type: string + enum: + - ipsec.1 + - name: TagSpecification + in: query + required: false + description: The tags to apply to the virtual private gateway. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: AmazonSideAsn + in: query + required: false + description: 'A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you''re using a 16-bit ASN, it must be in the 64512 to 65534 range. If you''re using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
Default: 64512
' + schema: + type: integer + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: CreateVpnGateway
+ operationId: POST_CreateVpnGateway
+ description: 'Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpnGatewayResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreateVpnGatewayRequest' + parameters: [] + /?Action=DeleteCarrierGateway&Version=2016-11-15: + get: + x-aws-operation-name: DeleteCarrierGateway + operationId: GET_DeleteCarrierGateway + description: 'Deletes a carrier gateway.
If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteCarrierGateway
+ operationId: POST_DeleteCarrierGateway
+ description: 'Deletes a carrier gateway.
If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteClientVpnEndpoint
+ operationId: POST_DeleteClientVpnEndpoint
+ description: Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteClientVpnEndpointResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteClientVpnEndpointRequest'
+ parameters: []
+ /?Action=DeleteClientVpnRoute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteClientVpnRoute
+ operationId: GET_DeleteClientVpnRoute
+ description: 'Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteClientVpnRouteResult'
+ parameters:
+ - name: ClientVpnEndpointId
+ in: query
+ required: true
+ description: The ID of the Client VPN endpoint from which the route is to be deleted.
+ schema:
+ type: string
+ - name: TargetVpcSubnetId
+ in: query
+ required: false
+ description: The ID of the target subnet used by the route.
+ schema:
+ type: string
+ - name: DestinationCidrBlock
+ in: query
+ required: true
+ description: 'The IPv4 address range, in CIDR notation, of the route to be deleted.'
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteClientVpnRoute
+ operationId: POST_DeleteClientVpnRoute
+ description: 'Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteClientVpnRouteResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteClientVpnRouteRequest'
+ parameters: []
+ /?Action=DeleteCustomerGateway&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteCustomerGateway
+ operationId: GET_DeleteCustomerGateway
+ description: Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: CustomerGatewayId
+ in: query
+ required: true
+ description: The ID of the customer gateway.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteCustomerGateway
+ operationId: POST_DeleteCustomerGateway
+ description: Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteCustomerGatewayRequest'
+ parameters: []
+ /?Action=DeleteDhcpOptions&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteDhcpOptions
+ operationId: GET_DeleteDhcpOptions
+ description: Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: DhcpOptionsId
+ in: query
+ required: true
+ description: The ID of the DHCP options set.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteDhcpOptions
+ operationId: POST_DeleteDhcpOptions
+ description: Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteDhcpOptionsRequest'
+ parameters: []
+ /?Action=DeleteEgressOnlyInternetGateway&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteEgressOnlyInternetGateway
+ operationId: GET_DeleteEgressOnlyInternetGateway
+ description: Deletes an egress-only internet gateway.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: EgressOnlyInternetGatewayId
+ in: query
+ required: true
+ description: The ID of the egress-only internet gateway.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteEgressOnlyInternetGateway
+ operationId: POST_DeleteEgressOnlyInternetGateway
+ description: Deletes an egress-only internet gateway.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayRequest'
+ parameters: []
+ /?Action=DeleteFleets&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteFleets
+ operationId: GET_DeleteFleets
+ description: 'Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteFleetsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: FleetId
+ in: query
+ required: true
+ description: The IDs of the EC2 Fleets.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/FleetId'
+ - name: TerminateInstances
+ in: query
+ required: true
+ description: 'Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to terminate the instances.
To let the instances continue to run after the EC2 Fleet is deleted, specify NoTerminateInstances. Supported only for fleets of type maintain and request.
For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.
Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteFleetsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteFleetsRequest' + parameters: [] + /?Action=DeleteFlowLogs&Version=2016-11-15: + get: + x-aws-operation-name: DeleteFlowLogs + operationId: GET_DeleteFlowLogs + description: Deletes one or more flow logs. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteFlowLogsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: FlowLogId
+ in: query
+ required: true
+ description: 'One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/VpcFlowLogId' + - xml: + name: item + 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' + post: + x-aws-operation-name: DeleteFlowLogs + operationId: POST_DeleteFlowLogs + description: Deletes one or more flow logs. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteFlowLogsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteFlowLogsRequest' + parameters: [] + /?Action=DeleteFpgaImage&Version=2016-11-15: + get: + x-aws-operation-name: DeleteFpgaImage + operationId: GET_DeleteFpgaImage + description: Deletes the specified Amazon FPGA Image (AFI). + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteFpgaImageResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: FpgaImageId
+ in: query
+ required: true
+ description: The ID of the AFI.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteFpgaImage
+ operationId: POST_DeleteFpgaImage
+ description: Deletes the specified Amazon FPGA Image (AFI).
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteFpgaImageResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteFpgaImageRequest'
+ parameters: []
+ /?Action=DeleteInstanceEventWindow&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteInstanceEventWindow
+ operationId: GET_DeleteInstanceEventWindow
+ description: 'Deletes the specified event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteInstanceEventWindowResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ForceDelete
+ in: query
+ required: false
+ description: Specify true to force delete the event window. Use the force delete parameter if the event window is currently associated with targets.
+ schema:
+ type: boolean
+ - name: InstanceEventWindowId
+ in: query
+ required: true
+ description: The ID of the event window.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteInstanceEventWindow
+ operationId: POST_DeleteInstanceEventWindow
+ description: 'Deletes the specified event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteInstanceEventWindowResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteInstanceEventWindowRequest' + parameters: [] + /?Action=DeleteInternetGateway&Version=2016-11-15: + get: + x-aws-operation-name: DeleteInternetGateway + operationId: GET_DeleteInternetGateway + description: Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it. + responses: + '200': + description: Success + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InternetGatewayId
+ in: query
+ required: true
+ description: The ID of the internet gateway.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteInternetGateway
+ operationId: POST_DeleteInternetGateway
+ description: Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteInternetGatewayRequest'
+ parameters: []
+ /?Action=DeleteIpam&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteIpam
+ operationId: GET_DeleteIpam
+ description: 'Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.
For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteIpamResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamId
+ in: query
+ required: true
+ description: The ID of the IPAM to delete.
+ schema:
+ type: string
+ - name: Cascade
+ in: query
+ required: false
+ description: 'Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:
Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.
No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.
Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.
Deletes all IPAM pools in private scopes.
Deletes all non-default private scopes in the IPAM.
Deletes the default public and private scopes and the IPAM.
Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.
For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteIpamResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteIpamRequest' + parameters: [] + /?Action=DeleteIpamPool&Version=2016-11-15: + get: + x-aws-operation-name: DeleteIpamPool + operationId: GET_DeleteIpamPool + description: 'Delete an IPAM pool.
You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr.
For more information, see Delete a pool in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteIpamPoolResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamPoolId
+ in: query
+ required: true
+ description: The ID of the pool to delete.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteIpamPool
+ operationId: POST_DeleteIpamPool
+ description: 'Delete an IPAM pool.
You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr.
For more information, see Delete a pool in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteIpamPoolResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteIpamPoolRequest' + parameters: [] + /?Action=DeleteIpamScope&Version=2016-11-15: + get: + x-aws-operation-name: DeleteIpamScope + operationId: GET_DeleteIpamScope + description: 'Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteIpamScopeResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamScopeId
+ in: query
+ required: true
+ description: The ID of the scope to delete.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteIpamScope
+ operationId: POST_DeleteIpamScope
+ description: 'Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteIpamScopeResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteIpamScopeRequest' + parameters: [] + /?Action=DeleteKeyPair&Version=2016-11-15: + get: + x-aws-operation-name: DeleteKeyPair + operationId: GET_DeleteKeyPair + description: 'Deletes the specified key pair, by removing the public key from Amazon EC2.' + responses: + '200': + description: Success + parameters: + - name: KeyName + in: query + required: false + description: The name of the key pair. + schema: + type: string + - name: KeyPairId + in: query + required: false + description: The ID of the key pair. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteKeyPair
+ operationId: POST_DeleteKeyPair
+ description: 'Deletes the specified key pair, by removing the public key from Amazon EC2.'
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteKeyPairRequest'
+ parameters: []
+ /?Action=DeleteLaunchTemplate&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteLaunchTemplate
+ operationId: GET_DeleteLaunchTemplate
+ description: Deletes a launch template. Deleting a launch template deletes all of its versions.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteLaunchTemplateResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: LaunchTemplateId
+ in: query
+ required: false
+ description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
+ schema:
+ type: string
+ - name: LaunchTemplateName
+ in: query
+ required: false
+ description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
+ schema:
+ type: string
+ pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
+ minLength: 3
+ maxLength: 128
+ 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'
+ post:
+ x-aws-operation-name: DeleteLaunchTemplate
+ operationId: POST_DeleteLaunchTemplate
+ description: Deletes a launch template. Deleting a launch template deletes all of its versions.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteLaunchTemplateResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteLaunchTemplateRequest'
+ parameters: []
+ /?Action=DeleteLaunchTemplateVersions&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteLaunchTemplateVersions
+ operationId: GET_DeleteLaunchTemplateVersions
+ description: 'Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: LaunchTemplateId
+ in: query
+ required: false
+ description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
+ schema:
+ type: string
+ - name: LaunchTemplateName
+ in: query
+ required: false
+ description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
+ schema:
+ type: string
+ pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
+ minLength: 3
+ maxLength: 128
+ - name: LaunchTemplateVersion
+ in: query
+ required: true
+ description: The version numbers of one or more launch template versions to delete.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: DeleteLaunchTemplateVersions
+ operationId: POST_DeleteLaunchTemplateVersions
+ description: 'Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteLaunchTemplateVersionsRequest'
+ parameters: []
+ /?Action=DeleteLocalGatewayRoute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteLocalGatewayRoute
+ operationId: GET_DeleteLocalGatewayRoute
+ description: Deletes the specified route from the specified local gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteLocalGatewayRouteResult'
+ parameters:
+ - name: DestinationCidrBlock
+ in: query
+ required: true
+ description: The CIDR range for the route. This must match the CIDR for the route exactly.
+ schema:
+ type: string
+ - name: LocalGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the local gateway route table.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteLocalGatewayRoute
+ operationId: POST_DeleteLocalGatewayRoute
+ description: Deletes the specified route from the specified local gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteLocalGatewayRouteResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteLocalGatewayRouteRequest'
+ parameters: []
+ /?Action=DeleteLocalGatewayRouteTableVpcAssociation&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteLocalGatewayRouteTableVpcAssociation
+ operationId: GET_DeleteLocalGatewayRouteTableVpcAssociation
+ description: Deletes the specified association between a VPC and local gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteLocalGatewayRouteTableVpcAssociationResult'
+ parameters:
+ - name: LocalGatewayRouteTableVpcAssociationId
+ in: query
+ required: true
+ description: The ID of the association.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteLocalGatewayRouteTableVpcAssociation
+ operationId: POST_DeleteLocalGatewayRouteTableVpcAssociation
+ description: Deletes the specified association between a VPC and local gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteLocalGatewayRouteTableVpcAssociationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteLocalGatewayRouteTableVpcAssociationRequest'
+ parameters: []
+ /?Action=DeleteManagedPrefixList&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteManagedPrefixList
+ operationId: GET_DeleteManagedPrefixList
+ description: Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteManagedPrefixListResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PrefixListId
+ in: query
+ required: true
+ description: The ID of the prefix list.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteManagedPrefixList
+ operationId: POST_DeleteManagedPrefixList
+ description: Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteManagedPrefixListResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteManagedPrefixListRequest'
+ parameters: []
+ /?Action=DeleteNatGateway&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteNatGateway
+ operationId: GET_DeleteNatGateway
+ description: 'Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNatGatewayResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NatGatewayId
+ in: query
+ required: true
+ description: The ID of the NAT gateway.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteNatGateway
+ operationId: POST_DeleteNatGateway
+ description: 'Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNatGatewayResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNatGatewayRequest'
+ parameters: []
+ /?Action=DeleteNetworkAcl&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteNetworkAcl
+ operationId: GET_DeleteNetworkAcl
+ description: Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NetworkAclId
+ in: query
+ required: true
+ description: The ID of the network ACL.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteNetworkAcl
+ operationId: POST_DeleteNetworkAcl
+ description: Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkAclRequest'
+ parameters: []
+ /?Action=DeleteNetworkAclEntry&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteNetworkAclEntry
+ operationId: GET_DeleteNetworkAclEntry
+ description: Deletes the specified ingress or egress entry (rule) from the specified network ACL.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Egress
+ in: query
+ required: true
+ description: Indicates whether the rule is an egress rule.
+ schema:
+ type: boolean
+ - name: NetworkAclId
+ in: query
+ required: true
+ description: The ID of the network ACL.
+ schema:
+ type: string
+ - name: RuleNumber
+ in: query
+ required: true
+ description: The rule number of the entry to delete.
+ schema:
+ type: integer
+ 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'
+ post:
+ x-aws-operation-name: DeleteNetworkAclEntry
+ operationId: POST_DeleteNetworkAclEntry
+ description: Deletes the specified ingress or egress entry (rule) from the specified network ACL.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkAclEntryRequest'
+ parameters: []
+ /?Action=DeleteNetworkInsightsAccessScope&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteNetworkInsightsAccessScope
+ operationId: GET_DeleteNetworkInsightsAccessScope
+ description: Deletes the specified Network Access Scope.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NetworkInsightsAccessScopeId
+ in: query
+ required: true
+ description: The ID of the Network Access Scope.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteNetworkInsightsAccessScope
+ operationId: POST_DeleteNetworkInsightsAccessScope
+ description: Deletes the specified Network Access Scope.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeRequest'
+ parameters: []
+ /?Action=DeleteNetworkInsightsAccessScopeAnalysis&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteNetworkInsightsAccessScopeAnalysis
+ operationId: GET_DeleteNetworkInsightsAccessScopeAnalysis
+ description: Deletes the specified Network Access Scope analysis.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeAnalysisResult'
+ parameters:
+ - name: NetworkInsightsAccessScopeAnalysisId
+ in: query
+ required: true
+ description: The ID of the Network Access Scope analysis.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteNetworkInsightsAccessScopeAnalysis
+ operationId: POST_DeleteNetworkInsightsAccessScopeAnalysis
+ description: Deletes the specified Network Access Scope analysis.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeAnalysisResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeAnalysisRequest'
+ parameters: []
+ /?Action=DeleteNetworkInsightsAnalysis&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteNetworkInsightsAnalysis
+ operationId: GET_DeleteNetworkInsightsAnalysis
+ description: Deletes the specified network insights analysis.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInsightsAnalysisResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NetworkInsightsAnalysisId
+ in: query
+ required: true
+ description: The ID of the network insights analysis.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteNetworkInsightsAnalysis
+ operationId: POST_DeleteNetworkInsightsAnalysis
+ description: Deletes the specified network insights analysis.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInsightsAnalysisResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInsightsAnalysisRequest'
+ parameters: []
+ /?Action=DeleteNetworkInsightsPath&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteNetworkInsightsPath
+ operationId: GET_DeleteNetworkInsightsPath
+ description: Deletes the specified path.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInsightsPathResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NetworkInsightsPathId
+ in: query
+ required: true
+ description: The ID of the path.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteNetworkInsightsPath
+ operationId: POST_DeleteNetworkInsightsPath
+ description: Deletes the specified path.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInsightsPathResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInsightsPathRequest'
+ parameters: []
+ /?Action=DeleteNetworkInterface&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteNetworkInterface
+ operationId: GET_DeleteNetworkInterface
+ description: Deletes the specified network interface. You must detach the network interface before you can delete it.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NetworkInterfaceId
+ in: query
+ required: true
+ description: The ID of the network interface.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteNetworkInterface
+ operationId: POST_DeleteNetworkInterface
+ description: Deletes the specified network interface. You must detach the network interface before you can delete it.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInterfaceRequest'
+ parameters: []
+ /?Action=DeleteNetworkInterfacePermission&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteNetworkInterfacePermission
+ operationId: GET_DeleteNetworkInterfacePermission
+ description: 'Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you''re removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInterfacePermissionResult'
+ parameters:
+ - name: NetworkInterfacePermissionId
+ in: query
+ required: true
+ description: The ID of the network interface permission.
+ schema:
+ type: string
+ - name: Force
+ in: query
+ required: false
+ description: Specify true to remove the permission even if the network interface is attached to an instance.
+ schema:
+ type: boolean
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteNetworkInterfacePermission
+ operationId: POST_DeleteNetworkInterfacePermission
+ description: 'Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you''re removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInterfacePermissionResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteNetworkInterfacePermissionRequest'
+ parameters: []
+ /?Action=DeletePlacementGroup&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeletePlacementGroup
+ operationId: GET_DeletePlacementGroup
+ description: 'Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide.'
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: GroupName
+ in: query
+ required: true
+ description: The name of the placement group.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeletePlacementGroup
+ operationId: POST_DeletePlacementGroup
+ description: 'Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide.'
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeletePlacementGroupRequest'
+ parameters: []
+ /?Action=DeletePublicIpv4Pool&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeletePublicIpv4Pool
+ operationId: GET_DeletePublicIpv4Pool
+ description: 'Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeletePublicIpv4PoolResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PoolId
+ in: query
+ required: true
+ description: The ID of the public IPv4 pool you want to delete.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeletePublicIpv4Pool
+ operationId: POST_DeletePublicIpv4Pool
+ description: 'Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeletePublicIpv4PoolResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeletePublicIpv4PoolRequest'
+ parameters: []
+ /?Action=DeleteQueuedReservedInstances&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteQueuedReservedInstances
+ operationId: GET_DeleteQueuedReservedInstances
+ description: Deletes the queued purchases for the specified Reserved Instances.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteQueuedReservedInstancesResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ReservedInstancesId
+ in: query
+ required: true
+ description: The IDs of the Reserved Instances.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservationId'
+ - xml:
+ name: item
+ minItems: 1
+ maxItems: 100
+ 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'
+ post:
+ x-aws-operation-name: DeleteQueuedReservedInstances
+ operationId: POST_DeleteQueuedReservedInstances
+ description: Deletes the queued purchases for the specified Reserved Instances.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteQueuedReservedInstancesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteQueuedReservedInstancesRequest'
+ parameters: []
+ /?Action=DeleteRoute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteRoute
+ operationId: GET_DeleteRoute
+ description: Deletes the specified route from the specified route table.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: DestinationCidrBlock
+ in: query
+ required: false
+ description: The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
+ schema:
+ type: string
+ - name: DestinationIpv6CidrBlock
+ in: query
+ required: false
+ description: The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
+ schema:
+ type: string
+ - name: DestinationPrefixListId
+ in: query
+ required: false
+ description: The ID of the prefix list for the route.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: RouteTableId
+ in: query
+ required: true
+ description: The ID of the route table.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteRoute
+ operationId: POST_DeleteRoute
+ description: Deletes the specified route from the specified route table.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteRouteRequest'
+ parameters: []
+ /?Action=DeleteRouteTable&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteRouteTable
+ operationId: GET_DeleteRouteTable
+ description: Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: RouteTableId
+ in: query
+ required: true
+ description: The ID of the route table.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteRouteTable
+ operationId: POST_DeleteRouteTable
+ description: Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteRouteTableRequest'
+ parameters: []
+ /?Action=DeleteSecurityGroup&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteSecurityGroup
+ operationId: GET_DeleteSecurityGroup
+ description: 'Deletes a security group.
If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteSecurityGroup
+ operationId: POST_DeleteSecurityGroup
+ description: 'Deletes a security group.
If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.
Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Delete an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + parameters: + - name: SnapshotId + in: query + required: true + description: The ID of the EBS snapshot. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteSnapshot
+ operationId: POST_DeleteSnapshot
+ description: 'Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Delete an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteSnapshotRequest' + parameters: [] + /?Action=DeleteSpotDatafeedSubscription&Version=2016-11-15: + get: + x-aws-operation-name: DeleteSpotDatafeedSubscription + operationId: GET_DeleteSpotDatafeedSubscription + description: Deletes the data feed for Spot Instances. + responses: + '200': + description: Success + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteSpotDatafeedSubscription
+ operationId: POST_DeleteSpotDatafeedSubscription
+ description: Deletes the data feed for Spot Instances.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteSpotDatafeedSubscriptionRequest'
+ parameters: []
+ /?Action=DeleteSubnet&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteSubnet
+ operationId: GET_DeleteSubnet
+ description: Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: SubnetId
+ in: query
+ required: true
+ description: The ID of the subnet.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteSubnet
+ operationId: POST_DeleteSubnet
+ description: Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteSubnetRequest'
+ parameters: []
+ /?Action=DeleteSubnetCidrReservation&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteSubnetCidrReservation
+ operationId: GET_DeleteSubnetCidrReservation
+ description: Deletes a subnet CIDR reservation.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteSubnetCidrReservationResult'
+ parameters:
+ - name: SubnetCidrReservationId
+ in: query
+ required: true
+ description: The ID of the subnet CIDR reservation.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteSubnetCidrReservation
+ operationId: POST_DeleteSubnetCidrReservation
+ description: Deletes a subnet CIDR reservation.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteSubnetCidrReservationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteSubnetCidrReservationRequest'
+ parameters: []
+ /?Action=DeleteTags&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteTags
+ operationId: GET_DeleteTags
+ description: 'Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ResourceId
+ in: query
+ required: true
+ description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' + schema: + type: array + items: + $ref: '#/components/schemas/TaggableResourceId' + - name: Tag + in: query + required: false + description: 'The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.
If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).
Constraints: Up to 1000 tags.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/Tag' + - xml: + name: item + 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' + post: + x-aws-operation-name: DeleteTags + operationId: POST_DeleteTags + description: 'Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteTagsRequest' + parameters: [] + /?Action=DeleteTrafficMirrorFilter&Version=2016-11-15: + get: + x-aws-operation-name: DeleteTrafficMirrorFilter + operationId: GET_DeleteTrafficMirrorFilter + description:Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteTrafficMirrorFilterResult' + parameters: + - name: TrafficMirrorFilterId + in: query + required: true + description: The ID of the Traffic Mirror filter. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTrafficMirrorFilter
+ operationId: POST_DeleteTrafficMirrorFilter
+ description: Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteTrafficMirrorFilterResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteTrafficMirrorFilterRequest' + parameters: [] + /?Action=DeleteTrafficMirrorFilterRule&Version=2016-11-15: + get: + x-aws-operation-name: DeleteTrafficMirrorFilterRule + operationId: GET_DeleteTrafficMirrorFilterRule + description: Deletes the specified Traffic Mirror rule. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleResult' + parameters: + - name: TrafficMirrorFilterRuleId + in: query + required: true + description: The ID of the Traffic Mirror rule. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTrafficMirrorFilterRule
+ operationId: POST_DeleteTrafficMirrorFilterRule
+ description: Deletes the specified Traffic Mirror rule.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleRequest'
+ parameters: []
+ /?Action=DeleteTrafficMirrorSession&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteTrafficMirrorSession
+ operationId: GET_DeleteTrafficMirrorSession
+ description: Deletes the specified Traffic Mirror session.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTrafficMirrorSessionResult'
+ parameters:
+ - name: TrafficMirrorSessionId
+ in: query
+ required: true
+ description: The ID of the Traffic Mirror session.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTrafficMirrorSession
+ operationId: POST_DeleteTrafficMirrorSession
+ description: Deletes the specified Traffic Mirror session.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTrafficMirrorSessionResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTrafficMirrorSessionRequest'
+ parameters: []
+ /?Action=DeleteTrafficMirrorTarget&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteTrafficMirrorTarget
+ operationId: GET_DeleteTrafficMirrorTarget
+ description: Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteTrafficMirrorTargetResult' + parameters: + - name: TrafficMirrorTargetId + in: query + required: true + description: The ID of the Traffic Mirror target. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTrafficMirrorTarget
+ operationId: POST_DeleteTrafficMirrorTarget
+ description: Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteTrafficMirrorTargetResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteTrafficMirrorTargetRequest' + parameters: [] + /?Action=DeleteTransitGateway&Version=2016-11-15: + get: + x-aws-operation-name: DeleteTransitGateway + operationId: GET_DeleteTransitGateway + description: Deletes the specified transit gateway. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteTransitGatewayResult' + parameters: + - name: TransitGatewayId + in: query + required: true + description: The ID of the transit gateway. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTransitGateway
+ operationId: POST_DeleteTransitGateway
+ description: Deletes the specified transit gateway.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayRequest'
+ parameters: []
+ /?Action=DeleteTransitGatewayConnect&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteTransitGatewayConnect
+ operationId: GET_DeleteTransitGatewayConnect
+ description: Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayConnectResult'
+ parameters:
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: true
+ description: The ID of the Connect attachment.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTransitGatewayConnect
+ operationId: POST_DeleteTransitGatewayConnect
+ description: Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayConnectResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayConnectRequest'
+ parameters: []
+ /?Action=DeleteTransitGatewayConnectPeer&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteTransitGatewayConnectPeer
+ operationId: GET_DeleteTransitGatewayConnectPeer
+ description: Deletes the specified Connect peer.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayConnectPeerResult'
+ parameters:
+ - name: TransitGatewayConnectPeerId
+ in: query
+ required: true
+ description: The ID of the Connect peer.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTransitGatewayConnectPeer
+ operationId: POST_DeleteTransitGatewayConnectPeer
+ description: Deletes the specified Connect peer.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayConnectPeerResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayConnectPeerRequest'
+ parameters: []
+ /?Action=DeleteTransitGatewayMulticastDomain&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteTransitGatewayMulticastDomain
+ operationId: GET_DeleteTransitGatewayMulticastDomain
+ description: Deletes the specified transit gateway multicast domain.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainResult'
+ parameters:
+ - name: TransitGatewayMulticastDomainId
+ in: query
+ required: true
+ description: The ID of the transit gateway multicast domain.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTransitGatewayMulticastDomain
+ operationId: POST_DeleteTransitGatewayMulticastDomain
+ description: Deletes the specified transit gateway multicast domain.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainRequest'
+ parameters: []
+ /?Action=DeleteTransitGatewayPeeringAttachment&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteTransitGatewayPeeringAttachment
+ operationId: GET_DeleteTransitGatewayPeeringAttachment
+ description: Deletes a transit gateway peering attachment.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentResult'
+ parameters:
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: true
+ description: The ID of the transit gateway peering attachment.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTransitGatewayPeeringAttachment
+ operationId: POST_DeleteTransitGatewayPeeringAttachment
+ description: Deletes a transit gateway peering attachment.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentRequest'
+ parameters: []
+ /?Action=DeleteTransitGatewayPrefixListReference&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteTransitGatewayPrefixListReference
+ operationId: GET_DeleteTransitGatewayPrefixListReference
+ description: Deletes a reference (route) to a prefix list in a specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceResult'
+ parameters:
+ - name: TransitGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the route table.
+ schema:
+ type: string
+ - name: PrefixListId
+ in: query
+ required: true
+ description: The ID of the prefix list.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTransitGatewayPrefixListReference
+ operationId: POST_DeleteTransitGatewayPrefixListReference
+ description: Deletes a reference (route) to a prefix list in a specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceRequest'
+ parameters: []
+ /?Action=DeleteTransitGatewayRoute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteTransitGatewayRoute
+ operationId: GET_DeleteTransitGatewayRoute
+ description: Deletes the specified route from the specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayRouteResult'
+ parameters:
+ - name: TransitGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the transit gateway route table.
+ schema:
+ type: string
+ - name: DestinationCidrBlock
+ in: query
+ required: true
+ description: The CIDR range for the route. This must match the CIDR for the route exactly.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTransitGatewayRoute
+ operationId: POST_DeleteTransitGatewayRoute
+ description: Deletes the specified route from the specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayRouteResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayRouteRequest'
+ parameters: []
+ /?Action=DeleteTransitGatewayRouteTable&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteTransitGatewayRouteTable
+ operationId: GET_DeleteTransitGatewayRouteTable
+ description: Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayRouteTableResult'
+ parameters:
+ - name: TransitGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the transit gateway route table.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTransitGatewayRouteTable
+ operationId: POST_DeleteTransitGatewayRouteTable
+ description: Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayRouteTableResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayRouteTableRequest'
+ parameters: []
+ /?Action=DeleteTransitGatewayVpcAttachment&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteTransitGatewayVpcAttachment
+ operationId: GET_DeleteTransitGatewayVpcAttachment
+ description: Deletes the specified VPC attachment.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentResult'
+ parameters:
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: true
+ description: The ID of the attachment.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteTransitGatewayVpcAttachment
+ operationId: POST_DeleteTransitGatewayVpcAttachment
+ description: Deletes the specified VPC attachment.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentRequest'
+ parameters: []
+ /?Action=DeleteVolume&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteVolume
+ operationId: GET_DeleteVolume
+ description: 'Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).
The volume can remain in the deleting state for several minutes.
For more information, see Delete an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + parameters: + - name: VolumeId + in: query + required: true + description: The ID of the volume. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteVolume
+ operationId: POST_DeleteVolume
+ description: 'Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).
The volume can remain in the deleting state for several minutes.
For more information, see Delete an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteVolumeRequest' + parameters: [] + /?Action=DeleteVpc&Version=2016-11-15: + get: + x-aws-operation-name: DeleteVpc + operationId: GET_DeleteVpc + description: 'Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.' + responses: + '200': + description: Success + parameters: + - name: VpcId + in: query + required: true + description: The ID of the VPC. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteVpc
+ operationId: POST_DeleteVpc
+ description: 'Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.'
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteVpcRequest'
+ parameters: []
+ /?Action=DeleteVpcEndpointConnectionNotifications&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteVpcEndpointConnectionNotifications
+ operationId: GET_DeleteVpcEndpointConnectionNotifications
+ description: Deletes one or more VPC endpoint connection notifications.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ConnectionNotificationId
+ in: query
+ required: true
+ description: One or more notification IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ConnectionNotificationId'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: DeleteVpcEndpointConnectionNotifications
+ operationId: POST_DeleteVpcEndpointConnectionNotifications
+ description: Deletes one or more VPC endpoint connection notifications.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsRequest'
+ parameters: []
+ /?Action=DeleteVpcEndpointServiceConfigurations&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteVpcEndpointServiceConfigurations
+ operationId: GET_DeleteVpcEndpointServiceConfigurations
+ description: 'Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ServiceId
+ in: query
+ required: true
+ description: The IDs of one or more services.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointServiceId'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: DeleteVpcEndpointServiceConfigurations
+ operationId: POST_DeleteVpcEndpointServiceConfigurations
+ description: 'Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsRequest'
+ parameters: []
+ /?Action=DeleteVpcEndpoints&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteVpcEndpoints
+ operationId: GET_DeleteVpcEndpoints
+ description: 'Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.
Gateway endpoint,
Gateway Load Balancer endpoint,
Interface endpoint
The following rules apply when you delete a VPC endpoint:
When you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint.
When you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces.
You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.
When you delete an interface endpoint, we delete the endpoint network interfaces.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcEndpointId
+ in: query
+ required: true
+ description: One or more VPC endpoint IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointId'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: DeleteVpcEndpoints
+ operationId: POST_DeleteVpcEndpoints
+ description: 'Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.
Gateway endpoint,
Gateway Load Balancer endpoint,
Interface endpoint
The following rules apply when you delete a VPC endpoint:
When you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint.
When you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces.
You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.
When you delete an interface endpoint, we delete the endpoint network interfaces.
active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteVpcPeeringConnectionResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcPeeringConnectionId
+ in: query
+ required: true
+ description: The ID of the VPC peering connection.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeleteVpcPeeringConnection
+ operationId: POST_DeleteVpcPeeringConnection
+ description: Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteVpcPeeringConnectionResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteVpcPeeringConnectionRequest'
+ parameters: []
+ /?Action=DeleteVpnConnection&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeleteVpnConnection
+ operationId: GET_DeleteVpnConnection
+ description: 'Deletes the specified VPN connection.
If you''re deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.
For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection.
' + responses: + '200': + description: Success + parameters: + - name: VpnConnectionId + in: query + required: true + description: The ID of the VPN connection. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteVpnConnection
+ operationId: POST_DeleteVpnConnection
+ description: 'Deletes the specified VPN connection.
If you''re deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.
For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteVpnConnectionRequest' + parameters: [] + /?Action=DeleteVpnConnectionRoute&Version=2016-11-15: + get: + x-aws-operation-name: DeleteVpnConnectionRoute + operationId: GET_DeleteVpnConnectionRoute + description: Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. + responses: + '200': + description: Success + parameters: + - name: DestinationCidrBlock + in: query + required: true + description: The CIDR block associated with the local subnet of the customer network. + schema: + type: string + - name: VpnConnectionId + in: query + required: true + description: The ID of the VPN connection. + schema: + type: string + 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' + post: + x-aws-operation-name: DeleteVpnConnectionRoute + operationId: POST_DeleteVpnConnectionRoute + description: Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteVpnConnectionRouteRequest' + parameters: [] + /?Action=DeleteVpnGateway&Version=2016-11-15: + get: + x-aws-operation-name: DeleteVpnGateway + operationId: GET_DeleteVpnGateway + description: Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. + responses: + '200': + description: Success + parameters: + - name: VpnGatewayId + in: query + required: true + description: The ID of the virtual private gateway. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeleteVpnGateway
+ operationId: POST_DeleteVpnGateway
+ description: Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeleteVpnGatewayRequest'
+ parameters: []
+ /?Action=DeprovisionByoipCidr&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeprovisionByoipCidr
+ operationId: GET_DeprovisionByoipCidr
+ description: 'Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeprovisionByoipCidrResult' + parameters: + - name: Cidr + in: query + required: true + description: 'The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeprovisionByoipCidr
+ operationId: POST_DeprovisionByoipCidr
+ description: 'Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeprovisionByoipCidrResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeprovisionByoipCidrRequest' + parameters: [] + /?Action=DeprovisionIpamPoolCidr&Version=2016-11-15: + get: + x-aws-operation-name: DeprovisionIpamPoolCidr + operationId: GET_DeprovisionIpamPoolCidr + description: 'Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeprovisionIpamPoolCidrResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamPoolId
+ in: query
+ required: true
+ description: The ID of the pool that has the CIDR you want to deprovision.
+ schema:
+ type: string
+ - name: Cidr
+ in: query
+ required: false
+ description: The CIDR which you want to deprovision from the pool.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeprovisionIpamPoolCidr
+ operationId: POST_DeprovisionIpamPoolCidr
+ description: 'Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeprovisionIpamPoolCidrResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeprovisionIpamPoolCidrRequest'
+ parameters: []
+ /?Action=DeprovisionPublicIpv4PoolCidr&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeprovisionPublicIpv4PoolCidr
+ operationId: GET_DeprovisionPublicIpv4PoolCidr
+ description: Deprovision a CIDR from a public IPv4 pool.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeprovisionPublicIpv4PoolCidrResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PoolId
+ in: query
+ required: true
+ description: The ID of the pool that you want to deprovision the CIDR from.
+ schema:
+ type: string
+ - name: Cidr
+ in: query
+ required: true
+ description: The CIDR you want to deprovision from the pool.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DeprovisionPublicIpv4PoolCidr
+ operationId: POST_DeprovisionPublicIpv4PoolCidr
+ description: Deprovision a CIDR from a public IPv4 pool.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeprovisionPublicIpv4PoolCidrResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeprovisionPublicIpv4PoolCidrRequest'
+ parameters: []
+ /?Action=DeregisterImage&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeregisterImage
+ operationId: GET_DeregisterImage
+ description: 'Deregisters the specified AMI. After you deregister an AMI, it can''t be used to launch new instances.
If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
When you deregister an AMI, it doesn''t affect any instances that you''ve already launched from the AMI. You''ll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn''t affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn''t affect the files that you uploaded to Amazon S3 when you created the AMI.
' + responses: + '200': + description: Success + parameters: + - name: ImageId + in: query + required: true + description: The ID of the AMI. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeregisterImage
+ operationId: POST_DeregisterImage
+ description: 'Deregisters the specified AMI. After you deregister an AMI, it can''t be used to launch new instances.
If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
When you deregister an AMI, it doesn''t affect any instances that you''ve already launched from the AMI. You''ll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn''t affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn''t affect the files that you uploaded to Amazon S3 when you created the AMI.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeregisterImageRequest' + parameters: [] + /?Action=DeregisterInstanceEventNotificationAttributes&Version=2016-11-15: + get: + x-aws-operation-name: DeregisterInstanceEventNotificationAttributes + operationId: GET_DeregisterInstanceEventNotificationAttributes + description: Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DeregisterInstanceEventNotificationAttributesResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceTagAttribute
+ in: query
+ required: false
+ description: Information about the tag keys to deregister.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to deregister all tag keys in the current Region. Specify false to deregister all tag keys.
+ InstanceTagKey:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTagKeySet'
+ - description: Information about the tag keys to deregister.
+ description: Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
+ 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'
+ post:
+ x-aws-operation-name: DeregisterInstanceEventNotificationAttributes
+ operationId: POST_DeregisterInstanceEventNotificationAttributes
+ description: Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeregisterInstanceEventNotificationAttributesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeregisterInstanceEventNotificationAttributesRequest'
+ parameters: []
+ /?Action=DeregisterTransitGatewayMulticastGroupMembers&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeregisterTransitGatewayMulticastGroupMembers
+ operationId: GET_DeregisterTransitGatewayMulticastGroupMembers
+ description: Deregisters the specified members (network interfaces) from the transit gateway multicast group.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupMembersResult'
+ parameters:
+ - name: TransitGatewayMulticastDomainId
+ in: query
+ required: false
+ description: The ID of the transit gateway multicast domain.
+ schema:
+ type: string
+ - name: GroupIpAddress
+ in: query
+ required: false
+ description: The IP address assigned to the transit gateway multicast group.
+ schema:
+ type: string
+ - name: NetworkInterfaceIds
+ in: query
+ required: false
+ description: The IDs of the group members' network interfaces.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - xml:
+ name: item
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeregisterTransitGatewayMulticastGroupMembers
+ operationId: POST_DeregisterTransitGatewayMulticastGroupMembers
+ description: Deregisters the specified members (network interfaces) from the transit gateway multicast group.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupMembersResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupMembersRequest'
+ parameters: []
+ /?Action=DeregisterTransitGatewayMulticastGroupSources&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DeregisterTransitGatewayMulticastGroupSources
+ operationId: GET_DeregisterTransitGatewayMulticastGroupSources
+ description: Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupSourcesResult'
+ parameters:
+ - name: TransitGatewayMulticastDomainId
+ in: query
+ required: false
+ description: The ID of the transit gateway multicast domain.
+ schema:
+ type: string
+ - name: GroupIpAddress
+ in: query
+ required: false
+ description: The IP address assigned to the transit gateway multicast group.
+ schema:
+ type: string
+ - name: NetworkInterfaceIds
+ in: query
+ required: false
+ description: The IDs of the group sources' network interfaces.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - xml:
+ name: item
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DeregisterTransitGatewayMulticastGroupSources
+ operationId: POST_DeregisterTransitGatewayMulticastGroupSources
+ description: Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupSourcesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupSourcesRequest'
+ parameters: []
+ /?Action=DescribeAccountAttributes&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeAccountAttributes
+ operationId: GET_DescribeAccountAttributes
+ description: 'Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.
default-vpc: The ID of the default VPC for your account, or none.
max-instances: This attribute is no longer supported. The returned value does not reflect your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide.
vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.
max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.
vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeAccountAttributes
+ operationId: POST_DescribeAccountAttributes
+ description: 'Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.
default-vpc: The ID of the default VPC for your account, or none.
max-instances: This attribute is no longer supported. The returned value does not reflect your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide.
vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.
max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.
vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.
Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeAddressesResult' + parameters: + - name: Filter + in: query + required: false + description: 'One or more filters. Filter names and values are case-sensitive.
allocation-id - [EC2-VPC] The allocation ID for the address.
association-id - [EC2-VPC] The association ID for the address.
domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).
instance-id - The ID of the instance the address is associated with, if any.
network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The Amazon Web Services account ID of the owner.
private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: PublicIp + - name: AllocationId + in: query + required: false + description: '[EC2-VPC] Information about the allocation IDs.' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/AllocationId' + - xml: + name: AllocationId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeAddresses
+ operationId: POST_DescribeAddresses
+ description: 'Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeAddressesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeAddressesRequest' + parameters: [] + /?Action=DescribeAddressesAttribute&Version=2016-11-15: + get: + x-aws-operation-name: DescribeAddressesAttribute + operationId: GET_DescribeAddressesAttribute + description: 'Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeAddressesAttributeResult' + parameters: + - name: AllocationId + in: query + required: false + description: '[EC2-VPC] The allocation IDs.' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/AllocationId' + - xml: + name: item + - name: Attribute + in: query + required: false + description: The attribute of the IP address. + schema: + type: string + enum: + - domain-name + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + type: string + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeAddressesAttribute
+ operationId: POST_DescribeAddressesAttribute
+ description: 'Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeAddressesAttributeResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeAddressesAttributeRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeAggregateIdFormat&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeAggregateIdFormat
+ operationId: GET_DescribeAggregateIdFormat
+ description: 'Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeAggregateIdFormat
+ operationId: POST_DescribeAggregateIdFormat
+ description: 'Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.
For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeAvailabilityZonesResult' + parameters: + - name: Filter + in: query + required: false + description: 'The filters.
group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
message - The Zone message.
opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required).
parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name - The name of the Region for the Zone (for example, us-east-1).
state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available).
zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
' + schema: + type: boolean + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeAvailabilityZones
+ operationId: POST_DescribeAvailabilityZones
+ description: 'Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.
For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeAvailabilityZonesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeAvailabilityZonesRequest' + parameters: [] + /?Action=DescribeBundleTasks&Version=2016-11-15: + get: + x-aws-operation-name: DescribeBundleTasks + operationId: GET_DescribeBundleTasks + description: 'Describes the specified bundle tasks or all of your bundle tasks.
Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.
The bundle task IDs.
Default: Describes all your bundle tasks.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/BundleId' + - xml: + name: BundleId + - name: Filter + in: query + required: false + description: 'The filters.
bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeBundleTasks
+ operationId: POST_DescribeBundleTasks
+ description: 'Describes the specified bundle tasks or all of your bundle tasks.
Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.
Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.
To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeByoipCidrsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: MaxResults
+ in: query
+ required: true
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 100
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeByoipCidrs
+ operationId: POST_DescribeByoipCidrs
+ description: 'Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.
To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeByoipCidrsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeByoipCidrsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeCapacityReservationFleets&Version=2016-11-15: + get: + x-aws-operation-name: DescribeCapacityReservationFleets + operationId: GET_DescribeCapacityReservationFleets + description: Describes one or more Capacity Reservation Fleets. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeCapacityReservationFleetsResult' + parameters: + - name: CapacityReservationFleetId + in: query + required: false + description: The IDs of the Capacity Reservation Fleets to describe. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/CapacityReservationFleetId' + - xml: + name: item + - name: NextToken + in: query + required: false + description: The token to use to retrieve the next page of results. + schema: + type: string + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returnednextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 100
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).
instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
tenancy - The tenancy of the Fleet (default | dedicated).
allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeCapacityReservationFleets
+ operationId: POST_DescribeCapacityReservationFleets
+ description: Describes one or more Capacity Reservation Fleets.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeCapacityReservationFleetsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeCapacityReservationFleetsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeCapacityReservations&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeCapacityReservations
+ operationId: GET_DescribeCapacityReservations
+ description: Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeCapacityReservationsResult'
+ parameters:
+ - name: CapacityReservationId
+ in: query
+ required: false
+ description: The ID of the Capacity Reservation.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationId'
+ - xml:
+ name: item
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to use to retrieve the next page of results.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
instance-type - The type of instance for which the Capacity Reservation reserves capacity.
owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
availability-zone - The Availability Zone of the Capacity Reservation.
tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active- The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
start-date - The date and time at which the Capacity Reservation was started.
end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.
end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeCapacityReservations
+ operationId: POST_DescribeCapacityReservations
+ description: Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeCapacityReservationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeCapacityReservationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeCarrierGateways&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeCarrierGateways
+ operationId: GET_DescribeCarrierGateways
+ description: Describes one or more of your carrier gateways.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeCarrierGatewaysResult'
+ parameters:
+ - name: CarrierGatewayId
+ in: query
+ required: false
+ description: One or more carrier gateway IDs.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/CarrierGatewayId'
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
carrier-gateway-id - The ID of the carrier gateway.
state - The state of the carrier gateway (pending | failed | available | deleting | deleted).
owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC associated with the carrier gateway.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeCarrierGateways
+ operationId: POST_DescribeCarrierGateways
+ description: Describes one or more of your carrier gateways.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeCarrierGatewaysResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeCarrierGatewaysRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeClassicLinkInstances&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeClassicLinkInstances
+ operationId: GET_DescribeClassicLinkInstances
+ description: Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeClassicLinkInstancesResult'
+ parameters:
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
group-id - The ID of a VPC security group that''s associated with the instance.
instance-id - The ID of the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
vpc-id - The ID of the VPC that the instance is linked to.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceId
+ in: query
+ required: false
+ description: One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - xml:
+ name: InstanceId
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Constraint: If the value is greater than 1000, we return only 1000 items.
' + schema: + type: integer + minimum: 5 + maximum: 1000 + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + type: string + 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' + post: + x-aws-operation-name: DescribeClassicLinkInstances + operationId: POST_DescribeClassicLinkInstances + description: Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeClassicLinkInstancesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeClassicLinkInstancesRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeClientVpnAuthorizationRules&Version=2016-11-15: + get: + x-aws-operation-name: DescribeClientVpnAuthorizationRules + operationId: GET_DescribeClientVpnAuthorizationRules + description: Describes the authorization rules for a specified Client VPN endpoint. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeClientVpnAuthorizationRulesResult' + parameters: + - name: ClientVpnEndpointId + in: query + required: true + description: The ID of the Client VPN endpoint. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to retrieve the next page of results.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters. Filter names and values are case-sensitive.
description - The description of the authorization rule.
destination-cidr - The CIDR of the network to which the authorization rule applies.
group-id - The ID of the Active Directory group to which the authorization rule grants access.
One or more filters. Filter names and values are case-sensitive.
connection-id - The ID of the connection.
username - For Active Directory client authentication, the user name of the client who established the client connection.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeClientVpnConnections
+ operationId: POST_DescribeClientVpnConnections
+ description: Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeClientVpnConnectionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeClientVpnConnectionsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeClientVpnEndpoints&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeClientVpnEndpoints
+ operationId: GET_DescribeClientVpnEndpoints
+ description: Describes one or more Client VPN endpoints in the account.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeClientVpnEndpointsResult'
+ parameters:
+ - name: ClientVpnEndpointId
+ in: query
+ required: false
+ description: The ID of the Client VPN endpoint.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnEndpointId'
+ - xml:
+ name: item
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to retrieve the next page of results.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters. Filter names and values are case-sensitive.
endpoint-id - The ID of the Client VPN endpoint.
transport-protocol - The transport protocol (tcp | udp).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeClientVpnEndpoints
+ operationId: POST_DescribeClientVpnEndpoints
+ description: Describes one or more Client VPN endpoints in the account.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeClientVpnEndpointsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeClientVpnEndpointsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeClientVpnRoutes&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeClientVpnRoutes
+ operationId: GET_DescribeClientVpnRoutes
+ description: Describes the routes for the specified Client VPN endpoint.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeClientVpnRoutesResult'
+ parameters:
+ - name: ClientVpnEndpointId
+ in: query
+ required: true
+ description: The ID of the Client VPN endpoint.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters. Filter names and values are case-sensitive.
destination-cidr - The CIDR of the route destination.
origin - How the route was associated with the Client VPN endpoint (associate | add-route).
target-subnet - The ID of the subnet through which traffic is routed.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeClientVpnRoutes
+ operationId: POST_DescribeClientVpnRoutes
+ description: Describes the routes for the specified Client VPN endpoint.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeClientVpnRoutesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeClientVpnRoutesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeClientVpnTargetNetworks&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeClientVpnTargetNetworks
+ operationId: GET_DescribeClientVpnTargetNetworks
+ description: Describes the target networks associated with the specified Client VPN endpoint.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeClientVpnTargetNetworksResult'
+ parameters:
+ - name: ClientVpnEndpointId
+ in: query
+ required: true
+ description: The ID of the Client VPN endpoint.
+ schema:
+ type: string
+ - name: AssociationIds
+ in: query
+ required: false
+ description: The IDs of the target network associations.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to retrieve the next page of results.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters. Filter names and values are case-sensitive.
association-id - The ID of the association.
target-network-id - The ID of the subnet specified as the target network.
vpc-id - The ID of the VPC in which the target network is located.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeClientVpnTargetNetworks
+ operationId: POST_DescribeClientVpnTargetNetworks
+ description: Describes the target networks associated with the specified Client VPN endpoint.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeClientVpnTargetNetworksResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeClientVpnTargetNetworksRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeCoipPools&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeCoipPools
+ operationId: GET_DescribeCoipPools
+ description: Describes the specified customer-owned address pools or all of your customer-owned address pools.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeCoipPoolsResult'
+ parameters:
+ - name: PoolId
+ in: query
+ required: false
+ description: The IDs of the address pools.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PoolCoipId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.
coip-pool.pool-id - The ID of the address pool.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeCoipPools
+ operationId: POST_DescribeCoipPools
+ description: Describes the specified customer-owned address pools or all of your customer-owned address pools.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeCoipPoolsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeCoipPoolsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeConversionTasks&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeConversionTasks
+ operationId: GET_DescribeConversionTasks
+ description: 'Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeConversionTasksResult' + parameters: + - name: ConversionTaskId + in: query + required: false + description: The conversion task IDs. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/ConversionTaskId' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeConversionTasks
+ operationId: POST_DescribeConversionTasks
+ description: 'Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeConversionTasksResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeConversionTasksRequest' + parameters: [] + /?Action=DescribeCustomerGateways&Version=2016-11-15: + get: + x-aws-operation-name: DescribeCustomerGateways + operationId: GET_DescribeCustomerGateways + description: 'Describes one or more of your VPN customer gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeCustomerGatewaysResult' + parameters: + - name: CustomerGatewayId + in: query + required: false + description: 'One or more customer gateway IDs.
Default: Describes all your customer gateways.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/CustomerGatewayId' + - xml: + name: CustomerGatewayId + - name: Filter + in: query + required: false + description: 'One or more filters.
bgp-asn - The customer gateway''s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway''s Internet-routable external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeCustomerGateways
+ operationId: POST_DescribeCustomerGateways
+ description: 'Describes one or more of your VPN customer gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeCustomerGatewaysResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeCustomerGatewaysRequest' + parameters: [] + /?Action=DescribeDhcpOptions&Version=2016-11-15: + get: + x-aws-operation-name: DescribeDhcpOptions + operationId: GET_DescribeDhcpOptions + description: 'Describes one or more of your DHCP options sets.
For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeDhcpOptionsResult' + parameters: + - name: DhcpOptionsId + in: query + required: false + description: 'The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/DhcpOptionsId' + - xml: + name: DhcpOptionsId + - name: Filter + in: query + required: false + description: 'One or more filters.
dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ 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'
+ post:
+ x-aws-operation-name: DescribeDhcpOptions
+ operationId: POST_DescribeDhcpOptions
+ description: 'Describes one or more of your DHCP options sets.
For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeDhcpOptionsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeDhcpOptionsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeEgressOnlyInternetGateways&Version=2016-11-15: + get: + x-aws-operation-name: DescribeEgressOnlyInternetGateways + operationId: GET_DescribeEgressOnlyInternetGateways + description: Describes one or more of your egress-only internet gateways. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeEgressOnlyInternetGatewaysResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: EgressOnlyInternetGatewayId
+ in: query
+ required: false
+ description: One or more egress-only internet gateway IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
+ - xml:
+ name: item
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 255
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'The filters.
availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides.
elastic-gpu-health - The status of the Elastic Graphics accelerator (OK | IMPAIRED).
elastic-gpu-state - The state of the Elastic Graphics accelerator (ATTACHED).
elastic-gpu-type - The type of Elastic Graphics accelerator; for example, eg1.medium.
instance-id - The ID of the instance to which the Elastic Graphics accelerator is associated.
NextToken value. This value can be between 5 and 1000.'
+ schema:
+ type: integer
+ minimum: 10
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to request the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeElasticGpus
+ operationId: POST_DescribeElasticGpus
+ description: 'Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeElasticGpusResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeElasticGpusRequest'
+ parameters: []
+ /?Action=DescribeExportImageTasks&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeExportImageTasks
+ operationId: GET_DescribeExportImageTasks
+ description: Describes the specified export image tasks or all of your export image tasks.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeExportImageTasksResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Filter'
+ - xml:
+ name: Filter
+ - name: ExportImageTaskId
+ in: query
+ required: false
+ description: The IDs of the export image tasks.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ExportImageTaskId'
+ - xml:
+ name: ExportImageTaskId
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of results to return in a single call.
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 500
+ - name: NextToken
+ in: query
+ required: false
+ description: A token that indicates the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeExportImageTasks
+ operationId: POST_DescribeExportImageTasks
+ description: Describes the specified export image tasks or all of your export image tasks.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeExportImageTasksResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeExportImageTasksRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeExportTasks&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeExportTasks
+ operationId: GET_DescribeExportTasks
+ description: Describes the specified export instance tasks or all of your export instance tasks.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeExportTasksResult'
+ parameters:
+ - name: ExportTaskId
+ in: query
+ required: false
+ description: The export task IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ExportTaskId'
+ - xml:
+ name: ExportTaskId
+ - name: Filter
+ in: query
+ required: false
+ description: the filters for the export tasks.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Filter'
+ - xml:
+ name: Filter
+ 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'
+ post:
+ x-aws-operation-name: DescribeExportTasks
+ operationId: POST_DescribeExportTasks
+ description: Describes the specified export instance tasks or all of your export instance tasks.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeExportTasksResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeExportTasksRequest'
+ parameters: []
+ /?Action=DescribeFastLaunchImages&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeFastLaunchImages
+ operationId: GET_DescribeFastLaunchImages
+ description: Describe details for Windows AMIs that are configured for faster launching.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeFastLaunchImagesResult'
+ parameters:
+ - name: ImageId
+ in: query
+ required: false
+ description: Details for one or more Windows AMI image IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImageId'
+ - xml:
+ name: ImageId
+ - name: Filter
+ in: query
+ required: false
+ description: Use the following filters to streamline results.
resource-type - The resource type for pre-provisioning.
launch-template - The launch template that is associated with the pre-provisioned Windows AMI.
owner-id - The owner ID for the pre-provisioning resource.
state - The current state of fast launching for the Windows AMI.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeFastLaunchImages
+ operationId: POST_DescribeFastLaunchImages
+ description: Describe details for Windows AMIs that are configured for faster launching.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeFastLaunchImagesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeFastLaunchImagesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeFastSnapshotRestores&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeFastSnapshotRestores
+ operationId: GET_DescribeFastSnapshotRestores
+ description: Describes the state of fast snapshot restores for your snapshots.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeFastSnapshotRestoresResult'
+ parameters:
+ - name: Filter
+ in: query
+ required: false
+ description: 'The filters. The possible values are:
availability-zone: The Availability Zone of the snapshot.
owner-id: The ID of the Amazon Web Services account that enabled fast snapshot restore on the snapshot.
snapshot-id: The ID of the snapshot.
state: The state of fast snapshot restores for the snapshot (enabling | optimizing | enabled | disabling | disabled).
nextToken value.'
+ schema:
+ type: integer
+ minimum: 0
+ maximum: 200
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeFastSnapshotRestores
+ operationId: POST_DescribeFastSnapshotRestores
+ description: Describes the state of fast snapshot restores for your snapshots.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeFastSnapshotRestoresResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeFastSnapshotRestoresRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeFleetHistory&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeFleetHistory
+ operationId: GET_DescribeFleetHistory
+ description: 'Describes the events for the specified EC2 Fleet during the specified time.
EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeFleetHistoryResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: EventType
+ in: query
+ required: false
+ description: 'The type of events to describe. By default, all events are described.'
+ schema:
+ type: string
+ enum:
+ - instance-change
+ - fleet-change
+ - service-error
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next set of results.
+ schema:
+ type: string
+ - name: FleetId
+ in: query
+ required: true
+ description: The ID of the EC2 Fleet.
+ schema:
+ type: string
+ - name: StartTime
+ in: query
+ required: true
+ description: 'The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ schema:
+ type: string
+ format: date-time
+ 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'
+ post:
+ x-aws-operation-name: DescribeFleetHistory
+ operationId: POST_DescribeFleetHistory
+ description: 'Describes the events for the specified EC2 Fleet during the specified time.
EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeFleetHistoryResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeFleetHistoryRequest' + parameters: [] + /?Action=DescribeFleetInstances&Version=2016-11-15: + get: + x-aws-operation-name: DescribeFleetInstances + operationId: GET_DescribeFleetInstances + description: 'Describes the running instances for the specified EC2 Fleet.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeFleetInstancesResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next set of results.
+ schema:
+ type: string
+ - name: FleetId
+ in: query
+ required: true
+ description: The ID of the EC2 Fleet.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: The filters.
instance-type - The instance type.
Describes the running instances for the specified EC2 Fleet.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeFleetInstancesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeFleetInstancesRequest' + parameters: [] + /?Action=DescribeFleets&Version=2016-11-15: + get: + x-aws-operation-name: DescribeFleets + operationId: GET_DescribeFleets + description: 'Describes the specified EC2 Fleets or all of your EC2 Fleets.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeFleetsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next set of results.
+ schema:
+ type: string
+ - name: FleetId
+ in: query
+ required: false
+ description: 'The IDs of the EC2 Fleets.
If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.
The filters.
activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).
excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).
fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).
replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).
type - The type of request (instant | request | maintain).
Describes the specified EC2 Fleets or all of your EC2 Fleets.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeFleetsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeFleetsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeFlowLogs&Version=2016-11-15: + get: + x-aws-operation-name: DescribeFlowLogs + operationId: GET_DescribeFlowLogs + description: 'Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeFlowLogsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).
log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and s3.
flow-log-id - The ID of the flow log.
log-group-name - The name of the log group.
resource-id - The ID of the VPC, subnet, or network interface.
traffic-type - The type of traffic (ACCEPT | REJECT | ALL).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/VpcFlowLogId' + - xml: + name: item + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeFlowLogs
+ operationId: POST_DescribeFlowLogs
+ description: 'Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeFlowLogsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeFlowLogsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeFpgaImageAttribute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeFpgaImageAttribute
+ operationId: GET_DescribeFpgaImageAttribute
+ description: Describes the specified attribute of the specified Amazon FPGA Image (AFI).
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeFpgaImageAttributeResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: FpgaImageId
+ in: query
+ required: true
+ description: The ID of the AFI.
+ schema:
+ type: string
+ - name: Attribute
+ in: query
+ required: true
+ description: The AFI attribute.
+ schema:
+ type: string
+ enum:
+ - description
+ - name
+ - loadPermission
+ - productCodes
+ 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'
+ post:
+ x-aws-operation-name: DescribeFpgaImageAttribute
+ operationId: POST_DescribeFpgaImageAttribute
+ description: Describes the specified attribute of the specified Amazon FPGA Image (AFI).
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeFpgaImageAttributeResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeFpgaImageAttributeRequest'
+ parameters: []
+ /?Action=DescribeFpgaImages&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeFpgaImages
+ operationId: GET_DescribeFpgaImages
+ description: 'Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeFpgaImagesResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: FpgaImageId
+ in: query
+ required: false
+ description: The AFI IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/FpgaImageId'
+ - xml:
+ name: item
+ - name: Owner
+ in: query
+ required: false
+ description: 'Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: Owner
+ - name: Filter
+ in: query
+ required: false
+ description: 'The filters.
create-time - The creation time of the AFI.
fpga-image-id - The FPGA image identifier (AFI ID).
fpga-image-global-id - The global FPGA image identifier (AGFI ID).
name - The name of the AFI.
owner-id - The Amazon Web Services account ID of the AFI owner.
product-code - The product code.
shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
state - The state of the AFI (pending | failed | available | unavailable).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
update-time - The time of the most recent update.
Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeHostReservationOfferingsResult' + parameters: + - name: Filter + in: query + required: false + description: 'The filters.
instance-family - The instance family of the offering (for example, m4).
payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 500
+ - name: MinDuration
+ in: query
+ required: false
+ description: 'This is the minimum duration of the reservation you''d like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to use to retrieve the next page of results.
+ schema:
+ type: string
+ - name: OfferingId
+ in: query
+ required: false
+ description: The ID of the reservation offering.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeHostReservationOfferings
+ operationId: POST_DescribeHostReservationOfferings
+ description: 'Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeHostReservationOfferingsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeHostReservationOfferingsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeHostReservations&Version=2016-11-15: + get: + x-aws-operation-name: DescribeHostReservations + operationId: GET_DescribeHostReservations + description: Describes reservations that are associated with Dedicated Hosts in your account. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeHostReservationsResult' + parameters: + - name: Filter + in: query + required: false + description: 'The filters.
instance-family - The instance family (for example, m4).
payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
state - The state of the reservation (payment-pending | payment-failed | active | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to use to retrieve the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeHostReservations
+ operationId: POST_DescribeHostReservations
+ description: Describes reservations that are associated with Dedicated Hosts in your account.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeHostReservationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeHostReservationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeHosts&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeHosts
+ operationId: GET_DescribeHosts
+ description: Describes the specified Dedicated Hosts or all your Dedicated Hosts.
The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.
The filters.
auto-placement - Whether auto-placement is enabled or disabled (on | off).
availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you allocated the host.
host-reservation-id - The ID of the reservation assigned to this host.
instance-type - The instance type size that the Dedicated Host is configured to support.
state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
' + schema: + type: integer + - name: NextToken + in: query + required: false + description: The token to use to retrieve the next page of results. + schema: + type: string + 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' + post: + x-aws-operation-name: DescribeHosts + operationId: POST_DescribeHosts + description:Describes the specified Dedicated Hosts or all your Dedicated Hosts.
The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.
The filters.
instance-id - The ID of the instance.
state - The state of the association (associating | associated | disassociating).
NextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to request the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeIamInstanceProfileAssociations
+ operationId: POST_DescribeIamInstanceProfileAssociations
+ description: Describes your IAM instance profile associations.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeIamInstanceProfileAssociationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeIamInstanceProfileAssociationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeIdFormat&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeIdFormat
+ operationId: GET_DescribeIdFormat
+ description: 'Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the IAM user who makes the request; they do not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeIdFormat
+ operationId: POST_DescribeIdFormat
+ description: 'Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the IAM user who makes the request; they do not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeIdentityIdFormatResult' + parameters: + - name: PrincipalArn + in: query + required: true + description: 'The ARN of the principal, which can be an IAM role, IAM user, or the root user.' + schema: + type: string + - name: Resource + in: query + required: false + description: 'The type of resource:bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeIdentityIdFormat
+ operationId: POST_DescribeIdentityIdFormat
+ description: 'Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeIdentityIdFormatResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeIdentityIdFormatRequest' + parameters: [] + /?Action=DescribeImageAttribute&Version=2016-11-15: + get: + x-aws-operation-name: DescribeImageAttribute + operationId: GET_DescribeImageAttribute + description: Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImageAttribute' + parameters: + - name: Attribute + in: query + required: true + description: 'The AMI attribute.
Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeImageAttribute
+ operationId: POST_DescribeImageAttribute
+ description: Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ImageAttribute'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeImageAttributeRequest'
+ parameters: []
+ /?Action=DescribeImages&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeImages
+ operationId: GET_DescribeImages
+ description: 'Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeImagesResult' + parameters: + - name: ExecutableBy + in: query + required: false + description: 'Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).
If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.
If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.
If you specify all, all public AMIs are returned.
The filters.
architecture - The image architecture (i386 | x86_64 | arm64).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
description - The description of the image (provided during image creation).
ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
platform - The platform. To only list Windows-based AMIs, use windows.
product-code - The product code.
product-code.type - The type of the product code (marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
virtualization-type - The virtualization type (paravirtual | hvm).
The image IDs.
Default: Describes all images available to you.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/ImageId' + - xml: + name: ImageId + - name: Owner + in: query + required: false + description: 'Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs,self, amazon, and aws-marketplace. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: Owner
+ - name: IncludeDeprecated
+ in: query
+ required: false
+ description: 'If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeImages
+ operationId: POST_DescribeImages
+ description: 'Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeImagesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeImagesRequest' + parameters: [] + /?Action=DescribeImportImageTasks&Version=2016-11-15: + get: + x-aws-operation-name: DescribeImportImageTasks + operationId: GET_DescribeImportImageTasks + description: Displays details about an import virtual machine or import snapshot tasks that are already created. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeImportImageTasksResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filters
+ in: query
+ required: false
+ description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Filter'
+ - xml:
+ name: Filter
+ - name: ImportTaskId
+ in: query
+ required: false
+ description: The IDs of the import image tasks.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImportImageTaskId'
+ - xml:
+ name: ImportTaskId
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of results to return in a single call.
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: A token that indicates the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeImportImageTasks
+ operationId: POST_DescribeImportImageTasks
+ description: Displays details about an import virtual machine or import snapshot tasks that are already created.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeImportImageTasksResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeImportImageTasksRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeImportSnapshotTasks&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeImportSnapshotTasks
+ operationId: GET_DescribeImportSnapshotTasks
+ description: Describes your import snapshot tasks.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeImportSnapshotTasksResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filters
+ in: query
+ required: false
+ description: The filters.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Filter'
+ - xml:
+ name: Filter
+ - name: ImportTaskId
+ in: query
+ required: false
+ description: A list of import snapshot task IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImportSnapshotTaskId'
+ - xml:
+ name: ImportTaskId
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: A token that indicates the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeImportSnapshotTasks
+ operationId: POST_DescribeImportSnapshotTasks
+ description: Describes your import snapshot tasks.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeImportSnapshotTasksResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeImportSnapshotTasksRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeInstanceAttribute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeInstanceAttribute
+ operationId: GET_DescribeInstanceAttribute
+ description: 'Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport '
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/InstanceAttribute'
+ parameters:
+ - name: Attribute
+ in: query
+ required: true
+ description: 'The instance attribute.
Note: The enaSupport attribute is not supported at this time.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeInstanceAttribute
+ operationId: POST_DescribeInstanceAttribute
+ description: 'Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport '
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/InstanceAttribute'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeInstanceAttributeRequest'
+ parameters: []
+ /?Action=DescribeInstanceCreditSpecifications&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeInstanceCreditSpecifications
+ operationId: GET_DescribeInstanceCreditSpecifications
+ description: 'Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: The filters.
instance-id - The ID of the instance.
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 1000 explicitly specified instance IDs.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceId' + - xml: + name: InstanceId + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returnedNextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to retrieve the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeInstanceCreditSpecifications
+ operationId: POST_DescribeInstanceCreditSpecifications
+ description: 'Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeInstanceEventNotificationAttributes&Version=2016-11-15: + get: + x-aws-operation-name: DescribeInstanceEventNotificationAttributes + operationId: GET_DescribeInstanceEventNotificationAttributes + description: Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeInstanceEventNotificationAttributesResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeInstanceEventNotificationAttributes
+ operationId: POST_DescribeInstanceEventNotificationAttributes
+ description: Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeInstanceEventNotificationAttributesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeInstanceEventNotificationAttributesRequest'
+ parameters: []
+ /?Action=DescribeInstanceEventWindows&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeInstanceEventWindows
+ operationId: GET_DescribeInstanceEventWindows
+ description: 'Describes the specified event windows or all event windows.
If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeInstanceEventWindowsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceEventWindowId
+ in: query
+ required: false
+ description: The IDs of the event windows.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowId'
+ - xml:
+ name: InstanceEventWindowId
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
dedicated-host-id - The event windows associated with the specified Dedicated Host ID.
event-window-name - The event windows associated with the specified names.
instance-id - The event windows associated with the specified instance ID.
instance-tag - The event windows associated with the specified tag and value.
instance-tag-key - The event windows associated with the specified tag key, regardless of the value.
instance-tag-value - The event windows associated with the specified tag value, regardless of the key.
tag:<key> - The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.
tag-key - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.
tag-value - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.
NextToken value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.'
+ schema:
+ type: integer
+ minimum: 20
+ maximum: 500
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to request the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeInstanceEventWindows
+ operationId: POST_DescribeInstanceEventWindows
+ description: 'Describes the specified event windows or all event windows.
If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeInstanceEventWindowsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeInstanceEventWindowsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeInstanceStatus&Version=2016-11-15: + get: + x-aws-operation-name: DescribeInstanceStatus + operationId: GET_DescribeInstanceStatus + description: 'Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceId' + - xml: + name: InstanceId + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returnedNextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to retrieve the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IncludeAllInstances
+ in: query
+ required: false
+ description: 'When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: LocationType
+ in: query
+ required: false
+ description: The location type.
+ schema:
+ type: string
+ enum:
+ - region
+ - availability-zone
+ - availability-zone-id
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. Filter names and values are case-sensitive.
location - This depends on the location type. For example, if the location type is region (default), the location is the Region code (for example, us-east-2.)
instance-type - The instance type. For example, c5.2xlarge.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceType
+ in: query
+ required: false
+ description: 'The instance types. For more information, see Instance types in the Amazon EC2 User Guide.'
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/InstanceType'
+ minItems: 0
+ maxItems: 100
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether auto recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether it is a burstable performance instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, "25 Gigabit").
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, "1" or "1,2".
Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeInstancesResult' + parameters: + - name: Filter + in: query + required: false + description: 'The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. EC2-Classic only.
group-name - The name of the security group for the instance. EC2-Classic only.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (enabled | disabled)
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance''s reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The instance IDs.
Default: Describes all your instances.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceId' + - xml: + name: InstanceId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to request the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeInstances
+ operationId: POST_DescribeInstances
+ description: 'Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeInstancesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeInstancesRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeInternetGateways&Version=2016-11-15: + get: + x-aws-operation-name: DescribeInternetGateways + operationId: GET_DescribeInternetGateways + description: Describes one or more of your internet gateways. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeInternetGatewaysResult' + parameters: + - name: Filter + in: query + required: false + description: 'One or more filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InternetGatewayId
+ in: query
+ required: false
+ description: 'One or more internet gateway IDs.
Default: Describes all your internet gateways.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/InternetGatewayId' + - xml: + name: item + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + type: string + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ 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'
+ post:
+ x-aws-operation-name: DescribeInternetGateways
+ operationId: POST_DescribeInternetGateways
+ description: Describes one or more of your internet gateways.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeInternetGatewaysResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeInternetGatewaysRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeIpamPools&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeIpamPools
+ operationId: GET_DescribeIpamPools
+ description: Get information about your IPAM pools.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeIpamPoolsResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Filter'
+ - xml:
+ name: Filter
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of results to return in the request.
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: IpamPoolId
+ in: query
+ required: false
+ description: The IDs of the IPAM pools you would like information on.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: DescribeIpamPools
+ operationId: POST_DescribeIpamPools
+ description: Get information about your IPAM pools.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeIpamPoolsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeIpamPoolsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeIpamScopes&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeIpamScopes
+ operationId: GET_DescribeIpamScopes
+ description: Get information about your IPAM scopes.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeIpamScopesResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Filter'
+ - xml:
+ name: Filter
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of results to return in the request.
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: IpamScopeId
+ in: query
+ required: false
+ description: The IDs of the scopes you want information on.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: DescribeIpamScopes
+ operationId: POST_DescribeIpamScopes
+ description: Get information about your IPAM scopes.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeIpamScopesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeIpamScopesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeIpams&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeIpams
+ operationId: GET_DescribeIpams
+ description: 'Get information about your IPAM pools.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeIpamsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Filter'
+ - xml:
+ name: Filter
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of results to return in the request.
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: IpamId
+ in: query
+ required: false
+ description: The IDs of the IPAMs you want information on.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: DescribeIpams
+ operationId: POST_DescribeIpams
+ description: 'Get information about your IPAM pools.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeIpamsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeIpamsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeIpv6Pools&Version=2016-11-15: + get: + x-aws-operation-name: DescribeIpv6Pools + operationId: GET_DescribeIpv6Pools + description: Describes your IPv6 address pools. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeIpv6PoolsResult' + parameters: + - name: PoolId + in: query + required: false + description: The IDs of the IPv6 address pools. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/Ipv6PoolEc2Id' + - xml: + name: item + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + type: string + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeKeyPairsResult' + parameters: + - name: Filter + in: query + required: false + description: 'The filters.
key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The key pair names.
Default: Describes all of your key pairs.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/KeyPairName' + - xml: + name: KeyName + - name: KeyPairId + in: query + required: false + description: The IDs of the key pairs. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/KeyPairId' + - xml: + name: KeyPairId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IncludePublicKey
+ in: query
+ required: false
+ description: 'If true, the public key material is included in the response.
Default: false
Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeKeyPairsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeKeyPairsRequest' + parameters: [] + /?Action=DescribeLaunchTemplateVersions&Version=2016-11-15: + get: + x-aws-operation-name: DescribeLaunchTemplateVersions + operationId: GET_DescribeLaunchTemplateVersions + description: 'Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeLaunchTemplateVersionsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: LaunchTemplateId
+ in: query
+ required: false
+ description: 'The ID of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter.'
+ schema:
+ type: string
+ - name: LaunchTemplateName
+ in: query
+ required: false
+ description: 'The name of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter.'
+ schema:
+ type: string
+ pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
+ minLength: 3
+ maxLength: 128
+ - name: LaunchTemplateVersion
+ in: query
+ required: false
+ description: 'One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.
To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest. To describe all launch templates in your account that are defined as the default version, the valid value is $Default. You can specify $Latest and $Default in the same call. You cannot specify numbers.
NextToken value. This value can be between 1 and 200.'
+ schema:
+ type: integer
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
create-time - The time the launch template version was created.
ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).
http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).
host-resource-group-arn - The ARN of the host resource group in which to launch the instances.
http-tokens - The state of token usage for your instance metadata requests (optional | required).
iam-instance-profile - The ARN of the IAM instance profile.
image-id - The ID of the AMI.
instance-type - The instance type.
is-default-version - A boolean that indicates whether the launch template version is the default version.
kernel-id - The kernel ID.
license-configuration-arn - The ARN of the license configuration.
network-card-index - The index of the network card.
ram-disk-id - The RAM disk ID.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: LaunchTemplateId
+ in: query
+ required: false
+ description: One or more launch template IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateId'
+ - xml:
+ name: item
+ - name: LaunchTemplateName
+ in: query
+ required: false
+ description: One or more launch template names.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateName'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
create-time - The time the launch template was created.
launch-template-name - The name of the launch template.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
NextToken value. This value can be between 1 and 200.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 200
+ 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'
+ post:
+ x-aws-operation-name: DescribeLaunchTemplates
+ operationId: POST_DescribeLaunchTemplates
+ description: Describes one or more launch templates.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLaunchTemplatesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLaunchTemplatesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
+ operationId: GET_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
+ description: Describes the associations between virtual interface groups and local gateway route tables.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult'
+ parameters:
+ - name: LocalGatewayRouteTableVirtualInterfaceGroupAssociationId
+ in: query
+ required: false
+ description: The IDs of the associations.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
state - The state of the association.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
+ operationId: POST_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
+ description: Describes the associations between virtual interface groups and local gateway route tables.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeLocalGatewayRouteTableVpcAssociations&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeLocalGatewayRouteTableVpcAssociations
+ operationId: GET_DescribeLocalGatewayRouteTableVpcAssociations
+ description: Describes the specified associations between VPCs and local gateway route tables.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVpcAssociationsResult'
+ parameters:
+ - name: LocalGatewayRouteTableVpcAssociationId
+ in: query
+ required: false
+ description: The IDs of the associations.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the association.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-vpc-association-id - The ID of the association.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route table for the association.
state - The state of the association.
vpc-id - The ID of the VPC.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeLocalGatewayRouteTableVpcAssociations
+ operationId: POST_DescribeLocalGatewayRouteTableVpcAssociations
+ description: Describes the specified associations between VPCs and local gateway route tables.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVpcAssociationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVpcAssociationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeLocalGatewayRouteTables&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeLocalGatewayRouteTables
+ operationId: GET_DescribeLocalGatewayRouteTables
+ description: 'Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayRouteTablesResult'
+ parameters:
+ - name: LocalGatewayRouteTableId
+ in: query
+ required: false
+ description: The IDs of the local gateway route tables.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRoutetableId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table.
local-gateway-route-table-id - The ID of a local gateway route table.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route table.
state - The state of the local gateway route table.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeLocalGatewayRouteTables
+ operationId: POST_DescribeLocalGatewayRouteTables
+ description: 'Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayRouteTablesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayRouteTablesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeLocalGatewayVirtualInterfaceGroups&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeLocalGatewayVirtualInterfaceGroups
+ operationId: GET_DescribeLocalGatewayVirtualInterfaceGroups
+ description: Describes the specified local gateway virtual interface groups.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfaceGroupsResult'
+ parameters:
+ - name: LocalGatewayVirtualInterfaceGroupId
+ in: query
+ required: false
+ description: The IDs of the virtual interface groups.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeLocalGatewayVirtualInterfaceGroups
+ operationId: POST_DescribeLocalGatewayVirtualInterfaceGroups
+ description: Describes the specified local gateway virtual interface groups.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfaceGroupsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfaceGroupsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeLocalGatewayVirtualInterfaces&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeLocalGatewayVirtualInterfaces
+ operationId: GET_DescribeLocalGatewayVirtualInterfaces
+ description: Describes the specified local gateway virtual interfaces.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesResult'
+ parameters:
+ - name: LocalGatewayVirtualInterfaceId
+ in: query
+ required: false
+ description: The IDs of the virtual interfaces.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
local-address - The local address.
local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
local-gateway-id - The ID of the local gateway.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.
peer-address - The peer address.
peer-bgp-asn - The peer BGP ASN.
vlan - The ID of the VLAN.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeLocalGatewayVirtualInterfaces
+ operationId: POST_DescribeLocalGatewayVirtualInterfaces
+ description: Describes the specified local gateway virtual interfaces.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeLocalGateways&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeLocalGateways
+ operationId: GET_DescribeLocalGateways
+ description: 'Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewaysResult'
+ parameters:
+ - name: LocalGatewayId
+ in: query
+ required: false
+ description: The IDs of the local gateways.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
local-gateway-id - The ID of a local gateway.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway.
state - The state of the association.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeLocalGateways
+ operationId: POST_DescribeLocalGateways
+ description: 'Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewaysResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeLocalGatewaysRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeManagedPrefixLists&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeManagedPrefixLists
+ operationId: GET_DescribeManagedPrefixLists
+ description: 'Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeManagedPrefixListsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
owner-id - The ID of the prefix list owner.
prefix-list-id - The ID of the prefix list.
prefix-list-name - The name of the prefix list.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 100
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: PrefixListId
+ in: query
+ required: false
+ description: One or more prefix list IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: DescribeManagedPrefixLists
+ operationId: POST_DescribeManagedPrefixLists
+ description: 'Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeManagedPrefixListsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeManagedPrefixListsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeMovingAddresses&Version=2016-11-15: + get: + x-aws-operation-name: DescribeMovingAddresses + operationId: GET_DescribeMovingAddresses + description: 'Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeMovingAddressesResult' + parameters: + - name: Filter + in: query + required: false + description:One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
' + schema: + type: integer + minimum: 5 + maximum: 1000 + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + type: string + - name: PublicIp + in: query + required: false + description: One or more Elastic IP addresses. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + 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' + post: + x-aws-operation-name: DescribeMovingAddresses + operationId: POST_DescribeMovingAddresses + description: 'Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeMovingAddressesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeMovingAddressesRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeNatGateways&Version=2016-11-15: + get: + x-aws-operation-name: DescribeNatGateways + operationId: GET_DescribeNatGateways + description: Describes one or more of your NAT gateways. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeNatGatewaysResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
nat-gateway-id - The ID of the NAT gateway.
state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
subnet-id - The ID of the subnet in which the NAT gateway resides.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the NAT gateway resides.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NatGatewayId
+ in: query
+ required: false
+ description: One or more NAT gateway IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NatGatewayId'
+ - xml:
+ name: item
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeNatGateways
+ operationId: POST_DescribeNatGateways
+ description: Describes one or more of your NAT gateways.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNatGatewaysResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNatGatewaysRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeNetworkAcls&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeNetworkAcls
+ operationId: GET_DescribeNetworkAcls
+ description: 'Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeNetworkAclsResult' + parameters: + - name: Filter + in: query + required: false + description: 'One or more filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the Amazon Web Services account that owns the network ACL.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network ACL.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NetworkAclId
+ in: query
+ required: false
+ description: 'One or more network ACL IDs.
Default: Describes all your network ACLs.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/NetworkAclId' + - xml: + name: item + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + type: string + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ 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'
+ post:
+ x-aws-operation-name: DescribeNetworkAcls
+ operationId: POST_DescribeNetworkAcls
+ description: 'Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeNetworkAclsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeNetworkAclsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeNetworkInsightsAccessScopeAnalyses&Version=2016-11-15: + get: + x-aws-operation-name: DescribeNetworkInsightsAccessScopeAnalyses + operationId: GET_DescribeNetworkInsightsAccessScopeAnalyses + description: Describes the specified Network Access Scope analyses. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopeAnalysesResult' + parameters: + - name: NetworkInsightsAccessScopeAnalysisId + in: query + required: false + description: The IDs of the Network Access Scope analyses. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId' + - xml: + name: item + - name: NetworkInsightsAccessScopeId + in: query + required: false + description: The ID of the Network Access Scope. + schema: + type: string + - name: AnalysisStartTimeBegin + in: query + required: false + description: Filters the results based on the start time. The analysis must have started on or after this time. + schema: + type: string + format: date-time + - name: AnalysisStartTimeEnd + in: query + required: false + description: Filters the results based on the start time. The analysis must have started on or before this time. + schema: + type: string + format: date-time + - name: Filter + in: query + required: false + description: There are no supported filters. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/Filter' + - xml: + name: Filter + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 100
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeNetworkInsightsAccessScopeAnalyses
+ operationId: POST_DescribeNetworkInsightsAccessScopeAnalyses
+ description: Describes the specified Network Access Scope analyses.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopeAnalysesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopeAnalysesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeNetworkInsightsAccessScopes&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeNetworkInsightsAccessScopes
+ operationId: GET_DescribeNetworkInsightsAccessScopes
+ description: Describes the specified Network Access Scopes.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesResult'
+ parameters:
+ - name: NetworkInsightsAccessScopeId
+ in: query
+ required: false
+ description: The IDs of the Network Access Scopes.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: There are no supported filters.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Filter'
+ - xml:
+ name: Filter
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 100
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeNetworkInsightsAccessScopes
+ operationId: POST_DescribeNetworkInsightsAccessScopes
+ description: Describes the specified Network Access Scopes.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeNetworkInsightsAnalyses&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeNetworkInsightsAnalyses
+ operationId: GET_DescribeNetworkInsightsAnalyses
+ description: Describes one or more of your network insights analyses.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInsightsAnalysesResult'
+ parameters:
+ - name: NetworkInsightsAnalysisId
+ in: query
+ required: false
+ description: The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAnalysisId'
+ - xml:
+ name: item
+ - name: NetworkInsightsPathId
+ in: query
+ required: false
+ description: The ID of the path. You must specify either a path ID or analysis IDs.
+ schema:
+ type: string
+ - name: AnalysisStartTime
+ in: query
+ required: false
+ description: The time when the network insights analyses started.
+ schema:
+ type: string
+ format: date-time
+ - name: AnalysisEndTime
+ in: query
+ required: false
+ description: The time when the network insights analyses ended.
+ schema:
+ type: string
+ format: date-time
+ - name: Filter
+ in: query
+ required: false
+ description: 'The filters. The following are the possible values:
PathFound - A Boolean value that indicates whether a feasible path is found.
Status - The status of the analysis (running | succeeded | failed).
nextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 100
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeNetworkInsightsAnalyses
+ operationId: POST_DescribeNetworkInsightsAnalyses
+ description: Describes one or more of your network insights analyses.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInsightsAnalysesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInsightsAnalysesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeNetworkInsightsPaths&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeNetworkInsightsPaths
+ operationId: GET_DescribeNetworkInsightsPaths
+ description: Describes one or more of your paths.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInsightsPathsResult'
+ parameters:
+ - name: NetworkInsightsPathId
+ in: query
+ required: false
+ description: The IDs of the paths.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsPathId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: 'The filters. The following are the possible values:
Destination - The ID of the resource.
DestinationPort - The destination port.
Name - The path name.
Protocol - The protocol.
Source - The ID of the resource.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 100
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeNetworkInsightsPaths
+ operationId: POST_DescribeNetworkInsightsPaths
+ description: Describes one or more of your paths.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInsightsPathsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInsightsPathsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeNetworkInterfaceAttribute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeNetworkInterfaceAttribute
+ operationId: GET_DescribeNetworkInterfaceAttribute
+ description: Describes a network interface attribute. You can specify only one attribute at a time.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeResult'
+ parameters:
+ - name: Attribute
+ in: query
+ required: false
+ description: The attribute of the network interface. This parameter is required.
+ schema:
+ type: string
+ enum:
+ - description
+ - groupSet
+ - sourceDestCheck
+ - attachment
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NetworkInterfaceId
+ in: query
+ required: true
+ description: The ID of the network interface.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeNetworkInterfaceAttribute
+ operationId: POST_DescribeNetworkInterfaceAttribute
+ description: Describes a network interface attribute. You can specify only one attribute at a time.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeRequest'
+ parameters: []
+ /?Action=DescribeNetworkInterfacePermissions&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeNetworkInterfacePermissions
+ operationId: GET_DescribeNetworkInterfacePermissions
+ description: 'Describes the permissions for your network interfaces. '
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsResult'
+ parameters:
+ - name: NetworkInterfacePermissionId
+ in: query
+ required: false
+ description: One or more network interface permission IDs.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/NetworkInterfacePermissionId'
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
network-interface-permission.network-interface-permission-id - The ID of the permission.
network-interface-permission.network-interface-id - The ID of the network interface.
network-interface-permission.aws-account-id - The Amazon Web Services account ID.
network-interface-permission.aws-service - The Amazon Web Service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
NextToken value. If this parameter is not specified, up to 50 results are returned by default.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 255
+ 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'
+ post:
+ x-aws-operation-name: DescribeNetworkInterfacePermissions
+ operationId: POST_DescribeNetworkInterfacePermissions
+ description: 'Describes the permissions for your network interfaces. '
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeNetworkInterfaces&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeNetworkInterfaces
+ operationId: GET_DescribeNetworkInterfaces
+ description: Describes one or more of your network interfaces.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeNetworkInterfacesResult'
+ parameters:
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attachment-id - The ID of the interface attachment.
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | efa | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NetworkInterfaceId
+ in: query
+ required: false
+ description: 'One or more network interface IDs.
Default: Describes all your network interfaces.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/NetworkInterfaceId' + - xml: + name: item + - name: NextToken + in: query + required: false + description: The token to retrieve the next page of results. + schema: + type: string + - name: MaxResults + in: query + required: false + description: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request. + schema: + type: integer + minimum: 5 + maximum: 1000 + 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' + post: + x-aws-operation-name: DescribeNetworkInterfaces + operationId: POST_DescribeNetworkInterfaces + description: Describes one or more of your network interfaces. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeNetworkInterfacesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeNetworkInterfacesRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribePlacementGroups&Version=2016-11-15: + get: + x-aws-operation-name: DescribePlacementGroups + operationId: GET_DescribePlacementGroups + description: 'Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribePlacementGroupsResult' + parameters: + - name: Filter + in: query + required: false + description: 'The filters.
group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: GroupName
+ in: query
+ required: false
+ description: 'The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
' + schema: + type: array + items: + $ref: '#/components/schemas/PlacementGroupName' + - name: GroupId + in: query + required: false + description: The IDs of the placement groups. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/PlacementGroupId' + - xml: + name: GroupId + 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' + post: + x-aws-operation-name: DescribePlacementGroups + operationId: POST_DescribePlacementGroups + description: 'Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribePlacementGroupsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribePlacementGroupsRequest' + parameters: [] + /?Action=DescribePrefixLists&Version=2016-11-15: + get: + x-aws-operation-name: DescribePrefixLists + operationId: GET_DescribePrefixLists + description: 'Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.
We recommend that you use DescribeManagedPrefixLists instead.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribePrefixListsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.
nextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: PrefixListId
+ in: query
+ required: false
+ description: One or more prefix list IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListResourceId'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: DescribePrefixLists
+ operationId: POST_DescribePrefixLists
+ description: 'Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.
We recommend that you use DescribeManagedPrefixLists instead.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribePrefixListsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribePrefixListsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribePrincipalIdFormat&Version=2016-11-15: + get: + x-aws-operation-name: DescribePrincipalIdFormat + operationId: GET_DescribePrincipalIdFormat + description: 'Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Resource
+ in: query
+ required: false
+ description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. '
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to request the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribePrincipalIdFormat
+ operationId: POST_DescribePrincipalIdFormat
+ description: 'Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 10
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes the Regions that are enabled for your account, or all Regions.
For a list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud endpoints and quotas.
For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeRegionsResult' + parameters: + - name: Filter + in: query + required: false + description: 'The filters.
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).
region-name - The name of the Region (for example, us-east-1).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: AllRegions
+ in: query
+ required: false
+ description: 'Indicates whether to display all Regions, including Regions that are disabled for your account.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeRegions
+ operationId: POST_DescribeRegions
+ description: 'Describes the Regions that are enabled for your account, or all Regions.
For a list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud endpoints and quotas.
For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeRegionsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeRegionsRequest' + parameters: [] + /?Action=DescribeReplaceRootVolumeTasks&Version=2016-11-15: + get: + x-aws-operation-name: DescribeReplaceRootVolumeTasks + operationId: GET_DescribeReplaceRootVolumeTasks + description: 'Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReplaceRootVolumeTasksResult' + parameters: + - name: ReplaceRootVolumeTaskId + in: query + required: false + description: The ID of the root volume replacement task to view. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/ReplaceRootVolumeTaskId' + - xml: + name: ReplaceRootVolumeTaskId + - name: Filter + in: query + required: false + description: 'Filter to use:
instance-id - The ID of the instance for which the root volume replacement task was created.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 50
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeReplaceRootVolumeTasks
+ operationId: POST_DescribeReplaceRootVolumeTasks
+ description: 'Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeReplaceRootVolumeTasksResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeReplaceRootVolumeTasksRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeReservedInstances&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeReservedInstances
+ operationId: GET_DescribeReservedInstances
+ description: 'Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReservedInstancesResult' + parameters: + - name: Filter + in: query + required: false + description: 'One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
scope - The scope of the Reserved Instance (Region or Availability Zone).
product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/ReservationId' + - xml: + name: ReservedInstancesId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: OfferingType
+ in: query
+ required: false
+ description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.'
+ schema:
+ type: string
+ enum:
+ - Heavy Utilization
+ - Medium Utilization
+ - Light Utilization
+ - No Upfront
+ - Partial Upfront
+ - All Upfront
+ 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'
+ post:
+ x-aws-operation-name: DescribeReservedInstances
+ operationId: POST_DescribeReservedInstances
+ description: 'Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReservedInstancesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReservedInstancesRequest' + parameters: [] + /?Action=DescribeReservedInstancesListings&Version=2016-11-15: + get: + x-aws-operation-name: DescribeReservedInstancesListings + operationId: GET_DescribeReservedInstancesListings + description: 'Describes your account''s Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you''re searching for with what''s available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReservedInstancesListingsResult' + parameters: + - name: Filter + in: query + required: false + description:One or more filters.
reserved-instances-id - The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active | cancelled | closed).
status-message - The reason for the status.
Describes your account''s Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you''re searching for with what''s available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReservedInstancesListingsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReservedInstancesListingsRequest' + parameters: [] + /?Action=DescribeReservedInstancesModifications&Version=2016-11-15: + get: + x-aws-operation-name: DescribeReservedInstancesModifications + operationId: GET_DescribeReservedInstancesModifications + description: 'Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReservedInstancesModificationsResult' + parameters: + - name: Filter + in: query + required: false + description:One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReservedInstancesModificationsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReservedInstancesModificationsRequest' + parameters: + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeReservedInstancesOfferings&Version=2016-11-15: + get: + x-aws-operation-name: DescribeReservedInstancesOfferings + operationId: GET_DescribeReservedInstancesOfferings + description: 'Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReservedInstancesOfferingsResult' + parameters: + - name: AvailabilityZone + in: query + required: false + description: The Availability Zone in which the Reserved Instance can be used. + schema: + type: string + - name: Filter + in: query + required: false + description: 'One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))
reserved-instances-offering-id - The Reserved Instances offering ID.
scope - The scope of the Reserved Instance (Availability Zone or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
m1.small). For more information, see Instance types in the Amazon EC2 User Guide.'
+ schema:
+ type: string
+ enum:
+ - a1.medium
+ - a1.large
+ - a1.xlarge
+ - a1.2xlarge
+ - a1.4xlarge
+ - a1.metal
+ - c1.medium
+ - c1.xlarge
+ - c3.large
+ - c3.xlarge
+ - c3.2xlarge
+ - c3.4xlarge
+ - c3.8xlarge
+ - c4.large
+ - c4.xlarge
+ - c4.2xlarge
+ - c4.4xlarge
+ - c4.8xlarge
+ - c5.large
+ - c5.xlarge
+ - c5.2xlarge
+ - c5.4xlarge
+ - c5.9xlarge
+ - c5.12xlarge
+ - c5.18xlarge
+ - c5.24xlarge
+ - c5.metal
+ - c5a.large
+ - c5a.xlarge
+ - c5a.2xlarge
+ - c5a.4xlarge
+ - c5a.8xlarge
+ - c5a.12xlarge
+ - c5a.16xlarge
+ - c5a.24xlarge
+ - c5ad.large
+ - c5ad.xlarge
+ - c5ad.2xlarge
+ - c5ad.4xlarge
+ - c5ad.8xlarge
+ - c5ad.12xlarge
+ - c5ad.16xlarge
+ - c5ad.24xlarge
+ - c5d.large
+ - c5d.xlarge
+ - c5d.2xlarge
+ - c5d.4xlarge
+ - c5d.9xlarge
+ - c5d.12xlarge
+ - c5d.18xlarge
+ - c5d.24xlarge
+ - c5d.metal
+ - c5n.large
+ - c5n.xlarge
+ - c5n.2xlarge
+ - c5n.4xlarge
+ - c5n.9xlarge
+ - c5n.18xlarge
+ - c5n.metal
+ - c6g.medium
+ - c6g.large
+ - c6g.xlarge
+ - c6g.2xlarge
+ - c6g.4xlarge
+ - c6g.8xlarge
+ - c6g.12xlarge
+ - c6g.16xlarge
+ - c6g.metal
+ - c6gd.medium
+ - c6gd.large
+ - c6gd.xlarge
+ - c6gd.2xlarge
+ - c6gd.4xlarge
+ - c6gd.8xlarge
+ - c6gd.12xlarge
+ - c6gd.16xlarge
+ - c6gd.metal
+ - c6gn.medium
+ - c6gn.large
+ - c6gn.xlarge
+ - c6gn.2xlarge
+ - c6gn.4xlarge
+ - c6gn.8xlarge
+ - c6gn.12xlarge
+ - c6gn.16xlarge
+ - c6i.large
+ - c6i.xlarge
+ - c6i.2xlarge
+ - c6i.4xlarge
+ - c6i.8xlarge
+ - c6i.12xlarge
+ - c6i.16xlarge
+ - c6i.24xlarge
+ - c6i.32xlarge
+ - c6i.metal
+ - cc1.4xlarge
+ - cc2.8xlarge
+ - cg1.4xlarge
+ - cr1.8xlarge
+ - d2.xlarge
+ - d2.2xlarge
+ - d2.4xlarge
+ - d2.8xlarge
+ - d3.xlarge
+ - d3.2xlarge
+ - d3.4xlarge
+ - d3.8xlarge
+ - d3en.xlarge
+ - d3en.2xlarge
+ - d3en.4xlarge
+ - d3en.6xlarge
+ - d3en.8xlarge
+ - d3en.12xlarge
+ - dl1.24xlarge
+ - f1.2xlarge
+ - f1.4xlarge
+ - f1.16xlarge
+ - g2.2xlarge
+ - g2.8xlarge
+ - g3.4xlarge
+ - g3.8xlarge
+ - g3.16xlarge
+ - g3s.xlarge
+ - g4ad.xlarge
+ - g4ad.2xlarge
+ - g4ad.4xlarge
+ - g4ad.8xlarge
+ - g4ad.16xlarge
+ - g4dn.xlarge
+ - g4dn.2xlarge
+ - g4dn.4xlarge
+ - g4dn.8xlarge
+ - g4dn.12xlarge
+ - g4dn.16xlarge
+ - g4dn.metal
+ - g5.xlarge
+ - g5.2xlarge
+ - g5.4xlarge
+ - g5.8xlarge
+ - g5.12xlarge
+ - g5.16xlarge
+ - g5.24xlarge
+ - g5.48xlarge
+ - g5g.xlarge
+ - g5g.2xlarge
+ - g5g.4xlarge
+ - g5g.8xlarge
+ - g5g.16xlarge
+ - g5g.metal
+ - hi1.4xlarge
+ - hpc6a.48xlarge
+ - hs1.8xlarge
+ - h1.2xlarge
+ - h1.4xlarge
+ - h1.8xlarge
+ - h1.16xlarge
+ - i2.xlarge
+ - i2.2xlarge
+ - i2.4xlarge
+ - i2.8xlarge
+ - i3.large
+ - i3.xlarge
+ - i3.2xlarge
+ - i3.4xlarge
+ - i3.8xlarge
+ - i3.16xlarge
+ - i3.metal
+ - i3en.large
+ - i3en.xlarge
+ - i3en.2xlarge
+ - i3en.3xlarge
+ - i3en.6xlarge
+ - i3en.12xlarge
+ - i3en.24xlarge
+ - i3en.metal
+ - im4gn.large
+ - im4gn.xlarge
+ - im4gn.2xlarge
+ - im4gn.4xlarge
+ - im4gn.8xlarge
+ - im4gn.16xlarge
+ - inf1.xlarge
+ - inf1.2xlarge
+ - inf1.6xlarge
+ - inf1.24xlarge
+ - is4gen.medium
+ - is4gen.large
+ - is4gen.xlarge
+ - is4gen.2xlarge
+ - is4gen.4xlarge
+ - is4gen.8xlarge
+ - m1.small
+ - m1.medium
+ - m1.large
+ - m1.xlarge
+ - m2.xlarge
+ - m2.2xlarge
+ - m2.4xlarge
+ - m3.medium
+ - m3.large
+ - m3.xlarge
+ - m3.2xlarge
+ - m4.large
+ - m4.xlarge
+ - m4.2xlarge
+ - m4.4xlarge
+ - m4.10xlarge
+ - m4.16xlarge
+ - m5.large
+ - m5.xlarge
+ - m5.2xlarge
+ - m5.4xlarge
+ - m5.8xlarge
+ - m5.12xlarge
+ - m5.16xlarge
+ - m5.24xlarge
+ - m5.metal
+ - m5a.large
+ - m5a.xlarge
+ - m5a.2xlarge
+ - m5a.4xlarge
+ - m5a.8xlarge
+ - m5a.12xlarge
+ - m5a.16xlarge
+ - m5a.24xlarge
+ - m5ad.large
+ - m5ad.xlarge
+ - m5ad.2xlarge
+ - m5ad.4xlarge
+ - m5ad.8xlarge
+ - m5ad.12xlarge
+ - m5ad.16xlarge
+ - m5ad.24xlarge
+ - m5d.large
+ - m5d.xlarge
+ - m5d.2xlarge
+ - m5d.4xlarge
+ - m5d.8xlarge
+ - m5d.12xlarge
+ - m5d.16xlarge
+ - m5d.24xlarge
+ - m5d.metal
+ - m5dn.large
+ - m5dn.xlarge
+ - m5dn.2xlarge
+ - m5dn.4xlarge
+ - m5dn.8xlarge
+ - m5dn.12xlarge
+ - m5dn.16xlarge
+ - m5dn.24xlarge
+ - m5dn.metal
+ - m5n.large
+ - m5n.xlarge
+ - m5n.2xlarge
+ - m5n.4xlarge
+ - m5n.8xlarge
+ - m5n.12xlarge
+ - m5n.16xlarge
+ - m5n.24xlarge
+ - m5n.metal
+ - m5zn.large
+ - m5zn.xlarge
+ - m5zn.2xlarge
+ - m5zn.3xlarge
+ - m5zn.6xlarge
+ - m5zn.12xlarge
+ - m5zn.metal
+ - m6a.large
+ - m6a.xlarge
+ - m6a.2xlarge
+ - m6a.4xlarge
+ - m6a.8xlarge
+ - m6a.12xlarge
+ - m6a.16xlarge
+ - m6a.24xlarge
+ - m6a.32xlarge
+ - m6a.48xlarge
+ - m6g.metal
+ - m6g.medium
+ - m6g.large
+ - m6g.xlarge
+ - m6g.2xlarge
+ - m6g.4xlarge
+ - m6g.8xlarge
+ - m6g.12xlarge
+ - m6g.16xlarge
+ - m6gd.metal
+ - m6gd.medium
+ - m6gd.large
+ - m6gd.xlarge
+ - m6gd.2xlarge
+ - m6gd.4xlarge
+ - m6gd.8xlarge
+ - m6gd.12xlarge
+ - m6gd.16xlarge
+ - m6i.large
+ - m6i.xlarge
+ - m6i.2xlarge
+ - m6i.4xlarge
+ - m6i.8xlarge
+ - m6i.12xlarge
+ - m6i.16xlarge
+ - m6i.24xlarge
+ - m6i.32xlarge
+ - m6i.metal
+ - mac1.metal
+ - p2.xlarge
+ - p2.8xlarge
+ - p2.16xlarge
+ - p3.2xlarge
+ - p3.8xlarge
+ - p3.16xlarge
+ - p3dn.24xlarge
+ - p4d.24xlarge
+ - r3.large
+ - r3.xlarge
+ - r3.2xlarge
+ - r3.4xlarge
+ - r3.8xlarge
+ - r4.large
+ - r4.xlarge
+ - r4.2xlarge
+ - r4.4xlarge
+ - r4.8xlarge
+ - r4.16xlarge
+ - r5.large
+ - r5.xlarge
+ - r5.2xlarge
+ - r5.4xlarge
+ - r5.8xlarge
+ - r5.12xlarge
+ - r5.16xlarge
+ - r5.24xlarge
+ - r5.metal
+ - r5a.large
+ - r5a.xlarge
+ - r5a.2xlarge
+ - r5a.4xlarge
+ - r5a.8xlarge
+ - r5a.12xlarge
+ - r5a.16xlarge
+ - r5a.24xlarge
+ - r5ad.large
+ - r5ad.xlarge
+ - r5ad.2xlarge
+ - r5ad.4xlarge
+ - r5ad.8xlarge
+ - r5ad.12xlarge
+ - r5ad.16xlarge
+ - r5ad.24xlarge
+ - r5b.large
+ - r5b.xlarge
+ - r5b.2xlarge
+ - r5b.4xlarge
+ - r5b.8xlarge
+ - r5b.12xlarge
+ - r5b.16xlarge
+ - r5b.24xlarge
+ - r5b.metal
+ - r5d.large
+ - r5d.xlarge
+ - r5d.2xlarge
+ - r5d.4xlarge
+ - r5d.8xlarge
+ - r5d.12xlarge
+ - r5d.16xlarge
+ - r5d.24xlarge
+ - r5d.metal
+ - r5dn.large
+ - r5dn.xlarge
+ - r5dn.2xlarge
+ - r5dn.4xlarge
+ - r5dn.8xlarge
+ - r5dn.12xlarge
+ - r5dn.16xlarge
+ - r5dn.24xlarge
+ - r5dn.metal
+ - r5n.large
+ - r5n.xlarge
+ - r5n.2xlarge
+ - r5n.4xlarge
+ - r5n.8xlarge
+ - r5n.12xlarge
+ - r5n.16xlarge
+ - r5n.24xlarge
+ - r5n.metal
+ - r6g.medium
+ - r6g.large
+ - r6g.xlarge
+ - r6g.2xlarge
+ - r6g.4xlarge
+ - r6g.8xlarge
+ - r6g.12xlarge
+ - r6g.16xlarge
+ - r6g.metal
+ - r6gd.medium
+ - r6gd.large
+ - r6gd.xlarge
+ - r6gd.2xlarge
+ - r6gd.4xlarge
+ - r6gd.8xlarge
+ - r6gd.12xlarge
+ - r6gd.16xlarge
+ - r6gd.metal
+ - r6i.large
+ - r6i.xlarge
+ - r6i.2xlarge
+ - r6i.4xlarge
+ - r6i.8xlarge
+ - r6i.12xlarge
+ - r6i.16xlarge
+ - r6i.24xlarge
+ - r6i.32xlarge
+ - r6i.metal
+ - t1.micro
+ - t2.nano
+ - t2.micro
+ - t2.small
+ - t2.medium
+ - t2.large
+ - t2.xlarge
+ - t2.2xlarge
+ - t3.nano
+ - t3.micro
+ - t3.small
+ - t3.medium
+ - t3.large
+ - t3.xlarge
+ - t3.2xlarge
+ - t3a.nano
+ - t3a.micro
+ - t3a.small
+ - t3a.medium
+ - t3a.large
+ - t3a.xlarge
+ - t3a.2xlarge
+ - t4g.nano
+ - t4g.micro
+ - t4g.small
+ - t4g.medium
+ - t4g.large
+ - t4g.xlarge
+ - t4g.2xlarge
+ - u-6tb1.56xlarge
+ - u-6tb1.112xlarge
+ - u-9tb1.112xlarge
+ - u-12tb1.112xlarge
+ - u-6tb1.metal
+ - u-9tb1.metal
+ - u-12tb1.metal
+ - u-18tb1.metal
+ - u-24tb1.metal
+ - vt1.3xlarge
+ - vt1.6xlarge
+ - vt1.24xlarge
+ - x1.16xlarge
+ - x1.32xlarge
+ - x1e.xlarge
+ - x1e.2xlarge
+ - x1e.4xlarge
+ - x1e.8xlarge
+ - x1e.16xlarge
+ - x1e.32xlarge
+ - x2iezn.2xlarge
+ - x2iezn.4xlarge
+ - x2iezn.6xlarge
+ - x2iezn.8xlarge
+ - x2iezn.12xlarge
+ - x2iezn.metal
+ - x2gd.medium
+ - x2gd.large
+ - x2gd.xlarge
+ - x2gd.2xlarge
+ - x2gd.4xlarge
+ - x2gd.8xlarge
+ - x2gd.12xlarge
+ - x2gd.16xlarge
+ - x2gd.metal
+ - z1d.large
+ - z1d.xlarge
+ - z1d.2xlarge
+ - z1d.3xlarge
+ - z1d.6xlarge
+ - z1d.12xlarge
+ - z1d.metal
+ - x2idn.16xlarge
+ - x2idn.24xlarge
+ - x2idn.32xlarge
+ - x2iedn.xlarge
+ - x2iedn.2xlarge
+ - x2iedn.4xlarge
+ - x2iedn.8xlarge
+ - x2iedn.16xlarge
+ - x2iedn.24xlarge
+ - x2iedn.32xlarge
+ - c6a.large
+ - c6a.xlarge
+ - c6a.2xlarge
+ - c6a.4xlarge
+ - c6a.8xlarge
+ - c6a.12xlarge
+ - c6a.16xlarge
+ - c6a.24xlarge
+ - c6a.32xlarge
+ - c6a.48xlarge
+ - c6a.metal
+ - m6a.metal
+ - i4i.large
+ - i4i.xlarge
+ - i4i.2xlarge
+ - i4i.4xlarge
+ - i4i.8xlarge
+ - i4i.16xlarge
+ - i4i.32xlarge
+ - name: MaxDuration
+ in: query
+ required: false
+ description: 'The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
' + schema: + type: integer + - name: MaxInstanceCount + in: query + required: false + description: 'The maximum number of instances to filter when searching for offerings.
Default: 20
' + schema: + type: integer + - name: MinDuration + in: query + required: false + description: 'The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
' + schema: + type: integer + - name: OfferingClass + in: query + required: false + description: The offering class of the Reserved Instance. Can bestandard or convertible.
+ schema:
+ type: string
+ enum:
+ - standard
+ - convertible
+ - name: ProductDescription
+ in: query
+ required: false
+ description: The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
+ schema:
+ type: string
+ enum:
+ - Linux/UNIX
+ - Linux/UNIX (Amazon VPC)
+ - Windows
+ - Windows (Amazon VPC)
+ - name: ReservedInstancesOfferingId
+ in: query
+ required: false
+ description: One or more Reserved Instances offering IDs.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/ReservedInstancesOfferingId'
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceTenancy
+ in: query
+ required: false
+ description: 'The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.
Default: 100
' + schema: + type: integer + - name: NextToken + in: query + required: false + description: The token to retrieve the next page of results. + schema: + type: string + - name: OfferingType + in: query + required: false + description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to theMedium Utilization Reserved Instance offering type. '
+ schema:
+ type: string
+ enum:
+ - Heavy Utilization
+ - Medium Utilization
+ - Light Utilization
+ - No Upfront
+ - Partial Upfront
+ - All Upfront
+ 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'
+ post:
+ x-aws-operation-name: DescribeReservedInstancesOfferings
+ operationId: POST_DescribeReservedInstancesOfferings
+ description: 'Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReservedInstancesOfferingsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeReservedInstancesOfferingsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeRouteTables&Version=2016-11-15: + get: + x-aws-operation-name: DescribeRouteTables + operationId: GET_DescribeRouteTables + description: 'Describes one or more of your route tables.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeRouteTablesResult' + parameters: + - name: Filter + in: query + required: false + description: 'One or more filters.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.
owner-id - The ID of the Amazon Web Services account that owns the route table.
route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service specified in a route in the table.
route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.transit-gateway-id - The ID of a transit gateway.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route''s target isn''t available (for example, the specified gateway isn''t attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the route table.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: RouteTableId
+ in: query
+ required: false
+ description: 'One or more route table IDs.
Default: Describes all your route tables.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/RouteTableId' + - xml: + name: item + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + type: string + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 100
+ 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'
+ post:
+ x-aws-operation-name: DescribeRouteTables
+ operationId: POST_DescribeRouteTables
+ description: 'Describes one or more of your route tables.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeRouteTablesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeRouteTablesRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeScheduledInstanceAvailability&Version=2016-11-15: + get: + x-aws-operation-name: DescribeScheduledInstanceAvailability + operationId: GET_DescribeScheduledInstanceAvailability + description: 'Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
network-platform - The network platform (EC2-Classic or EC2-VPC).
platform - The platform (Linux/UNIX or Windows).
NextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 300
+ - name: MaxSlotDurationInHours
+ in: query
+ required: false
+ description: 'The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.'
+ schema:
+ type: integer
+ - name: MinSlotDurationInHours
+ in: query
+ required: false
+ description: 'The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next set of results.
+ schema:
+ type: string
+ - name: Recurrence
+ in: query
+ required: true
+ description: The schedule recurrence.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.'
+ OccurrenceDay:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
+ description: Describes the recurring schedule for a Scheduled Instance.
+ 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'
+ post:
+ x-aws-operation-name: DescribeScheduledInstanceAvailability
+ operationId: POST_DescribeScheduledInstanceAvailability
+ description: 'Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeScheduledInstances&Version=2016-11-15: + get: + x-aws-operation-name: DescribeScheduledInstances + operationId: GET_DescribeScheduledInstances + description: Describes the specified Scheduled Instances or all your Scheduled Instances. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeScheduledInstancesResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
network-platform - The network platform (EC2-Classic or EC2-VPC).
platform - The platform (Linux/UNIX or Windows).
NextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next set of results.
+ schema:
+ type: string
+ - name: ScheduledInstanceId
+ in: query
+ required: false
+ description: The Scheduled Instance IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ScheduledInstanceId'
+ - xml:
+ name: ScheduledInstanceId
+ - name: SlotStartTimeRange
+ in: query
+ required: false
+ description: The time period for the first schedule to start.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The latest date and time, in UTC, for the Scheduled Instance to start.'
+ description: Describes the time period for a Scheduled Instance to start its first schedule.
+ 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'
+ post:
+ x-aws-operation-name: DescribeScheduledInstances
+ operationId: POST_DescribeScheduledInstances
+ description: Describes the specified Scheduled Instances or all your Scheduled Instances.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeScheduledInstancesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeScheduledInstancesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeSecurityGroupReferences&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeSecurityGroupReferences
+ operationId: GET_DescribeSecurityGroupReferences
+ description: '[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you''ve specified in this request.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSecurityGroupReferencesResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: GroupId
+ in: query
+ required: true
+ description: The IDs of the security groups in your account.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: DescribeSecurityGroupReferences
+ operationId: POST_DescribeSecurityGroupReferences
+ description: '[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you''ve specified in this request.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSecurityGroupReferencesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSecurityGroupReferencesRequest'
+ parameters: []
+ /?Action=DescribeSecurityGroupRules&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeSecurityGroupRules
+ operationId: GET_DescribeSecurityGroupRules
+ description: Describes one or more of your security group rules.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSecurityGroupRulesResult'
+ parameters:
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
group-id - The ID of the security group.
security-group-rule-id - The ID of the security group rule.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ 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'
+ post:
+ x-aws-operation-name: DescribeSecurityGroupRules
+ operationId: POST_DescribeSecurityGroupRules
+ description: Describes one or more of your security group rules.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSecurityGroupRulesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSecurityGroupRulesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeSecurityGroups&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeSecurityGroups
+ operationId: GET_DescribeSecurityGroups
+ description: 'Describes the specified security groups or all of your security groups.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSecurityGroupsResult' + parameters: + - name: Filter + in: query + required: false + description: 'The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
description - The description of the security group.
egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.
egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.
egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule.
egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an outbound security group rule.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.
ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule.
ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an inbound security group rule.
owner-id - The Amazon Web Services account ID of the owner of the security group.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC specified when the security group was created.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SecurityGroupId' + - xml: + name: groupId + - name: GroupName + in: query + required: false + description: '[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SecurityGroupName' + - xml: + name: GroupName + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to request the next page of results.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ 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'
+ post:
+ x-aws-operation-name: DescribeSecurityGroups
+ operationId: POST_DescribeSecurityGroups
+ description: 'Describes the specified security groups or all of your security groups.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSecurityGroupsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSecurityGroupsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeSnapshotAttribute&Version=2016-11-15: + get: + x-aws-operation-name: DescribeSnapshotAttribute + operationId: GET_DescribeSnapshotAttribute + description: 'Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSnapshotAttributeResult' + parameters: + - name: Attribute + in: query + required: true + description: The snapshot attribute you would like to view. + schema: + type: string + enum: + - productCodes + - createVolumePermission + - name: SnapshotId + in: query + required: true + description: The ID of the EBS snapshot. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeSnapshotAttribute
+ operationId: POST_DescribeSnapshotAttribute
+ description: 'Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSnapshotAttributeResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSnapshotAttributeRequest' + parameters: [] + /?Action=DescribeSnapshotTierStatus&Version=2016-11-15: + get: + x-aws-operation-name: DescribeSnapshotTierStatus + operationId: GET_DescribeSnapshotTierStatus + description: Describes the storage tier status of one or more Amazon EBS snapshots. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSnapshotTierStatusResult' + parameters: + - name: Filter + in: query + required: false + description:The filters.
snapshot-id - The snapshot ID.
volume-id - The ID of the volume the snapshot is for.
last-tiering-operation - The state of the last archive or restore action. (archival-in-progress | archival-completed | archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ 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'
+ post:
+ x-aws-operation-name: DescribeSnapshotTierStatus
+ operationId: POST_DescribeSnapshotTierStatus
+ description: Describes the storage tier status of one or more Amazon EBS snapshots.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSnapshotTierStatusResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSnapshotTierStatusRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeSnapshots&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeSnapshots
+ operationId: GET_DescribeSnapshots
+ description: 'Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSnapshotsResult' + parameters: + - name: Filter + in: query + required: false + description: 'The filters.
description - A description of the snapshot.
encrypted - Indicates whether the snapshot is encrypted (true | false)
owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
storage-tier - The storage tier of the snapshot (archive | standard).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
+ schema:
+ type: string
+ - name: Owner
+ in: query
+ required: false
+ description: 'Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: Owner
+ - name: RestorableBy
+ in: query
+ required: false
+ description: The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/String'
+ - name: SnapshotId
+ in: query
+ required: false
+ description: 'The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SnapshotId' + - xml: + name: SnapshotId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeSnapshots
+ operationId: POST_DescribeSnapshots
+ description: 'Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSnapshotsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSnapshotsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeSpotDatafeedSubscription&Version=2016-11-15: + get: + x-aws-operation-name: DescribeSpotDatafeedSubscription + operationId: GET_DescribeSpotDatafeedSubscription + description: 'Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeSpotDatafeedSubscription
+ operationId: POST_DescribeSpotDatafeedSubscription
+ description: 'Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionRequest'
+ parameters: []
+ /?Action=DescribeSpotFleetInstances&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeSpotFleetInstances
+ operationId: GET_DescribeSpotFleetInstances
+ description: Describes the running instances for the specified Spot Fleet.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSpotFleetInstancesResponse'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next set of results.
+ schema:
+ type: string
+ - name: SpotFleetRequestId
+ in: query
+ required: true
+ description: The ID of the Spot Fleet request.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeSpotFleetInstances
+ operationId: POST_DescribeSpotFleetInstances
+ description: Describes the running instances for the specified Spot Fleet.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSpotFleetInstancesResponse'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeSpotFleetInstancesRequest'
+ parameters: []
+ /?Action=DescribeSpotFleetRequestHistory&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeSpotFleetRequestHistory
+ operationId: GET_DescribeSpotFleetRequestHistory
+ description: 'Describes the events for the specified Spot Fleet request during the specified time.
Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide for Linux Instances.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryResponse' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: EventType
+ in: query
+ required: false
+ description: 'The type of events to describe. By default, all events are described.'
+ schema:
+ type: string
+ enum:
+ - instanceChange
+ - fleetRequestChange
+ - error
+ - information
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next set of results.
+ schema:
+ type: string
+ - name: SpotFleetRequestId
+ in: query
+ required: true
+ description: The ID of the Spot Fleet request.
+ schema:
+ type: string
+ - name: StartTime
+ in: query
+ required: true
+ description: 'The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ schema:
+ type: string
+ format: date-time
+ 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'
+ post:
+ x-aws-operation-name: DescribeSpotFleetRequestHistory
+ operationId: POST_DescribeSpotFleetRequestHistory
+ description: 'Describes the events for the specified Spot Fleet request during the specified time.
Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide for Linux Instances.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryResponse' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryRequest' + parameters: [] + /?Action=DescribeSpotFleetRequests&Version=2016-11-15: + get: + x-aws-operation-name: DescribeSpotFleetRequests + operationId: GET_DescribeSpotFleetRequests + description:Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotFleetRequestsResponse' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next set of results.
+ schema:
+ type: string
+ - name: SpotFleetRequestId
+ in: query
+ required: false
+ description: The IDs of the Spot Fleet requests.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetRequestId'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: DescribeSpotFleetRequests
+ operationId: POST_DescribeSpotFleetRequests
+ description: Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotFleetRequestsResponse' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotFleetRequestsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeSpotInstanceRequests&Version=2016-11-15: + get: + x-aws-operation-name: DescribeSpotInstanceRequests + operationId: GET_DescribeSpotInstanceRequests + description: 'Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotInstanceRequestsResult' + parameters: + - name: Filter + in: query + required: false + description: 'One or more filters.
availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.
launch.group-id - The ID of the security group for the instance.
launch.group-name - The name of the security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m3.medium).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
launched-availability-zone - The Availability Zone in which the request is launched.
network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
network-interface.description - A description of the network interface.
network-interface.device-index - The index of the device for the network interface attachment on the instance.
network-interface.group-id - The ID of the security group associated with the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.private-ip-address - The primary private IP address of the network interface.
network-interface.subnet-id - The ID of the subnet for the instance.
product-description - The product description associated with the instance (Linux/UNIX | Windows).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of Spot Instance request (one-time | persistent).
valid-from - The start date of the request.
valid-until - The end date of the request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: SpotInstanceRequestId
+ in: query
+ required: false
+ description: One or more Spot Instance request IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SpotInstanceRequestId'
+ - xml:
+ name: SpotInstanceRequestId
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to request the next set of results. This value is null when there are no more results to return.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ schema:
+ type: integer
+ 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'
+ post:
+ x-aws-operation-name: DescribeSpotInstanceRequests
+ operationId: POST_DescribeSpotInstanceRequests
+ description: 'Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotInstanceRequestsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotInstanceRequestsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeSpotPriceHistory&Version=2016-11-15: + get: + x-aws-operation-name: DescribeSpotPriceHistory + operationId: GET_DescribeSpotPriceHistory + description: 'Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.
When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotPriceHistoryResult' + parameters: + - name: Filter + in: query + required: false + description: 'One or more filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m3.medium).
product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: EndTime
+ in: query
+ required: false
+ description: 'The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ schema:
+ type: string
+ format: date-time
+ - name: InstanceType
+ in: query
+ required: false
+ description: Filters the results by the specified instance types.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/InstanceType'
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next set of results.
+ schema:
+ type: string
+ - name: ProductDescription
+ in: query
+ required: false
+ description: Filters the results by the specified basic product descriptions.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/String'
+ - name: StartTime
+ in: query
+ required: false
+ description: 'The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ schema:
+ type: string
+ format: date-time
+ 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'
+ post:
+ x-aws-operation-name: DescribeSpotPriceHistory
+ operationId: POST_DescribeSpotPriceHistory
+ description: 'Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.
When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotPriceHistoryResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSpotPriceHistoryRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeStaleSecurityGroups&Version=2016-11-15: + get: + x-aws-operation-name: DescribeStaleSecurityGroups + operationId: GET_DescribeStaleSecurityGroups + description: '[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, or if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeStaleSecurityGroupsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 255
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next set of items to return. (You received this token from a prior call.)
+ schema:
+ type: string
+ minLength: 1
+ maxLength: 1024
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeStaleSecurityGroups
+ operationId: POST_DescribeStaleSecurityGroups
+ description: '[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, or if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeStaleSecurityGroupsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeStaleSecurityGroupsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeStoreImageTasks&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeStoreImageTasks
+ operationId: GET_DescribeStoreImageTasks
+ description: 'Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don''t specify the AMIs, you get a paginated list of store tasks from the last 31 days.
For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeStoreImageTasksResult' + parameters: + - name: ImageId + in: query + required: false + description: The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/ImageId' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'The filters.
task-state - Returns tasks in a certain state (InProgress | Completed | Failed)
bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.
NextToken value. This value can be between 1 and 200. You cannot specify this parameter and the ImageIDs parameter in the same call.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 200
+ 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'
+ post:
+ x-aws-operation-name: DescribeStoreImageTasks
+ operationId: POST_DescribeStoreImageTasks
+ description: 'Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don''t specify the AMIs, you get a paginated list of store tasks from the last 31 days.
For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeStoreImageTasksResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeStoreImageTasksRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeSubnets&Version=2016-11-15: + get: + x-aws-operation-name: DescribeSubnets + operationId: GET_DescribeSubnets + description: 'Describes one or more of your subnets.
For more information, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSubnetsResult' + parameters: + - name: Filter + in: query + required: false + description: 'One or more filters.
availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.
availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.
available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet''s CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.
default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the subnet.
state - The state of the subnet (pending | available).
subnet-arn - The Amazon Resource Name (ARN) of the subnet.
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the subnet.
One or more subnet IDs.
Default: Describes all your subnets.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SubnetId' + - xml: + name: SubnetId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ 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'
+ post:
+ x-aws-operation-name: DescribeSubnets
+ operationId: POST_DescribeSubnets
+ description: 'Describes one or more of your subnets.
For more information, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSubnetsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeSubnetsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeTags&Version=2016-11-15: + get: + x-aws-operation-name: DescribeTags + operationId: GET_DescribeTags + description: 'Describes the specified tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeTagsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.
NextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to retrieve the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeTags
+ operationId: POST_DescribeTags
+ description: 'Describes the specified tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeTagsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeTagsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeTrafficMirrorFilters&Version=2016-11-15: + get: + x-aws-operation-name: DescribeTrafficMirrorFilters + operationId: GET_DescribeTrafficMirrorFilters + description: Describes one or more Traffic Mirror filters. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeTrafficMirrorFiltersResult' + parameters: + - name: TrafficMirrorFilterId + in: query + required: false + description: The ID of the Traffic Mirror filter. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TrafficMirrorFilterId' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
description: The Traffic Mirror filter description.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeTrafficMirrorFilters
+ operationId: POST_DescribeTrafficMirrorFilters
+ description: Describes one or more Traffic Mirror filters.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTrafficMirrorFiltersResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTrafficMirrorFiltersRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeTrafficMirrorSessions&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeTrafficMirrorSessions
+ operationId: GET_DescribeTrafficMirrorSessions
+ description: 'Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTrafficMirrorSessionsResult'
+ parameters:
+ - name: TrafficMirrorSessionId
+ in: query
+ required: false
+ description: The ID of the Traffic Mirror session.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorSessionId'
+ - xml:
+ name: item
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
description: The Traffic Mirror session description.
network-interface-id: The ID of the Traffic Mirror session network interface.
owner-id: The ID of the account that owns the Traffic Mirror session.
packet-length: The assigned number of packets to mirror.
session-number: The assigned session number.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
traffic-mirror-session-id: The ID of the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
virtual-network-id: The virtual network ID of the Traffic Mirror session.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeTrafficMirrorSessions
+ operationId: POST_DescribeTrafficMirrorSessions
+ description: 'Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTrafficMirrorSessionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTrafficMirrorSessionsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeTrafficMirrorTargets&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeTrafficMirrorTargets
+ operationId: GET_DescribeTrafficMirrorTargets
+ description: Information about one or more Traffic Mirror targets.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTrafficMirrorTargetsResult'
+ parameters:
+ - name: TrafficMirrorTargetId
+ in: query
+ required: false
+ description: The ID of the Traffic Mirror targets.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorTargetId'
+ - xml:
+ name: item
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
description: The Traffic Mirror target description.
network-interface-id: The ID of the Traffic Mirror session network interface.
network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.
owner-id: The ID of the account that owns the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeTrafficMirrorTargets
+ operationId: POST_DescribeTrafficMirrorTargets
+ description: Information about one or more Traffic Mirror targets.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTrafficMirrorTargetsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTrafficMirrorTargetsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeTransitGatewayAttachments&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeTransitGatewayAttachments
+ operationId: GET_DescribeTransitGatewayAttachments
+ description: 'Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayAttachmentsResult'
+ parameters:
+ - name: TransitGatewayAttachmentIds
+ in: query
+ required: false
+ description: The IDs of the attachments.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/TransitGatewayAttachmentId'
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
association.state - The state of the association (associating | associated | disassociating).
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
resource-id - The ID of the resource.
resource-owner-id - The ID of the Amazon Web Services account that owns the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeTransitGatewayAttachments
+ operationId: POST_DescribeTransitGatewayAttachments
+ description: 'Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayAttachmentsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayAttachmentsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeTransitGatewayConnectPeers&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeTransitGatewayConnectPeers
+ operationId: GET_DescribeTransitGatewayConnectPeers
+ description: Describes one or more Connect peers.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayConnectPeersResult'
+ parameters:
+ - name: TransitGatewayConnectPeerIds
+ in: query
+ required: false
+ description: The IDs of the Connect peers.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnectPeerId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
state - The state of the Connect peer (pending | available | deleting | deleted).
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-connect-peer-id - The ID of the Connect peer.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeTransitGatewayConnectPeers
+ operationId: POST_DescribeTransitGatewayConnectPeers
+ description: Describes one or more Connect peers.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayConnectPeersResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayConnectPeersRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeTransitGatewayConnects&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeTransitGatewayConnects
+ operationId: GET_DescribeTransitGatewayConnects
+ description: Describes one or more Connect attachments.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayConnectsResult'
+ parameters:
+ - name: TransitGatewayAttachmentIds
+ in: query
+ required: false
+ description: The IDs of the attachments.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/TransitGatewayAttachmentId'
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
options.protocol - The tunnel protocol (gre).
state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).
transit-gateway-attachment-id - The ID of the Connect attachment.
transit-gateway-id - The ID of the transit gateway.
transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeTransitGatewayConnects
+ operationId: POST_DescribeTransitGatewayConnects
+ description: Describes one or more Connect attachments.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayConnectsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayConnectsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeTransitGatewayMulticastDomains&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeTransitGatewayMulticastDomains
+ operationId: GET_DescribeTransitGatewayMulticastDomains
+ description: Describes one or more transit gateway multicast domains.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsResult'
+ parameters:
+ - name: TransitGatewayMulticastDomainIds
+ in: query
+ required: false
+ description: The ID of the transit gateway multicast domain.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeTransitGatewayMulticastDomains
+ operationId: POST_DescribeTransitGatewayMulticastDomains
+ description: Describes one or more transit gateway multicast domains.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeTransitGatewayPeeringAttachments&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeTransitGatewayPeeringAttachments
+ operationId: GET_DescribeTransitGatewayPeeringAttachments
+ description: Describes your transit gateway peering attachments.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsResult'
+ parameters:
+ - name: TransitGatewayAttachmentIds
+ in: query
+ required: false
+ description: One or more IDs of the transit gateway peering attachments.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/TransitGatewayAttachmentId'
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
transit-gateway-attachment-id - The ID of the transit gateway attachment.
local-owner-id - The ID of your Amazon Web Services account.
remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
transit-gateway-id - The ID of the transit gateway.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeTransitGatewayPeeringAttachments
+ operationId: POST_DescribeTransitGatewayPeeringAttachments
+ description: Describes your transit gateway peering attachments.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeTransitGatewayRouteTables&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeTransitGatewayRouteTables
+ operationId: GET_DescribeTransitGatewayRouteTables
+ description: 'Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayRouteTablesResult'
+ parameters:
+ - name: TransitGatewayRouteTableIds
+ in: query
+ required: false
+ description: The IDs of the transit gateway route tables.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false).
default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false).
state - The state of the route table (available | deleting | deleted | pending).
transit-gateway-id - The ID of the transit gateway.
transit-gateway-route-table-id - The ID of the transit gateway route table.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeTransitGatewayRouteTables
+ operationId: POST_DescribeTransitGatewayRouteTables
+ description: 'Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayRouteTablesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayRouteTablesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeTransitGatewayVpcAttachments&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeTransitGatewayVpcAttachments
+ operationId: GET_DescribeTransitGatewayVpcAttachments
+ description: 'Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsResult'
+ parameters:
+ - name: TransitGatewayAttachmentIds
+ in: query
+ required: false
+ description: The IDs of the attachments.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/TransitGatewayAttachmentId'
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
vpc-id - The ID of the VPC.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeTransitGatewayVpcAttachments
+ operationId: POST_DescribeTransitGatewayVpcAttachments
+ description: 'Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeTransitGateways&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeTransitGateways
+ operationId: GET_DescribeTransitGateways
+ description: 'Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewaysResult'
+ parameters:
+ - name: TransitGatewayIds
+ in: query
+ required: false
+ description: The IDs of the transit gateways.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeTransitGateways
+ operationId: POST_DescribeTransitGateways
+ description: 'Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewaysResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeTransitGatewaysRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeTrunkInterfaceAssociations&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeTrunkInterfaceAssociations
+ operationId: GET_DescribeTrunkInterfaceAssociations
+ description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Describes one or more network interface trunk associations.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsResult' + parameters: + - name: AssociationId + in: query + required: false + description: The IDs of the associations. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TrunkInterfaceAssociationId' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
gre-key - The ID of a trunk interface association.
interface-protocol - The interface protocol. Valid values are VLAN and GRE.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 255
+ 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'
+ post:
+ x-aws-operation-name: DescribeTrunkInterfaceAssociations
+ operationId: POST_DescribeTrunkInterfaceAssociations
+ description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Describes one or more network interface trunk associations.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeVolumeAttribute&Version=2016-11-15: + get: + x-aws-operation-name: DescribeVolumeAttribute + operationId: GET_DescribeVolumeAttribute + description: 'Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVolumeAttributeResult' + parameters: + - name: Attribute + in: query + required: true + description: The attribute of the volume. This parameter is required. + schema: + type: string + enum: + - autoEnableIO + - productCodes + - name: VolumeId + in: query + required: true + description: The ID of the volume. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeVolumeAttribute
+ operationId: POST_DescribeVolumeAttribute
+ description: 'Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVolumeAttributeResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVolumeAttributeRequest' + parameters: [] + /?Action=DescribeVolumeStatus&Version=2016-11-15: + get: + x-aws-operation-name: DescribeVolumeStatus + operationId: GET_DescribeVolumeStatus + description: 'Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume''s underlying host. If the volume''s underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitor the status of your volumes in the Amazon Elastic Compute Cloud User Guide.
Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.
Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)
The filters.
action.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: 'The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.'
+ schema:
+ type: string
+ - name: VolumeId
+ in: query
+ required: false
+ description: 'The IDs of the volumes.
Default: Describes all your volumes.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/VolumeId' + - xml: + name: VolumeId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeVolumeStatus
+ operationId: POST_DescribeVolumeStatus
+ description: 'Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume''s underlying host. If the volume''s underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitor the status of your volumes in the Amazon Elastic Compute Cloud User Guide.
Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.
Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVolumesResult' + parameters: + - name: Filter + in: query + required: false + description: 'The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true | false)
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available | in-use | deleting | deleted | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeVolumes
+ operationId: POST_DescribeVolumes
+ description: 'Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVolumesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVolumesRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeVolumesModifications&Version=2016-11-15: + get: + x-aws-operation-name: DescribeVolumesModifications + operationId: GET_DescribeVolumesModifications + description: 'Describes the most recent volume modification request for the specified EBS volumes.
If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.
You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVolumesModificationsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VolumeId
+ in: query
+ required: false
+ description: The IDs of the volumes.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VolumeId'
+ - xml:
+ name: VolumeId
+ - name: Filter
+ in: query
+ required: false
+ description: 'The filters.
modification-state - The current modification state (modifying | optimizing | completed | failed).
original-iops - The original IOPS rate of the volume.
original-size - The original size of the volume, in GiB.
original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
start-time - The modification start time.
target-iops - The target IOPS rate of the volume.
target-size - The target size of the volume, in GiB.
target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
volume-id - The ID of the volume.
nextToken value returned by a previous paginated request.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of results (up to a limit of 500) to be returned in a paginated request.
+ schema:
+ type: integer
+ 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'
+ post:
+ x-aws-operation-name: DescribeVolumesModifications
+ operationId: POST_DescribeVolumesModifications
+ description: 'Describes the most recent volume modification request for the specified EBS volumes.
If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.
You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVolumesModificationsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVolumesModificationsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeVpcAttribute&Version=2016-11-15: + get: + x-aws-operation-name: DescribeVpcAttribute + operationId: GET_DescribeVpcAttribute + description: Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVpcAttributeResult' + parameters: + - name: Attribute + in: query + required: true + description: The VPC attribute. + schema: + type: string + enum: + - enableDnsSupport + - enableDnsHostnames + - name: VpcId + in: query + required: true + description: The ID of the VPC. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeVpcAttribute
+ operationId: POST_DescribeVpcAttribute
+ description: Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcAttributeResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcAttributeRequest'
+ parameters: []
+ /?Action=DescribeVpcClassicLink&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeVpcClassicLink
+ operationId: GET_DescribeVpcClassicLink
+ description: Describes the ClassicLink status of one or more VPCs.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcClassicLinkResult'
+ parameters:
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcId
+ in: query
+ required: false
+ description: One or more VPCs for which you want to describe the ClassicLink status.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - xml:
+ name: VpcId
+ 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'
+ post:
+ x-aws-operation-name: DescribeVpcClassicLink
+ operationId: POST_DescribeVpcClassicLink
+ description: Describes the ClassicLink status of one or more VPCs.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcClassicLinkResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcClassicLinkRequest'
+ parameters: []
+ /?Action=DescribeVpcClassicLinkDnsSupport&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeVpcClassicLinkDnsSupport
+ operationId: GET_DescribeVpcClassicLinkDnsSupport
+ description: 'Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it''s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportResult'
+ parameters:
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 255
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ minLength: 1
+ maxLength: 1024
+ - name: VpcIds
+ in: query
+ required: false
+ description: One or more VPC IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - xml:
+ name: VpcId
+ 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'
+ post:
+ x-aws-operation-name: DescribeVpcClassicLinkDnsSupport
+ operationId: POST_DescribeVpcClassicLinkDnsSupport
+ description: 'Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it''s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeVpcEndpointConnectionNotifications&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeVpcEndpointConnectionNotifications
+ operationId: GET_DescribeVpcEndpointConnectionNotifications
+ description: Describes the connection notifications for VPC endpoints and VPC endpoint services.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ConnectionNotificationId
+ in: query
+ required: false
+ description: The ID of the notification.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
connection-notification-arn - The ARN of the SNS topic for the notification.
connection-notification-id - The ID of the notification.
connection-notification-state - The state of the notification (Enabled | Disabled).
connection-notification-type - The type of notification (Topic).
service-id - The ID of the endpoint service.
vpc-endpoint-id - The ID of the VPC endpoint.
NextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to request the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeVpcEndpointConnectionNotifications
+ operationId: POST_DescribeVpcEndpointConnectionNotifications
+ description: Describes the connection notifications for VPC endpoints and VPC endpoint services.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeVpcEndpointConnections&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeVpcEndpointConnections
+ operationId: GET_DescribeVpcEndpointConnections
+ description: 'Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcEndpointConnectionsResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-id - The ID of the service.
vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-id - The ID of the endpoint.
NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to retrieve the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeVpcEndpointConnections
+ operationId: POST_DescribeVpcEndpointConnections
+ description: 'Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcEndpointConnectionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcEndpointConnectionsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeVpcEndpointServiceConfigurations&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeVpcEndpointServiceConfigurations
+ operationId: GET_DescribeVpcEndpointServiceConfigurations
+ description: Describes the VPC endpoint service configurations in your account (your services).
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ServiceId
+ in: query
+ required: false
+ description: The IDs of one or more services.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointServiceId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
service-name - The name of the service.
service-id - The ID of the service.
service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to retrieve the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeVpcEndpointServiceConfigurations
+ operationId: POST_DescribeVpcEndpointServiceConfigurations
+ description: Describes the VPC endpoint service configurations in your account (your services).
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeVpcEndpointServicePermissions&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeVpcEndpointServicePermissions
+ operationId: GET_DescribeVpcEndpointServicePermissions
+ description: Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ServiceId
+ in: query
+ required: true
+ description: The ID of the service.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
principal - The ARN of the principal.
principal-type - The principal type (All | Service | OrganizationUnit | Account | User | Role).
NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to retrieve the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DescribeVpcEndpointServicePermissions
+ operationId: POST_DescribeVpcEndpointServicePermissions
+ description: Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeVpcEndpointServices&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeVpcEndpointServices
+ operationId: GET_DescribeVpcEndpointServices
+ description: 'Describes available services to which you can create a VPC endpoint.
When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses us-east-1a and us-east-1c and the consumer uses us-east-1a and us-east-1b, the response includes the VPC endpoint services in the common Availability Zone, us-east-1a.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ServiceName
+ in: query
+ required: false
+ description: One or more service names.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
service-name - The name of the service.
service-type - The type of service (Interface | Gateway).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
' + schema: + type: integer + - name: NextToken + in: query + required: false + description: The token for the next set of items to return. (You received this token from a prior call.) + schema: + type: string + 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' + post: + x-aws-operation-name: DescribeVpcEndpointServices + operationId: POST_DescribeVpcEndpointServices + description: 'Describes available services to which you can create a VPC endpoint.
When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses us-east-1a and us-east-1c and the consumer uses us-east-1a and us-east-1b, the response includes the VPC endpoint services in the common Availability Zone, us-east-1a.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcEndpointId
+ in: query
+ required: false
+ description: One or more endpoint IDs.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointId'
+ - xml:
+ name: item
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-name - The name of the service.
vpc-id - The ID of the VPC in which the endpoint resides.
vpc-endpoint-id - The ID of the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
' + schema: + type: integer + - name: NextToken + in: query + required: false + description: The token for the next set of items to return. (You received this token from a prior call.) + schema: + type: string + 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' + post: + x-aws-operation-name: DescribeVpcEndpoints + operationId: POST_DescribeVpcEndpoints + description: Describes one or more of your VPC endpoints. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVpcEndpointsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVpcEndpointsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=DescribeVpcPeeringConnections&Version=2016-11-15: + get: + x-aws-operation-name: DescribeVpcPeeringConnections + operationId: GET_DescribeVpcPeeringConnections + description: Describes one or more of your VPC peering connections. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVpcPeeringConnectionsResult' + parameters: + - name: Filter + in: query + required: false + description: 'One or more filters.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester''s VPC.
requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-peering-connection-id - The ID of the VPC peering connection.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcPeeringConnectionId
+ in: query
+ required: false
+ description: 'One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/VpcPeeringConnectionId' + - xml: + name: item + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + type: string + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ 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'
+ post:
+ x-aws-operation-name: DescribeVpcPeeringConnections
+ operationId: POST_DescribeVpcPeeringConnections
+ description: Describes one or more of your VPC peering connections.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcPeeringConnectionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcPeeringConnectionsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeVpcs&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeVpcs
+ operationId: GET_DescribeVpcs
+ description: Describes one or more of your VPCs.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcsResult'
+ parameters:
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters.
cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC''s CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
is-default - Indicates whether the VPC is the default VPC.
owner-id - The ID of the Amazon Web Services account that owns the VPC.
state - The state of the VPC (pending | available).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC.
One or more VPC IDs.
Default: Describes all your VPCs.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/VpcId' + - xml: + name: VpcId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ 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'
+ post:
+ x-aws-operation-name: DescribeVpcs
+ operationId: POST_DescribeVpcs
+ description: Describes one or more of your VPCs.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DescribeVpcsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=DescribeVpnConnections&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DescribeVpnConnections
+ operationId: GET_DescribeVpnConnections
+ description: 'Describes one or more of your VPN connections.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVpnConnectionsResult' + parameters: + - name: Filter + in: query + required: false + description: 'One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
One or more VPN connection IDs.
Default: Describes your VPN connections.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/VpnConnectionId' + - xml: + name: VpnConnectionId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeVpnConnections
+ operationId: POST_DescribeVpnConnections
+ description: 'Describes one or more of your VPN connections.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVpnConnectionsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVpnConnectionsRequest' + parameters: [] + /?Action=DescribeVpnGateways&Version=2016-11-15: + get: + x-aws-operation-name: DescribeVpnGateways + operationId: GET_DescribeVpnGateways + description: 'Describes one or more of your virtual private gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVpnGatewaysResult' + parameters: + - name: Filter + in: query + required: false + description: 'One or more filters.
amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway (if applicable).
state - The state of the virtual private gateway (pending | available | deleting | deleted).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/VpnGatewayId' + - xml: + name: VpnGatewayId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DescribeVpnGateways
+ operationId: POST_DescribeVpnGateways
+ description: 'Describes one or more of your virtual private gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVpnGatewaysResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DescribeVpnGatewaysRequest' + parameters: [] + /?Action=DetachClassicLinkVpc&Version=2016-11-15: + get: + x-aws-operation-name: DetachClassicLinkVpc + operationId: GET_DetachClassicLinkVpc + description: 'Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it''s stopped.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DetachClassicLinkVpcResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance to unlink from the VPC.
+ schema:
+ type: string
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC to which the instance is linked.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DetachClassicLinkVpc
+ operationId: POST_DetachClassicLinkVpc
+ description: 'Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it''s stopped.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DetachClassicLinkVpcResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DetachClassicLinkVpcRequest'
+ parameters: []
+ /?Action=DetachInternetGateway&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DetachInternetGateway
+ operationId: GET_DetachInternetGateway
+ description: 'Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.'
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InternetGatewayId
+ in: query
+ required: true
+ description: The ID of the internet gateway.
+ schema:
+ type: string
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DetachInternetGateway
+ operationId: POST_DetachInternetGateway
+ description: 'Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.'
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DetachInternetGatewayRequest'
+ parameters: []
+ /?Action=DetachNetworkInterface&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DetachNetworkInterface
+ operationId: GET_DetachNetworkInterface
+ description: Detaches a network interface from an instance.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: AttachmentId
+ in: query
+ required: true
+ description: The ID of the attachment.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Force
+ in: query
+ required: false
+ description: 'Specifies whether to force a detachment.
Use the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.
Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can''t be detached while the instance is running. To detach the root volume, stop the instance first.
When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
For more information, see Detach an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/VolumeAttachment' + parameters: + - name: Device + in: query + required: false + description: The device name. + schema: + type: string + - name: Force + in: query + required: false + description: 'Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won''t have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.' + schema: + type: boolean + - name: InstanceId + in: query + required: false + description: 'The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.' + schema: + type: string + - name: VolumeId + in: query + required: true + description: The ID of the volume. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DetachVolume
+ operationId: POST_DetachVolume
+ description: 'Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can''t be detached while the instance is running. To detach the root volume, stop the instance first.
When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
For more information, see Detach an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/VolumeAttachment' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DetachVolumeRequest' + parameters: [] + /?Action=DetachVpnGateway&Version=2016-11-15: + get: + x-aws-operation-name: DetachVpnGateway + operationId: GET_DetachVpnGateway + description:Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).
You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DetachVpnGateway
+ operationId: POST_DetachVpnGateway
+ description: Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).
You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.
Disables EBS encryption by default for your account in the current Region.
After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.
Disabling encryption by default does not change the encryption status of your existing volumes.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisableEbsEncryptionByDefaultResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisableEbsEncryptionByDefault
+ operationId: POST_DisableEbsEncryptionByDefault
+ description: 'Disables EBS encryption by default for your account in the current Region.
After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.
Disabling encryption by default does not change the encryption status of your existing volumes.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisableEbsEncryptionByDefaultResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DisableEbsEncryptionByDefaultRequest' + parameters: [] + /?Action=DisableFastLaunch&Version=2016-11-15: + get: + x-aws-operation-name: DisableFastLaunch + operationId: GET_DisableFastLaunch + description: 'Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. When you disable faster launching, the AMI uses the standard launch process for each instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.
To change these settings, you must own the AMI.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisableFastLaunch
+ operationId: POST_DisableFastLaunch
+ description: 'Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. When you disable faster launching, the AMI uses the standard launch process for each instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.
To change these settings, you must own the AMI.
us-east-2a.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: AvailabilityZone
+ - name: SourceSnapshotId
+ in: query
+ required: true
+ description: 'The IDs of one or more snapshots. For example, snap-1234567890abcdef0.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotId'
+ - xml:
+ name: SnapshotId
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisableFastSnapshotRestores
+ operationId: POST_DisableFastSnapshotRestores
+ description: Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableFastSnapshotRestoresResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableFastSnapshotRestoresRequest'
+ parameters: []
+ /?Action=DisableImageDeprecation&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DisableImageDeprecation
+ operationId: GET_DisableImageDeprecation
+ description: 'Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisableImageDeprecationResult' + parameters: + - name: ImageId + in: query + required: true + description: The ID of the AMI. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisableImageDeprecation
+ operationId: POST_DisableImageDeprecation
+ description: 'Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisableImageDeprecationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DisableImageDeprecationRequest' + parameters: [] + /?Action=DisableIpamOrganizationAdminAccount&Version=2016-11-15: + get: + x-aws-operation-name: DisableIpamOrganizationAdminAccount + operationId: GET_DisableIpamOrganizationAdminAccount + description: 'Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. ' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisableIpamOrganizationAdminAccountResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: DelegatedAdminAccountId
+ in: query
+ required: true
+ description: The Organizations member account ID that you want to disable as IPAM account.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DisableIpamOrganizationAdminAccount
+ operationId: POST_DisableIpamOrganizationAdminAccount
+ description: 'Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. '
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableIpamOrganizationAdminAccountResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableIpamOrganizationAdminAccountRequest'
+ parameters: []
+ /?Action=DisableSerialConsoleAccess&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DisableSerialConsoleAccess
+ operationId: GET_DisableSerialConsoleAccess
+ description: 'Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableSerialConsoleAccessResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisableSerialConsoleAccess
+ operationId: POST_DisableSerialConsoleAccess
+ description: 'Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableSerialConsoleAccessResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableSerialConsoleAccessRequest'
+ parameters: []
+ /?Action=DisableTransitGatewayRouteTablePropagation&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DisableTransitGatewayRouteTablePropagation
+ operationId: GET_DisableTransitGatewayRouteTablePropagation
+ description: Disables the specified resource attachment from propagating routes to the specified propagation route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationResult'
+ parameters:
+ - name: TransitGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the propagation route table.
+ schema:
+ type: string
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: true
+ description: The ID of the attachment.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisableTransitGatewayRouteTablePropagation
+ operationId: POST_DisableTransitGatewayRouteTablePropagation
+ description: Disables the specified resource attachment from propagating routes to the specified propagation route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationRequest'
+ parameters: []
+ /?Action=DisableVgwRoutePropagation&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DisableVgwRoutePropagation
+ operationId: GET_DisableVgwRoutePropagation
+ description: Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: GatewayId
+ in: query
+ required: true
+ description: The ID of the virtual private gateway.
+ schema:
+ type: string
+ - name: RouteTableId
+ in: query
+ required: true
+ description: The ID of the route table.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisableVgwRoutePropagation
+ operationId: POST_DisableVgwRoutePropagation
+ description: Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableVgwRoutePropagationRequest'
+ parameters: []
+ /?Action=DisableVpcClassicLink&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DisableVpcClassicLink
+ operationId: GET_DisableVpcClassicLink
+ description: Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableVpcClassicLinkResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: DisableVpcClassicLink
+ operationId: POST_DisableVpcClassicLink
+ description: Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableVpcClassicLinkResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisableVpcClassicLinkRequest'
+ parameters: []
+ /?Action=DisableVpcClassicLinkDnsSupport&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DisableVpcClassicLinkDnsSupport
+ operationId: GET_DisableVpcClassicLinkDnsSupport
+ description: 'Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it''s linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
You must specify a VPC ID in the request.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportResult' + parameters: + - name: VpcId + in: query + required: false + description: The ID of the VPC. + schema: + type: string + 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' + post: + x-aws-operation-name: DisableVpcClassicLinkDnsSupport + operationId: POST_DisableVpcClassicLinkDnsSupport + description: 'Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it''s linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
You must specify a VPC ID in the request.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportRequest' + parameters: [] + /?Action=DisassociateAddress&Version=2016-11-15: + get: + x-aws-operation-name: DisassociateAddress + operationId: GET_DisassociateAddress + description: 'Disassociates an Elastic IP address from the instance or network interface it''s associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.
' + responses: + '200': + description: Success + parameters: + - name: AssociationId + in: query + required: false + description: '[EC2-VPC] The association ID. Required for EC2-VPC.' + schema: + type: string + - name: PublicIp + in: query + required: false + description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisassociateAddress
+ operationId: POST_DisassociateAddress
+ description: 'Disassociates an Elastic IP address from the instance or network interface it''s associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateAddressRequest' + parameters: [] + /?Action=DisassociateClientVpnTargetNetwork&Version=2016-11-15: + get: + x-aws-operation-name: DisassociateClientVpnTargetNetwork + operationId: GET_DisassociateClientVpnTargetNetwork + description: 'Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:
The route that was automatically added for the VPC is deleted
All active client connections are terminated
New client connections are disallowed
The Client VPN endpoint''s status changes to pending-associate
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisassociateClientVpnTargetNetwork
+ operationId: POST_DisassociateClientVpnTargetNetwork
+ description: 'Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:
The route that was automatically added for the VPC is deleted
All active client connections are terminated
New client connections are disallowed
The Client VPN endpoint''s status changes to pending-associate
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisassociateEnclaveCertificateIamRole
+ operationId: POST_DisassociateEnclaveCertificateIamRole
+ description: 'Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role''s permission to use the KMS key used to encrypt the private key. This effectively revokes the role''s permission to use the certificate.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisassociateEnclaveCertificateIamRoleResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisassociateEnclaveCertificateIamRoleRequest'
+ parameters: []
+ /?Action=DisassociateIamInstanceProfile&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DisassociateIamInstanceProfile
+ operationId: GET_DisassociateIamInstanceProfile
+ description: Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateIamInstanceProfileResult' + parameters: + - name: AssociationId + in: query + required: true + description: The ID of the IAM instance profile association. + schema: + type: string + 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' + post: + x-aws-operation-name: DisassociateIamInstanceProfile + operationId: POST_DisassociateIamInstanceProfile + description:Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateIamInstanceProfileResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateIamInstanceProfileRequest' + parameters: [] + /?Action=DisassociateInstanceEventWindow&Version=2016-11-15: + get: + x-aws-operation-name: DisassociateInstanceEventWindow + operationId: GET_DisassociateInstanceEventWindow + description: 'Disassociates one or more targets from an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateInstanceEventWindowResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceEventWindowId
+ in: query
+ required: true
+ description: The ID of the event window.
+ schema:
+ type: string
+ - name: AssociationTarget
+ in: query
+ required: true
+ description: One or more targets to disassociate from the specified event window.
+ schema:
+ type: object
+ properties:
+ InstanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdList'
+ - description: The IDs of the instances to disassociate from the event window.
+ InstanceTag:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window.
+ DedicatedHostId:
+ allOf:
+ - $ref: '#/components/schemas/DedicatedHostIdList'
+ - description: The IDs of the Dedicated Hosts to disassociate from the event window.
+ description: The targets to disassociate from the specified event window.
+ 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'
+ post:
+ x-aws-operation-name: DisassociateInstanceEventWindow
+ operationId: POST_DisassociateInstanceEventWindow
+ description: 'Disassociates one or more targets from an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateInstanceEventWindowResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateInstanceEventWindowRequest' + parameters: [] + /?Action=DisassociateRouteTable&Version=2016-11-15: + get: + x-aws-operation-name: DisassociateRouteTable + operationId: GET_DisassociateRouteTable + description: 'Disassociates a subnet or gateway from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC''s main route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + parameters: + - name: AssociationId + in: query + required: true + description: The association ID representing the current association between the route table and subnet or gateway. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisassociateRouteTable
+ operationId: POST_DisassociateRouteTable
+ description: 'Disassociates a subnet or gateway from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC''s main route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateRouteTableRequest' + parameters: [] + /?Action=DisassociateSubnetCidrBlock&Version=2016-11-15: + get: + x-aws-operation-name: DisassociateSubnetCidrBlock + operationId: GET_DisassociateSubnetCidrBlock + description: 'Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. ' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateSubnetCidrBlockResult' + parameters: + - name: AssociationId + in: query + required: true + description: The association ID for the CIDR block. + schema: + type: string + 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' + post: + x-aws-operation-name: DisassociateSubnetCidrBlock + operationId: POST_DisassociateSubnetCidrBlock + description: 'Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. ' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateSubnetCidrBlockResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateSubnetCidrBlockRequest' + parameters: [] + /?Action=DisassociateTransitGatewayMulticastDomain&Version=2016-11-15: + get: + x-aws-operation-name: DisassociateTransitGatewayMulticastDomain + operationId: GET_DisassociateTransitGatewayMulticastDomain + description: 'Disassociates the specified subnets from the transit gateway multicast domain. ' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainResult' + parameters: + - name: TransitGatewayMulticastDomainId + in: query + required: false + description: The ID of the transit gateway multicast domain. + schema: + type: string + - name: TransitGatewayAttachmentId + in: query + required: false + description: The ID of the attachment. + schema: + type: string + - name: SubnetIds + in: query + required: false + description: The IDs of the subnets; + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SubnetId' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisassociateTransitGatewayMulticastDomain
+ operationId: POST_DisassociateTransitGatewayMulticastDomain
+ description: 'Disassociates the specified subnets from the transit gateway multicast domain. '
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainRequest'
+ parameters: []
+ /?Action=DisassociateTransitGatewayRouteTable&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DisassociateTransitGatewayRouteTable
+ operationId: GET_DisassociateTransitGatewayRouteTable
+ description: Disassociates a resource attachment from a transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisassociateTransitGatewayRouteTableResult'
+ parameters:
+ - name: TransitGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the transit gateway route table.
+ schema:
+ type: string
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: true
+ description: The ID of the attachment.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisassociateTransitGatewayRouteTable
+ operationId: POST_DisassociateTransitGatewayRouteTable
+ description: Disassociates a resource attachment from a transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisassociateTransitGatewayRouteTableResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/DisassociateTransitGatewayRouteTableRequest'
+ parameters: []
+ /?Action=DisassociateTrunkInterface&Version=2016-11-15:
+ get:
+ x-aws-operation-name: DisassociateTrunkInterface
+ operationId: GET_DisassociateTrunkInterface
+ description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Removes an association between a branch network interface with a trunk network interface.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateTrunkInterfaceResult' + parameters: + - name: AssociationId + in: query + required: true + description: The ID of the association + schema: + type: string + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: DisassociateTrunkInterface
+ operationId: POST_DisassociateTrunkInterface
+ description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Removes an association between a branch network interface with a trunk network interface.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateTrunkInterfaceResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateTrunkInterfaceRequest' + parameters: [] + /?Action=DisassociateVpcCidrBlock&Version=2016-11-15: + get: + x-aws-operation-name: DisassociateVpcCidrBlock + operationId: GET_DisassociateVpcCidrBlock + description: 'Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateVpcCidrBlockResult' + parameters: + - name: AssociationId + in: query + required: true + description: The association ID for the CIDR block. + schema: + type: string + 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' + post: + x-aws-operation-name: DisassociateVpcCidrBlock + operationId: POST_DisassociateVpcCidrBlock + description: 'Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateVpcCidrBlockResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DisassociateVpcCidrBlockRequest' + parameters: [] + /?Action=EnableEbsEncryptionByDefault&Version=2016-11-15: + get: + x-aws-operation-name: EnableEbsEncryptionByDefault + operationId: GET_EnableEbsEncryptionByDefault + description: 'Enables EBS encryption by default for your account in the current Region.
After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
Enabling encryption by default has no effect on the encryption status of your existing volumes.
After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableEbsEncryptionByDefaultResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: EnableEbsEncryptionByDefault
+ operationId: POST_EnableEbsEncryptionByDefault
+ description: 'Enables EBS encryption by default for your account in the current Region.
After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
Enabling encryption by default has no effect on the encryption status of your existing volumes.
After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableEbsEncryptionByDefaultResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableEbsEncryptionByDefaultRequest' + parameters: [] + /?Action=EnableFastLaunch&Version=2016-11-15: + get: + x-aws-operation-name: EnableFastLaunch + operationId: GET_EnableFastLaunch + description: 'When you enable faster launching for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.
To change these settings, you must own the AMI.
snapshot, which is the default value.'
+ schema:
+ type: string
+ - name: SnapshotConfiguration
+ in: query
+ required: false
+ description: Configuration settings for creating and managing the snapshots that are used for pre-provisioning the Windows AMI for faster launching. The associated ResourceType must be snapshot.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
+ description: Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
+ - name: LaunchTemplate
+ in: query
+ required: false
+ description: 'The launch template to use when launching Windows instances from pre-provisioned snapshots. Launch template parameters can include either the name or ID of the launch template, but not both.'
+ schema:
+ type: object
+ required:
+ - Version
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The version of the launch template to use for faster launching for a Windows AMI.
+ description: 'Request to create a launch template for a fast-launch enabled Windows AMI.
Note - You can specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
6 or greater. '
+ schema:
+ type: integer
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: EnableFastLaunch
+ operationId: POST_EnableFastLaunch
+ description: 'When you enable faster launching for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.
To change these settings, you must own the AMI.
Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.
You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores.
For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableFastSnapshotRestoresResult' + parameters: + - name: AvailabilityZone + in: query + required: true + description: 'One or more Availability Zones. For example,us-east-2a.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: AvailabilityZone
+ - name: SourceSnapshotId
+ in: query
+ required: true
+ description: 'The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify a snapshot that was shared with you from another Amazon Web Services account.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotId'
+ - xml:
+ name: SnapshotId
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: EnableFastSnapshotRestores
+ operationId: POST_EnableFastSnapshotRestores
+ description: 'Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.
You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores.
For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableFastSnapshotRestoresResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableFastSnapshotRestoresRequest' + parameters: [] + /?Action=EnableImageDeprecation&Version=2016-11-15: + get: + x-aws-operation-name: EnableImageDeprecation + operationId: GET_EnableImageDeprecation + description: 'Enables deprecation of the specified AMI at the specified date and time.
For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableImageDeprecationResult' + parameters: + - name: ImageId + in: query + required: true + description: The ID of the AMI. + schema: + type: string + - name: DeprecateAt + in: query + required: true + description: 'The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
You can’t specify a date in the past. The upper limit for DeprecateAt is 10 years from now.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: EnableImageDeprecation
+ operationId: POST_EnableImageDeprecation
+ description: 'Enables deprecation of the specified AMI at the specified date and time.
For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableImageDeprecationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableImageDeprecationRequest' + parameters: [] + /?Action=EnableIpamOrganizationAdminAccount&Version=2016-11-15: + get: + x-aws-operation-name: EnableIpamOrganizationAdminAccount + operationId: GET_EnableIpamOrganizationAdminAccount + description: 'Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. ' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableIpamOrganizationAdminAccountResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: DelegatedAdminAccountId
+ in: query
+ required: true
+ description: The Organizations member account ID that you want to enable as the IPAM account.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: EnableIpamOrganizationAdminAccount
+ operationId: POST_EnableIpamOrganizationAdminAccount
+ description: 'Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. '
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableIpamOrganizationAdminAccountResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableIpamOrganizationAdminAccountRequest'
+ parameters: []
+ /?Action=EnableSerialConsoleAccess&Version=2016-11-15:
+ get:
+ x-aws-operation-name: EnableSerialConsoleAccess
+ operationId: GET_EnableSerialConsoleAccess
+ description: 'Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableSerialConsoleAccessResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: EnableSerialConsoleAccess
+ operationId: POST_EnableSerialConsoleAccess
+ description: 'Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableSerialConsoleAccessResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableSerialConsoleAccessRequest'
+ parameters: []
+ /?Action=EnableTransitGatewayRouteTablePropagation&Version=2016-11-15:
+ get:
+ x-aws-operation-name: EnableTransitGatewayRouteTablePropagation
+ operationId: GET_EnableTransitGatewayRouteTablePropagation
+ description: Enables the specified attachment to propagate routes to the specified propagation route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationResult'
+ parameters:
+ - name: TransitGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the propagation route table.
+ schema:
+ type: string
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: true
+ description: The ID of the attachment.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: EnableTransitGatewayRouteTablePropagation
+ operationId: POST_EnableTransitGatewayRouteTablePropagation
+ description: Enables the specified attachment to propagate routes to the specified propagation route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationRequest'
+ parameters: []
+ /?Action=EnableVgwRoutePropagation&Version=2016-11-15:
+ get:
+ x-aws-operation-name: EnableVgwRoutePropagation
+ operationId: GET_EnableVgwRoutePropagation
+ description: Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: GatewayId
+ in: query
+ required: true
+ description: 'The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with. '
+ schema:
+ type: string
+ - name: RouteTableId
+ in: query
+ required: true
+ description: 'The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to. '
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: EnableVgwRoutePropagation
+ operationId: POST_EnableVgwRoutePropagation
+ description: Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableVgwRoutePropagationRequest'
+ parameters: []
+ /?Action=EnableVolumeIO&Version=2016-11-15:
+ get:
+ x-aws-operation-name: EnableVolumeIO
+ operationId: GET_EnableVolumeIO
+ description: Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VolumeId
+ in: query
+ required: true
+ description: The ID of the volume.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: EnableVolumeIO
+ operationId: POST_EnableVolumeIO
+ description: Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableVolumeIORequest'
+ parameters: []
+ /?Action=EnableVpcClassicLink&Version=2016-11-15:
+ get:
+ x-aws-operation-name: EnableVpcClassicLink
+ operationId: GET_EnableVpcClassicLink
+ description: 'Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableVpcClassicLinkResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: EnableVpcClassicLink
+ operationId: POST_EnableVpcClassicLink
+ description: 'Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableVpcClassicLinkResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/EnableVpcClassicLinkRequest'
+ parameters: []
+ /?Action=EnableVpcClassicLinkDnsSupport&Version=2016-11-15:
+ get:
+ x-aws-operation-name: EnableVpcClassicLinkDnsSupport
+ operationId: GET_EnableVpcClassicLinkDnsSupport
+ description: 'Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it''s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
You must specify a VPC ID in the request.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportResult' + parameters: + - name: VpcId + in: query + required: false + description: The ID of the VPC. + schema: + type: string + 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' + post: + x-aws-operation-name: EnableVpcClassicLinkDnsSupport + operationId: POST_EnableVpcClassicLinkDnsSupport + description: 'Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it''s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
You must specify a VPC ID in the request.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportRequest' + parameters: [] + /?Action=ExportClientVpnClientCertificateRevocationList&Version=2016-11-15: + get: + x-aws-operation-name: ExportClientVpnClientCertificateRevocationList + operationId: GET_ExportClientVpnClientCertificateRevocationList + description: Downloads the client certificate revocation list for the specified Client VPN endpoint. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListResult' + parameters: + - name: ClientVpnEndpointId + in: query + required: true + description: The ID of the Client VPN endpoint. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ExportClientVpnClientCertificateRevocationList
+ operationId: POST_ExportClientVpnClientCertificateRevocationList
+ description: Downloads the client certificate revocation list for the specified Client VPN endpoint.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListRequest'
+ parameters: []
+ /?Action=ExportClientVpnClientConfiguration&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ExportClientVpnClientConfiguration
+ operationId: GET_ExportClientVpnClientConfiguration
+ description: Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ExportClientVpnClientConfigurationResult'
+ parameters:
+ - name: ClientVpnEndpointId
+ in: query
+ required: true
+ description: The ID of the Client VPN endpoint.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ExportClientVpnClientConfiguration
+ operationId: POST_ExportClientVpnClientConfiguration
+ description: Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ExportClientVpnClientConfigurationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ExportClientVpnClientConfigurationRequest'
+ parameters: []
+ /?Action=ExportImage&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ExportImage
+ operationId: GET_ExportImage
+ description: 'Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ExportImageResult'
+ parameters:
+ - name: ClientToken
+ in: query
+ required: false
+ description: Token to enable idempotency for export image requests.
+ schema:
+ type: string
+ - name: Description
+ in: query
+ required: false
+ description: A description of the image being exported. The maximum length is 255 characters.
+ schema:
+ type: string
+ - name: DiskImageFormat
+ in: query
+ required: true
+ description: The disk image format.
+ schema:
+ type: string
+ enum:
+ - VMDK
+ - RAW
+ - VHD
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ImageId
+ in: query
+ required: true
+ description: The ID of the image.
+ schema:
+ type: string
+ - name: S3ExportLocation
+ in: query
+ required: true
+ description: Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.
+ schema:
+ type: object
+ required:
+ - S3Bucket
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The prefix (logical hierarchy) in the bucket.
+ description: Describes the destination for an export image task.
+ - name: RoleName
+ in: query
+ required: false
+ description: 'The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named ''vmimport''.'
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply to the export image task during creation.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: ExportImage
+ operationId: POST_ExportImage
+ description: 'Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ExportImageResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ExportImageRequest'
+ parameters: []
+ /?Action=ExportTransitGatewayRoutes&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ExportTransitGatewayRoutes
+ operationId: GET_ExportTransitGatewayRoutes
+ description: 'Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.
The routes are saved to the specified bucket in a JSON file. For more information, see Export Route Tables to Amazon S3 in Transit Gateways.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ExportTransitGatewayRoutesResult' + parameters: + - name: TransitGatewayRouteTableId + in: query + required: true + description: The ID of the route table. + schema: + type: string + - name: Filter + in: query + required: false + description: 'One or more filters. The possible values are:
attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
transit-gateway-route-destination-cidr-block - The CIDR range.
type - The type of route (propagated | static).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ExportTransitGatewayRoutes
+ operationId: POST_ExportTransitGatewayRoutes
+ description: 'Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.
The routes are saved to the specified bucket in a JSON file. For more information, see Export Route Tables to Amazon S3 in Transit Gateways.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ExportTransitGatewayRoutesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ExportTransitGatewayRoutesRequest' + parameters: [] + /?Action=GetAssociatedEnclaveCertificateIamRoles&Version=2016-11-15: + get: + x-aws-operation-name: GetAssociatedEnclaveCertificateIamRoles + operationId: GET_GetAssociatedEnclaveCertificateIamRoles + description: 'Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key that''s used to encrypt the private key.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetAssociatedEnclaveCertificateIamRolesResult' + parameters: + - name: CertificateArn + in: query + required: false + description: 'The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon S3 object information.' + schema: + type: string + minLength: 1 + maxLength: 1283 + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetAssociatedEnclaveCertificateIamRoles
+ operationId: POST_GetAssociatedEnclaveCertificateIamRoles
+ description: 'Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key that''s used to encrypt the private key.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetAssociatedEnclaveCertificateIamRolesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetAssociatedEnclaveCertificateIamRolesRequest'
+ parameters: []
+ /?Action=GetAssociatedIpv6PoolCidrs&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetAssociatedIpv6PoolCidrs
+ operationId: GET_GetAssociatedIpv6PoolCidrs
+ description: Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetAssociatedIpv6PoolCidrsResult'
+ parameters:
+ - name: PoolId
+ in: query
+ required: true
+ description: The ID of the IPv6 address pool.
+ schema:
+ type: string
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetAssociatedIpv6PoolCidrs
+ operationId: POST_GetAssociatedIpv6PoolCidrs
+ description: Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetAssociatedIpv6PoolCidrsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetAssociatedIpv6PoolCidrsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetCapacityReservationUsage&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetCapacityReservationUsage
+ operationId: GET_GetCapacityReservationUsage
+ description: 'Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner''s usage.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetCapacityReservationUsageResult'
+ parameters:
+ - name: CapacityReservationId
+ in: query
+ required: true
+ description: The ID of the Capacity Reservation.
+ schema:
+ type: string
+ - name: NextToken
+ in: query
+ required: false
+ description: The token to use to retrieve the next page of results.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
' + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetCapacityReservationUsage
+ operationId: POST_GetCapacityReservationUsage
+ description: 'Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner''s usage.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetCapacityReservationUsageResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetCapacityReservationUsageRequest'
+ parameters: []
+ /?Action=GetCoipPoolUsage&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetCoipPoolUsage
+ operationId: GET_GetCoipPoolUsage
+ description: Describes the allocations from the specified customer-owned address pool.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetCoipPoolUsageResult'
+ parameters:
+ - name: PoolId
+ in: query
+ required: true
+ description: The ID of the address pool.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: One or more filters.
coip-address-usage.allocation-id - The allocation ID of the address.
coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address.
coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address.
coip-address-usage.co-ip - The customer-owned IP address.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetCoipPoolUsage
+ operationId: POST_GetCoipPoolUsage
+ description: Describes the allocations from the specified customer-owned address pool.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetCoipPoolUsageResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetCoipPoolUsageRequest'
+ parameters: []
+ /?Action=GetConsoleOutput&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetConsoleOutput
+ operationId: GET_GetConsoleOutput
+ description: 'Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetConsoleOutputResult' + parameters: + - name: InstanceId + in: query + required: true + description: The ID of the instance. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Latest
+ in: query
+ required: false
+ description: 'When enabled, retrieves the latest console output for the instance.
Default: disabled (false)
Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetConsoleOutputResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetConsoleOutputRequest' + parameters: [] + /?Action=GetConsoleScreenshot&Version=2016-11-15: + get: + x-aws-operation-name: GetConsoleScreenshot + operationId: GET_GetConsoleScreenshot + description:Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetConsoleScreenshotResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance.
+ schema:
+ type: string
+ - name: WakeUp
+ in: query
+ required: false
+ description: 'When set to true, acts as keystroke input and wakes up an instance that''s in standby or "sleep" mode.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetConsoleScreenshot
+ operationId: POST_GetConsoleScreenshot
+ description: Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetConsoleScreenshotResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetConsoleScreenshotRequest' + parameters: [] + /?Action=GetDefaultCreditSpecification&Version=2016-11-15: + get: + x-aws-operation-name: GetDefaultCreditSpecification + operationId: GET_GetDefaultCreditSpecification + description: 'Describes the default credit option for CPU usage of a burstable performance instance family.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetDefaultCreditSpecificationResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceFamily
+ in: query
+ required: true
+ description: The instance family.
+ schema:
+ type: string
+ enum:
+ - t2
+ - t3
+ - t3a
+ - t4g
+ 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'
+ post:
+ x-aws-operation-name: GetDefaultCreditSpecification
+ operationId: POST_GetDefaultCreditSpecification
+ description: 'Describes the default credit option for CPU usage of a burstable performance instance family.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetDefaultCreditSpecificationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetDefaultCreditSpecificationRequest' + parameters: [] + /?Action=GetEbsDefaultKmsKeyId&Version=2016-11-15: + get: + x-aws-operation-name: GetEbsDefaultKmsKeyId + operationId: GET_GetEbsDefaultKmsKeyId + description: 'Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetEbsDefaultKmsKeyIdResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetEbsDefaultKmsKeyId
+ operationId: POST_GetEbsDefaultKmsKeyId
+ description: 'Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetEbsDefaultKmsKeyIdResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetEbsDefaultKmsKeyIdRequest' + parameters: [] + /?Action=GetEbsEncryptionByDefault&Version=2016-11-15: + get: + x-aws-operation-name: GetEbsEncryptionByDefault + operationId: GET_GetEbsEncryptionByDefault + description: 'Describes whether EBS encryption by default is enabled for your account in the current Region.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetEbsEncryptionByDefaultResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetEbsEncryptionByDefault
+ operationId: POST_GetEbsEncryptionByDefault
+ description: 'Describes whether EBS encryption by default is enabled for your account in the current Region.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetEbsEncryptionByDefaultResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetEbsEncryptionByDefaultRequest' + parameters: [] + /?Action=GetFlowLogsIntegrationTemplate&Version=2016-11-15: + get: + x-aws-operation-name: GetFlowLogsIntegrationTemplate + operationId: GET_GetFlowLogsIntegrationTemplate + description: 'Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:
Create a table in Athena that maps fields to a custom log format
Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis
Create a table partitioned between two timestamps in the past
Create a set of named queries in Athena that you can use to get started quickly
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: FlowLogId
+ in: query
+ required: true
+ description: The ID of the flow log.
+ schema:
+ type: string
+ - name: ConfigDeliveryS3DestinationArn
+ in: query
+ required: true
+ description: 'To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.'
+ schema:
+ type: string
+ - name: IntegrateService
+ in: query
+ required: true
+ description: Information about the service integration.
+ schema:
+ type: object
+ properties:
+ AthenaIntegration:
+ allOf:
+ - $ref: '#/components/schemas/AthenaIntegrationsSet'
+ - description: Information about the integration with Amazon Athena.
+ description: Describes service integrations with VPC Flow logs.
+ 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'
+ post:
+ x-aws-operation-name: GetFlowLogsIntegrationTemplate
+ operationId: POST_GetFlowLogsIntegrationTemplate
+ description: 'Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:
Create a table in Athena that maps fields to a custom log format
Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis
Create a table partitioned between two timestamps in the past
Create a set of named queries in Athena that you can use to get started quickly
nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetGroupsForCapacityReservation
+ operationId: POST_GetGroupsForCapacityReservation
+ description: Lists the resource groups to which a Capacity Reservation has been added.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetGroupsForCapacityReservationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetGroupsForCapacityReservationRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetHostReservationPurchasePreview&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetHostReservationPurchasePreview
+ operationId: GET_GetHostReservationPurchasePreview
+ description: Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.
This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetHostReservationPurchasePreviewResult' + parameters: + - name: HostIdSet + in: query + required: true + description: The IDs of the Dedicated Hosts with which the reservation is associated. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/DedicatedHostId' + - xml: + name: item + - name: OfferingId + in: query + required: true + description: The offering ID of the reservation. + schema: + type: string + 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' + post: + x-aws-operation-name: GetHostReservationPurchasePreview + operationId: POST_GetHostReservationPurchasePreview + description:Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.
This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetHostReservationPurchasePreviewResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetHostReservationPurchasePreviewRequest' + parameters: [] + /?Action=GetInstanceTypesFromInstanceRequirements&Version=2016-11-15: + get: + x-aws-operation-name: GetInstanceTypesFromInstanceRequirements + operationId: GET_GetInstanceTypesFromInstanceRequirements + description: 'Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetInstanceTypesFromInstanceRequirementsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ArchitectureType
+ in: query
+ required: true
+ description: The processor architecture type.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ArchitectureType'
+ - xml:
+ name: item
+ minItems: 0
+ maxItems: 3
+ - name: VirtualizationType
+ in: query
+ required: true
+ description: The virtualization type.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VirtualizationType'
+ - xml:
+ name: item
+ minItems: 0
+ maxItems: 2
+ - name: InstanceRequirements
+ in: query
+ required: true
+ description: The attributes required for the instance types.
+ schema:
+ type: object
+ required:
+ - VCpuCount
+ - MemoryMiB
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/MemoryMiBRequest'
+ - description: 'The minimum and maximum amount of memory, in MiB.'
+ CpuManufacturer:
+ allOf:
+ - $ref: '#/components/schemas/MemoryGiBPerVCpuRequest'
+ - description: 'The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
' + ExcludedInstanceType: + allOf: + - $ref: '#/components/schemas/ExcludedInstanceTypeSet' + - description: 'The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
Default: No excluded instance types
' + InstanceGeneration: + allOf: + - $ref: '#/components/schemas/LocalStorage' + - description: 'Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
To include instance types with instance store volumes, specify included.
To require only instance types with instance store volumes, specify required.
To exclude instance types with instance store volumes, specify excluded.
Default: included
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
' + AcceleratorType: + allOf: + - $ref: '#/components/schemas/AcceleratorCountRequest' + - description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
' + AcceleratorManufacturer: + allOf: + - $ref: '#/components/schemas/AcceleratorManufacturerSet' + - description: 'Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
' + AcceleratorName: + allOf: + - $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest' + - description: 'The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
' + description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
You must specify VCpuCount and MemoryMiB. All other parameters are optional. Any unspecified optional parameter is set to its default.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
' + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returnedNextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next set of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: GetInstanceTypesFromInstanceRequirements
+ operationId: POST_GetInstanceTypesFromInstanceRequirements
+ description: 'Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetInstanceTypesFromInstanceRequirementsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetInstanceTypesFromInstanceRequirementsRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=GetInstanceUefiData&Version=2016-11-15: + get: + x-aws-operation-name: GetInstanceUefiData + operationId: GET_GetInstanceUefiData + description: 'A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded.
When you use register-image to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on GitHub. You can use the tool to convert the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert back into the binary format to use with register-image.
For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetInstanceUefiDataResult' + parameters: + - name: InstanceId + in: query + required: true + description: The ID of the instance from which to retrieve the UEFI data. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetInstanceUefiData
+ operationId: POST_GetInstanceUefiData
+ description: 'A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded.
When you use register-image to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on GitHub. You can use the tool to convert the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert back into the binary format to use with register-image.
For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetInstanceUefiDataResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetInstanceUefiDataRequest' + parameters: [] + /?Action=GetIpamAddressHistory&Version=2016-11-15: + get: + x-aws-operation-name: GetIpamAddressHistory + operationId: GET_GetIpamAddressHistory + description: 'Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetIpamAddressHistoryResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Cidr
+ in: query
+ required: true
+ description: 'The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.'
+ schema:
+ type: string
+ - name: IpamScopeId
+ in: query
+ required: true
+ description: The ID of the IPAM scope that the CIDR is in.
+ schema:
+ type: string
+ - name: VpcId
+ in: query
+ required: false
+ description: The ID of the VPC you want your history records filtered by.
+ schema:
+ type: string
+ - name: StartTime
+ in: query
+ required: false
+ description: 'The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.'
+ schema:
+ type: string
+ format: date-time
+ - name: EndTime
+ in: query
+ required: false
+ description: 'The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.'
+ schema:
+ type: string
+ format: date-time
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of historical results you would like returned per page. Defaults to 100.
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: GetIpamAddressHistory
+ operationId: POST_GetIpamAddressHistory
+ description: 'Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetIpamAddressHistoryResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetIpamAddressHistoryRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetIpamPoolAllocations&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetIpamPoolAllocations
+ operationId: GET_GetIpamPoolAllocations
+ description: Get a list of all the CIDR allocations in an IPAM pool.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetIpamPoolAllocationsResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamPoolId
+ in: query
+ required: true
+ description: The ID of the IPAM pool you want to see the allocations for.
+ schema:
+ type: string
+ - name: IpamPoolAllocationId
+ in: query
+ required: false
+ description: The ID of the allocation.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Filter'
+ - xml:
+ name: Filter
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of results you would like returned per page.
+ schema:
+ type: integer
+ minimum: 1000
+ maximum: 100000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: GetIpamPoolAllocations
+ operationId: POST_GetIpamPoolAllocations
+ description: Get a list of all the CIDR allocations in an IPAM pool.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetIpamPoolAllocationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetIpamPoolAllocationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetIpamPoolCidrs&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetIpamPoolCidrs
+ operationId: GET_GetIpamPoolCidrs
+ description: Get the CIDRs provisioned to an IPAM pool.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetIpamPoolCidrsResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamPoolId
+ in: query
+ required: true
+ description: The ID of the IPAM pool you want the CIDR for.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Filter'
+ - xml:
+ name: Filter
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of results to return in the request.
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: GetIpamPoolCidrs
+ operationId: POST_GetIpamPoolCidrs
+ description: Get the CIDRs provisioned to an IPAM pool.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetIpamPoolCidrsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetIpamPoolCidrsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetIpamResourceCidrs&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetIpamResourceCidrs
+ operationId: GET_GetIpamResourceCidrs
+ description: Get information about the resources in a scope.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetIpamResourceCidrsResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Filter'
+ - xml:
+ name: Filter
+ - name: MaxResults
+ in: query
+ required: false
+ description: The maximum number of results to return in the request.
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: IpamScopeId
+ in: query
+ required: true
+ description: The ID of the scope that the resource is in.
+ schema:
+ type: string
+ - name: IpamPoolId
+ in: query
+ required: false
+ description: The ID of the IPAM pool that the resource is in.
+ schema:
+ type: string
+ - name: ResourceId
+ in: query
+ required: false
+ description: The ID of the resource.
+ schema:
+ type: string
+ - name: ResourceType
+ in: query
+ required: false
+ description: The resource type.
+ schema:
+ type: string
+ enum:
+ - vpc
+ - subnet
+ - eip
+ - public-ipv4-pool
+ - ipv6-pool
+ - name: ResourceTag
+ in: query
+ required: false
+ description: ''
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The value for the tag.
+ description: A tag on an IPAM resource.
+ - name: ResourceOwner
+ in: query
+ required: false
+ description: The ID of the Amazon Web Services account that owns the resource.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: GetIpamResourceCidrs
+ operationId: POST_GetIpamResourceCidrs
+ description: Get information about the resources in a scope.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetIpamResourceCidrsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetIpamResourceCidrsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetLaunchTemplateData&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetLaunchTemplateData
+ operationId: GET_GetLaunchTemplateData
+ description: 'Retrieves the configuration data of the specified instance. You can use this data to create a launch template.
This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, DescribeVolumes, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: GetLaunchTemplateData
+ operationId: POST_GetLaunchTemplateData
+ description: 'Retrieves the configuration data of the specified instance. You can use this data to create a launch template.
This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, DescribeVolumes, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PrefixListId
+ in: query
+ required: true
+ description: The ID of the prefix list.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 255
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: GetManagedPrefixListAssociations
+ operationId: POST_GetManagedPrefixListAssociations
+ description: Gets information about the resources that are associated with the specified managed prefix list.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetManagedPrefixListAssociationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetManagedPrefixListAssociationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetManagedPrefixListEntries&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetManagedPrefixListEntries
+ operationId: GET_GetManagedPrefixListEntries
+ description: Gets information about the entries for a specified managed prefix list.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetManagedPrefixListEntriesResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PrefixListId
+ in: query
+ required: true
+ description: The ID of the prefix list.
+ schema:
+ type: string
+ - name: TargetVersion
+ in: query
+ required: false
+ description: The version of the prefix list for which to return the entries. The default is the current version.
+ schema:
+ type: integer
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 100
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: GetManagedPrefixListEntries
+ operationId: POST_GetManagedPrefixListEntries
+ description: Gets information about the entries for a specified managed prefix list.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetManagedPrefixListEntriesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetManagedPrefixListEntriesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetNetworkInsightsAccessScopeAnalysisFindings&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetNetworkInsightsAccessScopeAnalysisFindings
+ operationId: GET_GetNetworkInsightsAccessScopeAnalysisFindings
+ description: Gets the findings for the specified Network Access Scope analysis.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetNetworkInsightsAccessScopeAnalysisFindingsResult'
+ parameters:
+ - name: NetworkInsightsAccessScopeAnalysisId
+ in: query
+ required: true
+ description: The ID of the Network Access Scope analysis.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 100
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetNetworkInsightsAccessScopeAnalysisFindings
+ operationId: POST_GetNetworkInsightsAccessScopeAnalysisFindings
+ description: Gets the findings for the specified Network Access Scope analysis.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetNetworkInsightsAccessScopeAnalysisFindingsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetNetworkInsightsAccessScopeAnalysisFindingsRequest'
+ parameters: []
+ /?Action=GetNetworkInsightsAccessScopeContent&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetNetworkInsightsAccessScopeContent
+ operationId: GET_GetNetworkInsightsAccessScopeContent
+ description: Gets the content for the specified Network Access Scope.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetNetworkInsightsAccessScopeContentResult'
+ parameters:
+ - name: NetworkInsightsAccessScopeId
+ in: query
+ required: true
+ description: The ID of the Network Access Scope.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetNetworkInsightsAccessScopeContent
+ operationId: POST_GetNetworkInsightsAccessScopeContent
+ description: Gets the content for the specified Network Access Scope.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetNetworkInsightsAccessScopeContentResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetNetworkInsightsAccessScopeContentRequest'
+ parameters: []
+ /?Action=GetPasswordData&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetPasswordData
+ operationId: GET_GetPasswordData
+ description: 'Retrieves the encrypted administrator password for a running Windows instance.
The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon EC2 User Guide.
For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it''s available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetPasswordDataResult' + parameters: + - name: InstanceId + in: query + required: true + description: The ID of the Windows instance. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetPasswordData
+ operationId: POST_GetPasswordData
+ description: 'Retrieves the encrypted administrator password for a running Windows instance.
The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon EC2 User Guide.
For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it''s available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetPasswordDataResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetPasswordDataRequest' + parameters: [] + /?Action=GetReservedInstancesExchangeQuote&Version=2016-11-15: + get: + x-aws-operation-name: GetReservedInstancesExchangeQuote + operationId: GET_GetReservedInstancesExchangeQuote + description: 'Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetReservedInstancesExchangeQuoteResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ReservedInstanceId
+ in: query
+ required: true
+ description: The IDs of the Convertible Reserved Instances to exchange.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservationId'
+ - xml:
+ name: ReservedInstanceId
+ - name: TargetConfiguration
+ in: query
+ required: false
+ description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TargetConfigurationRequest'
+ - xml:
+ name: TargetConfigurationRequest
+ 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'
+ post:
+ x-aws-operation-name: GetReservedInstancesExchangeQuote
+ operationId: POST_GetReservedInstancesExchangeQuote
+ description: 'Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetReservedInstancesExchangeQuoteResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetReservedInstancesExchangeQuoteRequest'
+ parameters: []
+ /?Action=GetSerialConsoleAccessStatus&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetSerialConsoleAccessStatus
+ operationId: GET_GetSerialConsoleAccessStatus
+ description: 'Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetSerialConsoleAccessStatusResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetSerialConsoleAccessStatus
+ operationId: POST_GetSerialConsoleAccessStatus
+ description: 'Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetSerialConsoleAccessStatusResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetSerialConsoleAccessStatusRequest'
+ parameters: []
+ /?Action=GetSpotPlacementScores&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetSpotPlacementScores
+ operationId: GET_GetSpotPlacementScores
+ description: 'Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.
You can specify your compute requirements either by using InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using InstanceTypes.
For more information, see Spot placement score in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetSpotPlacementScoresResult' + parameters: + - name: InstanceType + in: query + required: false + description: 'The instance types. We recommend that you specify at least three instance types. If you specify one or two instance types, or specify variations of a single instance type (for example, an m3.xlarge with and without instance storage), the returned placement score will always be low.
If you specify InstanceTypes, you can''t specify InstanceRequirementsWithMetadata.
The unit for the target capacity.
Default: units (translates to number of instances)
Specify true so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions.
A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone.
' + schema: + type: boolean + - name: RegionName + in: query + required: false + description: 'The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,us-east-1.'
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/String'
+ minItems: 0
+ maxItems: 10
+ - name: InstanceRequirementsWithMetadata
+ in: query
+ required: false
+ description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadata, you can''t specify InstanceTypes.
The architecture type, virtualization type, and other attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadataRequest, you can''t specify InstanceTypes.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return in a single call. Specify a value between 1 and
1000. The default value is 1000. To retrieve the remaining results, make another call with
the returned NextToken value.'
+ schema:
+ type: integer
+ minimum: 10
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next set of results.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: GetSpotPlacementScores
+ operationId: POST_GetSpotPlacementScores
+ description: 'Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.
You can specify your compute requirements either by using InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using InstanceTypes.
For more information, see Spot placement score in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetSpotPlacementScoresResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetSpotPlacementScoresRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + /?Action=GetSubnetCidrReservations&Version=2016-11-15: + get: + x-aws-operation-name: GetSubnetCidrReservations + operationId: GET_GetSubnetCidrReservations + description: Gets information about the subnet CIDR reservations. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/GetSubnetCidrReservationsResult' + parameters: + - name: Filter + in: query + required: false + description: 'One or more filters.
reservationType - The type of reservation (prefix | explicit).
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ 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'
+ post:
+ x-aws-operation-name: GetSubnetCidrReservations
+ operationId: POST_GetSubnetCidrReservations
+ description: Gets information about the subnet CIDR reservations.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetSubnetCidrReservationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetSubnetCidrReservationsRequest'
+ parameters: []
+ /?Action=GetTransitGatewayAttachmentPropagations&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetTransitGatewayAttachmentPropagations
+ operationId: GET_GetTransitGatewayAttachmentPropagations
+ description: Lists the route tables to which the specified resource attachment propagates routes.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsResult'
+ parameters:
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: true
+ description: The ID of the attachment.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
transit-gateway-route-table-id - The ID of the transit gateway route table.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetTransitGatewayAttachmentPropagations
+ operationId: POST_GetTransitGatewayAttachmentPropagations
+ description: Lists the route tables to which the specified resource attachment propagates routes.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetTransitGatewayMulticastDomainAssociations&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetTransitGatewayMulticastDomainAssociations
+ operationId: GET_GetTransitGatewayMulticastDomainAssociations
+ description: Gets information about the associations for the transit gateway multicast domain.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayMulticastDomainAssociationsResult'
+ parameters:
+ - name: TransitGatewayMulticastDomainId
+ in: query
+ required: false
+ description: The ID of the transit gateway multicast domain.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The type of resource. The valid value is: vpc.
state - The state of the subnet association. Valid values are associated | associating | disassociated | disassociating.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetTransitGatewayMulticastDomainAssociations
+ operationId: POST_GetTransitGatewayMulticastDomainAssociations
+ description: Gets information about the associations for the transit gateway multicast domain.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayMulticastDomainAssociationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayMulticastDomainAssociationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetTransitGatewayPrefixListReferences&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetTransitGatewayPrefixListReferences
+ operationId: GET_GetTransitGatewayPrefixListReferences
+ description: Gets information about the prefix list references in a specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesResult'
+ parameters:
+ - name: TransitGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the transit gateway route table.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
attachment.resource-id - The ID of the resource for the attachment.
attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.
attachment.transit-gateway-attachment-id - The ID of the attachment.
is-blackhole - Whether traffic matching the route is blocked (true | false).
prefix-list-id - The ID of the prefix list.
prefix-list-owner-id - The ID of the owner of the prefix list.
state - The state of the prefix list reference (pending | available | modifying | deleting).
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetTransitGatewayPrefixListReferences
+ operationId: POST_GetTransitGatewayPrefixListReferences
+ description: Gets information about the prefix list references in a specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetTransitGatewayRouteTableAssociations&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetTransitGatewayRouteTableAssociations
+ operationId: GET_GetTransitGatewayRouteTableAssociations
+ description: Gets information about the associations for the specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsResult'
+ parameters:
+ - name: TransitGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the transit gateway route table.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetTransitGatewayRouteTableAssociations
+ operationId: POST_GetTransitGatewayRouteTableAssociations
+ description: Gets information about the associations for the specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetTransitGatewayRouteTablePropagations&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetTransitGatewayRouteTablePropagations
+ operationId: GET_GetTransitGatewayRouteTablePropagations
+ description: Gets information about the route table propagations for the specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsResult'
+ parameters:
+ - name: TransitGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the transit gateway route table.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetTransitGatewayRouteTablePropagations
+ operationId: POST_GetTransitGatewayRouteTablePropagations
+ description: Gets information about the route table propagations for the specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=GetVpnConnectionDeviceSampleConfiguration&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetVpnConnectionDeviceSampleConfiguration
+ operationId: GET_GetVpnConnectionDeviceSampleConfiguration
+ description: Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetVpnConnectionDeviceSampleConfigurationResult'
+ parameters:
+ - name: VpnConnectionId
+ in: query
+ required: true
+ description: The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration.
+ schema:
+ type: string
+ - name: VpnConnectionDeviceTypeId
+ in: query
+ required: true
+ description: Device identifier provided by the GetVpnConnectionDeviceTypes API.
+ schema:
+ type: string
+ - name: InternetKeyExchangeVersion
+ in: query
+ required: false
+ description: 'The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ikev1 or ikev2.'
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetVpnConnectionDeviceSampleConfiguration
+ operationId: POST_GetVpnConnectionDeviceSampleConfiguration
+ description: Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetVpnConnectionDeviceSampleConfigurationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetVpnConnectionDeviceSampleConfigurationRequest'
+ parameters: []
+ /?Action=GetVpnConnectionDeviceTypes&Version=2016-11-15:
+ get:
+ x-aws-operation-name: GetVpnConnectionDeviceTypes
+ operationId: GET_GetVpnConnectionDeviceTypes
+ description: 'Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetVpnConnectionDeviceTypesResult'
+ parameters:
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results returned by GetVpnConnectionDeviceTypes in paginated output. When this parameter is used, GetVpnConnectionDeviceTypes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another GetVpnConnectionDeviceTypes request with the returned NextToken value. This value can be between 200 and 1000. If this parameter is not used, then GetVpnConnectionDeviceTypes returns all results.'
+ schema:
+ type: integer
+ minimum: 200
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: 'The NextToken value returned from a previous paginated GetVpnConnectionDeviceTypes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return. '
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: GetVpnConnectionDeviceTypes
+ operationId: POST_GetVpnConnectionDeviceTypes
+ description: 'Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetVpnConnectionDeviceTypesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/GetVpnConnectionDeviceTypesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=ImportClientVpnClientCertificateRevocationList&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ImportClientVpnClientCertificateRevocationList
+ operationId: GET_ImportClientVpnClientCertificateRevocationList
+ description: Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.
Uploading a client certificate revocation list resets existing client connections.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListResult' + parameters: + - name: ClientVpnEndpointId + in: query + required: true + description: The ID of the Client VPN endpoint to which the client certificate revocation list applies. + schema: + type: string + - name: CertificateRevocationList + in: query + required: true + description: 'The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the Client VPN Administrator Guide.' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ImportClientVpnClientCertificateRevocationList
+ operationId: POST_ImportClientVpnClientCertificateRevocationList
+ description: Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.
Uploading a client certificate revocation list resets existing client connections.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListRequest' + parameters: [] + /?Action=ImportImage&Version=2016-11-15: + get: + x-aws-operation-name: ImportImage + operationId: GET_ImportImage + description: 'Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportImageResult' + parameters: + - name: Architecture + in: query + required: false + description: 'The architecture of the virtual machine.
Valid values: i386 | x86_64
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Encrypted
+ in: query
+ required: false
+ description: 'Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.'
+ schema:
+ type: boolean
+ - name: Hypervisor
+ in: query
+ required: false
+ description: 'The target hypervisor platform.
Valid values: xen
An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the AMI is being copied to.
Amazon EBS does not support asymmetric KMS keys.
' + schema: + type: string + - name: LicenseType + in: query + required: false + description: 'The license type to be used for the Amazon Machine Image (AMI) after importing.
By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an Amazon Web Services license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.
To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.
The operating system of the virtual machine.
Valid values: Windows | Linux
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportImageResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportImageRequest' + parameters: [] + /?Action=ImportInstance&Version=2016-11-15: + get: + x-aws-operation-name: ImportInstance + operationId: GET_ImportInstance + description: 'Creates an import instance task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportInstanceResult' + parameters: + - name: Description + in: query + required: false + description: A description for the instance being imported. + schema: + type: string + - name: DiskImage + in: query + required: false + description: The disk image. + schema: + type: array + items: + $ref: '#/components/schemas/DiskImage' + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: LaunchSpecification
+ in: query
+ required: false
+ description: The launch specification.
+ schema:
+ type: object
+ properties:
+ additionalInfo:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Reserved.
+ architecture:
+ allOf:
+ - $ref: '#/components/schemas/ArchitectureValues'
+ - description: The architecture of the instance.
+ GroupId:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupIdStringList'
+ - description: The security group IDs.
+ GroupName:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupStringList'
+ - description: The security group names.
+ instanceInitiatedShutdownBehavior:
+ allOf:
+ - $ref: '#/components/schemas/ShutdownBehavior'
+ - description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/InstanceType'
+ - description: 'The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.'
+ monitoring:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether monitoring is enabled.
+ placement:
+ allOf:
+ - $ref: '#/components/schemas/Placement'
+ - description: The placement information for the instance.
+ privateIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: '[EC2-VPC] An available IP address from the IP address range of the subnet.'
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - description: '[EC2-VPC] The ID of the subnet in which to launch the instance.'
+ userData:
+ allOf:
+ - $ref: '#/components/schemas/UserData'
+ - description: The Base64-encoded user data to make available to the instance.
+ description: Describes the launch specification for VM import.
+ - name: Platform
+ in: query
+ required: true
+ description: The instance operating system.
+ schema:
+ type: string
+ enum:
+ - Windows
+ 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'
+ post:
+ x-aws-operation-name: ImportInstance
+ operationId: POST_ImportInstance
+ description: 'Creates an import instance task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportInstanceResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportInstanceRequest' + parameters: [] + /?Action=ImportKeyPair&Version=2016-11-15: + get: + x-aws-operation-name: ImportKeyPair + operationId: GET_ImportKeyPair + description: 'Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportKeyPairResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: KeyName
+ in: query
+ required: true
+ description: A unique name for the key pair.
+ schema:
+ type: string
+ - name: PublicKeyMaterial
+ in: query
+ required: true
+ description: 'The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.'
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply to the imported key pair.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: ImportKeyPair
+ operationId: POST_ImportKeyPair
+ description: 'Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportKeyPairResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportKeyPairRequest' + parameters: [] + /?Action=ImportSnapshot&Version=2016-11-15: + get: + x-aws-operation-name: ImportSnapshot + operationId: GET_ImportSnapshot + description: 'Imports a disk into an EBS snapshot.
For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportSnapshotResult' + parameters: + - name: ClientData + in: query + required: false + description: The client-specific data. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: The time that the disk upload starts. + description: Describes the client-specific data. + - name: ClientToken + in: query + required: false + description: Token to enable idempotency for VM import requests. + schema: + type: string + - name: Description + in: query + required: false + description: The description string for the import snapshot task. + schema: + type: string + - name: DiskContainer + in: query + required: false + description: Information about the disk container. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/UserBucket' + - description: The Amazon S3 bucket for the disk image. + description: The disk container object for the import snapshot request. + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Encrypted
+ in: query
+ required: false
+ description: 'Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.'
+ schema:
+ type: boolean
+ - name: KmsKeyId
+ in: query
+ required: false
+ description: 'An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric KMS keys.
' + schema: + type: string + - name: RoleName + in: query + required: false + description: 'The name of the role to use when not using the default role, ''vmimport''.' + schema: + type: string + - name: TagSpecification + in: query + required: false + description: The tags to apply to the import snapshot task during creation. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + 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' + post: + x-aws-operation-name: ImportSnapshot + operationId: POST_ImportSnapshot + description: 'Imports a disk into an EBS snapshot.
For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportSnapshotResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportSnapshotRequest' + parameters: [] + /?Action=ImportVolume&Version=2016-11-15: + get: + x-aws-operation-name: ImportVolume + operationId: GET_ImportVolume + description: 'Creates an import volume task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportVolumeResult' + parameters: + - name: AvailabilityZone + in: query + required: true + description: The Availability Zone for the resulting EBS volume. + schema: + type: string + - name: Description + in: query + required: false + description: A description of the volume. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Image
+ in: query
+ required: true
+ description: The disk image.
+ schema:
+ type: object
+ required:
+ - Bytes
+ - Format
+ - ImportManifestUrl
+ properties:
+ bytes:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: 'The size of the disk image, in GiB.'
+ format:
+ allOf:
+ - $ref: '#/components/schemas/DiskImageFormat'
+ - description: The disk image format.
+ importManifestUrl:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' + description: Describes a disk image. + - name: Volume + in: query + required: true + description: The volume size. + schema: + type: object + required: + - Size + properties: + size: + allOf: + - $ref: '#/components/schemas/Long' + - description: 'The size of the volume, in GiB.' + description: Describes an EBS volume. + 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' + post: + x-aws-operation-name: ImportVolume + operationId: POST_ImportVolume + description: 'Creates an import volume task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportVolumeResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ImportVolumeRequest' + parameters: [] + /?Action=ListImagesInRecycleBin&Version=2016-11-15: + get: + x-aws-operation-name: ListImagesInRecycleBin + operationId: GET_ListImagesInRecycleBin + description: 'Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ListImagesInRecycleBinResult' + parameters: + - name: ImageId + in: query + required: false + description: The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/ImageId' + - xml: + name: ImageId + - name: NextToken + in: query + required: false + description: The token for the next page of results. + schema: + type: string + - name: MaxResults + in: query + required: false + description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If you do not specify a value for MaxResults, the request returns 1,000 items per page by default. For more information, see Pagination.
' + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ListImagesInRecycleBin
+ operationId: POST_ListImagesInRecycleBin
+ description: 'Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ListImagesInRecycleBinResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ListImagesInRecycleBinRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=ListSnapshotsInRecycleBin&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ListSnapshotsInRecycleBin
+ operationId: GET_ListSnapshotsInRecycleBin
+ description: Lists one or more snapshots that are currently in the Recycle Bin.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ListSnapshotsInRecycleBinResult'
+ parameters:
+ - name: MaxResults
+ in: query
+ required: false
+ description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: SnapshotId
+ in: query
+ required: false
+ description: The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotId'
+ - xml:
+ name: SnapshotId
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ListSnapshotsInRecycleBin
+ operationId: POST_ListSnapshotsInRecycleBin
+ description: Lists one or more snapshots that are currently in the Recycle Bin.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ListSnapshotsInRecycleBinResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ListSnapshotsInRecycleBinRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=ModifyAddressAttribute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyAddressAttribute
+ operationId: GET_ModifyAddressAttribute
+ description: 'Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyAddressAttributeResult'
+ parameters:
+ - name: AllocationId
+ in: query
+ required: true
+ description: '[EC2-VPC] The allocation ID.'
+ schema:
+ type: string
+ - name: DomainName
+ in: query
+ required: false
+ description: The domain name to modify for the IP address.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyAddressAttribute
+ operationId: POST_ModifyAddressAttribute
+ description: 'Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyAddressAttributeResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyAddressAttributeRequest'
+ parameters: []
+ /?Action=ModifyAvailabilityZoneGroup&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyAvailabilityZoneGroup
+ operationId: GET_ModifyAvailabilityZoneGroup
+ description: 'Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.
Use DescribeAvailabilityZones to view the value for GroupName.
opted-in. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.'
+ schema:
+ type: string
+ enum:
+ - opted-in
+ - not-opted-in
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyAvailabilityZoneGroup
+ operationId: POST_ModifyAvailabilityZoneGroup
+ description: 'Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.
Use DescribeAvailabilityZones to view the value for GroupName.
1000 in a single request.
+ schema:
+ type: integer
+ - name: EndDate
+ in: query
+ required: false
+ description: 'The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: AdditionalInfo
+ in: query
+ required: false
+ description: Reserved for future use.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ModifyCapacityReservation
+ operationId: POST_ModifyCapacityReservation
+ description: 'Modifies a Capacity Reservation''s capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation''s instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyCapacityReservationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyCapacityReservationRequest'
+ parameters: []
+ /?Action=ModifyCapacityReservationFleet&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyCapacityReservationFleet
+ operationId: GET_ModifyCapacityReservationFleet
+ description: 'Modifies a Capacity Reservation Fleet.
When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyCapacityReservationFleetResult' + parameters: + - name: CapacityReservationFleetId + in: query + required: true + description: The ID of the Capacity Reservation Fleet to modify. + schema: + type: string + - name: TotalTargetCapacity + in: query + required: false + description: 'The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.' + schema: + type: integer + - name: EndDate + in: query + required: false + description: 'The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.
You can''t specify EndDate and RemoveEndDate in the same request.
' + schema: + type: string + format: date-time + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: RemoveEndDate
+ in: query
+ required: false
+ description: 'Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the CancelCapacityReservationFleet action.
You can''t specify RemoveEndDate and EndDate in the same request.
' + schema: + type: boolean + 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' + post: + x-aws-operation-name: ModifyCapacityReservationFleet + operationId: POST_ModifyCapacityReservationFleet + description: 'Modifies a Capacity Reservation Fleet.
When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyCapacityReservationFleetResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyCapacityReservationFleetRequest' + parameters: [] + /?Action=ModifyClientVpnEndpoint&Version=2016-11-15: + get: + x-aws-operation-name: ModifyClientVpnEndpoint + operationId: GET_ModifyClientVpnEndpoint + description: Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyClientVpnEndpointResult' + parameters: + - name: ClientVpnEndpointId + in: query + required: true + description: The ID of the Client VPN endpoint to modify. + schema: + type: string + - name: ServerCertificateArn + in: query + required: false + description: The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM). + schema: + type: string + - name: ConnectionLogOptions + in: query + required: false + description: 'Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
False to delete the existing DNS servers.
+ description: Information about the DNS server to be used.
+ - name: VpnPort
+ in: query
+ required: false
+ description: 'The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
Indicates whether the VPN is split-tunnel.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
' + schema: + type: boolean + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: SecurityGroupId
+ in: query
+ required: false
+ description: The IDs of one or more security groups to apply to the target network.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: item
+ - name: VpcId
+ in: query
+ required: false
+ description: The ID of the VPC to associate with the Client VPN endpoint.
+ schema:
+ type: string
+ - name: SelfServicePortal
+ in: query
+ required: false
+ description: Specify whether to enable the self-service portal for the Client VPN endpoint.
+ schema:
+ type: string
+ enum:
+ - enabled
+ - disabled
+ - name: ClientConnectOptions
+ in: query
+ required: false
+ description: The options for managing connection authorization for new client connections.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
+ description: The options for managing connection authorization for new client connections.
+ - name: SessionTimeoutHours
+ in: query
+ required: false
+ description: 'The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.
ModifyDefaultCreditSpecification is an asynchronous operation, which works at an Amazon Web Services Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyDefaultCreditSpecificationResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceFamily
+ in: query
+ required: true
+ description: The instance family.
+ schema:
+ type: string
+ enum:
+ - t2
+ - t3
+ - t3a
+ - t4g
+ - name: CpuCredits
+ in: query
+ required: true
+ description: 'The credit option for CPU usage of the instance family.
Valid Values: standard | unlimited
Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.
ModifyDefaultCreditSpecification is an asynchronous operation, which works at an Amazon Web Services Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyDefaultCreditSpecificationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyDefaultCreditSpecificationRequest' + parameters: [] + /?Action=ModifyEbsDefaultKmsKeyId&Version=2016-11-15: + get: + x-aws-operation-name: ModifyEbsDefaultKmsKeyId + operationId: GET_ModifyEbsDefaultKmsKeyId + description: 'Changes the default KMS key for EBS encryption by default for your account in this Region.
Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.
If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyEbsDefaultKmsKeyIdResult' + parameters: + - name: KmsKeyId + in: query + required: true + description: 'The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
Amazon EBS does not support asymmetric KMS keys.
' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyEbsDefaultKmsKeyId
+ operationId: POST_ModifyEbsDefaultKmsKeyId
+ description: 'Changes the default KMS key for EBS encryption by default for your account in this Region.
Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.
If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.
For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyEbsDefaultKmsKeyIdResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyEbsDefaultKmsKeyIdRequest' + parameters: [] + /?Action=ModifyFleet&Version=2016-11-15: + get: + x-aws-operation-name: ModifyFleet + operationId: GET_ModifyFleet + description: 'Modifies the specified EC2 Fleet.
You can only modify an EC2 Fleet request of type maintain.
While the EC2 Fleet is being modified, it is in the modifying state.
To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.
If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyFleetResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ExcessCapacityTerminationPolicy
+ in: query
+ required: false
+ description: Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
+ schema:
+ type: string
+ enum:
+ - no-termination
+ - termination
+ - name: LaunchTemplateConfig
+ in: query
+ required: false
+ description: The launch template and overrides.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/FleetLaunchTemplateConfigRequest'
+ - xml:
+ name: item
+ minItems: 0
+ maxItems: 50
+ - name: FleetId
+ in: query
+ required: true
+ description: The ID of the EC2 Fleet.
+ schema:
+ type: string
+ - name: TargetCapacitySpecification
+ in: query
+ required: false
+ description: The size of the EC2 Fleet.
+ schema:
+ type: object
+ required:
+ - TotalTargetCapacity
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TargetCapacityUnitType'
+ - description: 'The unit for the target capacity.
Default: units (translates to number of instances)
The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.
Modifies the specified EC2 Fleet.
You can only modify an EC2 Fleet request of type maintain.
While the EC2 Fleet is being modified, it is in the modifying state.
To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.
If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyFleetResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyFleetRequest' + parameters: [] + /?Action=ModifyFpgaImageAttribute&Version=2016-11-15: + get: + x-aws-operation-name: ModifyFpgaImageAttribute + operationId: GET_ModifyFpgaImageAttribute + description: Modifies the specified attribute of the specified Amazon FPGA Image (AFI). + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyFpgaImageAttributeResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: FpgaImageId
+ in: query
+ required: true
+ description: The ID of the AFI.
+ schema:
+ type: string
+ - name: Attribute
+ in: query
+ required: false
+ description: The name of the attribute.
+ schema:
+ type: string
+ enum:
+ - description
+ - name
+ - loadPermission
+ - productCodes
+ - name: OperationType
+ in: query
+ required: false
+ description: The operation type.
+ schema:
+ type: string
+ enum:
+ - add
+ - remove
+ - name: UserId
+ in: query
+ required: false
+ description: The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: UserId
+ - name: UserGroup
+ in: query
+ required: false
+ description: The user groups. This parameter is valid only when modifying the loadPermission attribute.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: UserGroup
+ - name: ProductCode
+ in: query
+ required: false
+ description: 'The product codes. After you add a product code to an AFI, it can''t be removed. This parameter is valid only when modifying the productCodes attribute.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: ProductCode
+ - name: LoadPermission
+ in: query
+ required: false
+ description: The load permission for the AFI.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/LoadPermissionListRequest'
+ - description: The load permissions to remove.
+ description: Describes modifications to the load permissions of an Amazon FPGA image (AFI).
+ - name: Description
+ in: query
+ required: false
+ description: A description for the AFI.
+ schema:
+ type: string
+ - name: Name
+ in: query
+ required: false
+ description: A name for the AFI.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ModifyFpgaImageAttribute
+ operationId: POST_ModifyFpgaImageAttribute
+ description: Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyFpgaImageAttributeResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyFpgaImageAttributeRequest'
+ parameters: []
+ /?Action=ModifyHosts&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyHosts
+ operationId: GET_ModifyHosts
+ description: 'Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.
You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyHostsResult' + parameters: + - name: AutoPlacement + in: query + required: false + description: Specify whether to enable or disable auto-placement. + schema: + type: string + enum: + - 'on' + - 'off' + - name: HostId + in: query + required: true + description: The IDs of the Dedicated Hosts to modify. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/DedicatedHostId' + - xml: + name: item + - name: HostRecovery + in: query + required: false + description: 'Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.' + schema: + type: string + enum: + - 'on' + - 'off' + - name: InstanceType + in: query + required: false + description: 'Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type.
If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
' + schema: + type: string + - name: InstanceFamily + in: query + required: false + description: 'Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.
If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
' + schema: + type: string + 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' + post: + x-aws-operation-name: ModifyHosts + operationId: POST_ModifyHosts + description: 'Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.
You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyHostsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyHostsRequest' + parameters: [] + /?Action=ModifyIdFormat&Version=2016-11-15: + get: + x-aws-operation-name: ModifyIdFormat + operationId: GET_ModifyIdFormat + description: 'Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you''re using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you''re using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
all to modify the ID format for all IAM users, IAM roles, and the root user of the account.'
+ schema:
+ type: string
+ - name: Resource
+ in: query
+ required: true
+ description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
' + responses: + '200': + description: Success + parameters: + - name: Attribute + in: query + required: false + description: 'The name of the attribute to modify.
Valid values: description | launchPermission
Attribute parameter is launchPermission.
+ schema:
+ type: string
+ enum:
+ - add
+ - remove
+ - name: ProductCode
+ in: query
+ required: false
+ description: Not supported.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: ProductCode
+ - name: UserGroup
+ in: query
+ required: false
+ description: The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: UserGroup
+ - name: UserId
+ in: query
+ required: false
+ description: The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: UserId
+ - name: Value
+ in: query
+ required: false
+ description: The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: OrganizationArn
+ in: query
+ required: false
+ description: The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: OrganizationArn
+ - name: OrganizationalUnitArn
+ in: query
+ required: false
+ description: The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: OrganizationalUnitArn
+ 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'
+ post:
+ x-aws-operation-name: ModifyImageAttribute
+ operationId: POST_ModifyImageAttribute
+ description: 'Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyImageAttributeRequest' + parameters: [] + /?Action=ModifyInstanceAttribute&Version=2016-11-15: + get: + x-aws-operation-name: ModifyInstanceAttribute + operationId: GET_ModifyInstanceAttribute + description: 'Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.
To modify some attributes, the instance must be stopped. For more information, see Modify a stopped instance in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + parameters: + - name: SourceDestCheck + in: query + required: false + description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value istrue, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
+ schema:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The attribute value. The valid values are true or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: Attribute
+ in: query
+ required: false
+ description: The name of the attribute.
+ schema:
+ type: string
+ enum:
+ - instanceType
+ - kernel
+ - ramdisk
+ - userData
+ - disableApiTermination
+ - instanceInitiatedShutdownBehavior
+ - rootDeviceName
+ - blockDeviceMapping
+ - productCodes
+ - sourceDestCheck
+ - groupSet
+ - ebsOptimized
+ - sriovNetSupport
+ - enaSupport
+ - enclaveOptions
+ - name: BlockDeviceMapping
+ in: query
+ required: false
+ description: 'Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceBlockDeviceMappingSpecification' + - xml: + name: item + - name: DisableApiTermination + in: query + required: false + description: 'If the value istrue, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.'
+ schema:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The attribute value. The valid values are true or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: EbsOptimized
+ in: query
+ required: false
+ description: Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
+ schema:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The attribute value. The valid values are true or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: EnaSupport
+ in: query
+ required: false
+ description: Set to true to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
+ schema: + type: object + properties: + value: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: The attribute value. The valid values aretrue or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: GroupId
+ in: query
+ required: false
+ description: '[EC2-VPC] Replaces the security groups of the instance with the specified security groups. You must specify at least one security group, even if it''s just the default security group for the VPC. You must specify the security group ID, not the security group name.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: groupId
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance.
+ schema:
+ type: string
+ - name: InstanceInitiatedShutdownBehavior
+ in: query
+ required: false
+ description: Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
+ schema:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The attribute value. The value is case-sensitive.
+ description: Describes a value for a resource attribute that is a String.
+ - name: InstanceType
+ in: query
+ required: false
+ description: 'Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.'
+ schema:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The attribute value. The value is case-sensitive.
+ description: Describes a value for a resource attribute that is a String.
+ - name: Kernel
+ in: query
+ required: false
+ description: 'Changes the instance''s kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.'
+ schema:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The attribute value. The value is case-sensitive.
+ description: Describes a value for a resource attribute that is a String.
+ - name: Ramdisk
+ in: query
+ required: false
+ description: 'Changes the instance''s RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.'
+ schema:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The attribute value. The value is case-sensitive.
+ description: Describes a value for a resource attribute that is a String.
+ - name: SriovNetSupport
+ in: query
+ required: false
+ description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
+ schema: + type: object + properties: + value: + allOf: + - $ref: '#/components/schemas/String' + - description: The attribute value. The value is case-sensitive. + description: Describes a value for a resource attribute that is a String. + - name: UserData + in: query + required: false + description: 'Changes the instance''s user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.' + schema: + type: object + properties: + value: + $ref: '#/components/schemas/Blob' + - name: Value + in: query + required: false + description: 'A new value for the attribute. Use only with thekernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.'
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ModifyInstanceAttribute
+ operationId: POST_ModifyInstanceAttribute
+ description: 'Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.
To modify some attributes, the instance must be stopped. For more information, see Modify a stopped instance in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyInstanceAttributeRequest' + parameters: [] + /?Action=ModifyInstanceCapacityReservationAttributes&Version=2016-11-15: + get: + x-aws-operation-name: ModifyInstanceCapacityReservationAttributes + operationId: GET_ModifyInstanceCapacityReservationAttributes + description: 'Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in anyopen Capacity Reservation with matching attributes, or run On-Demand Instance capacity.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesResult'
+ parameters:
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance to be modified.
+ schema:
+ type: string
+ - name: CapacityReservationSpecification
+ in: query
+ required: true
+ description: Information about the Capacity Reservation targeting option.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationTarget'
+ - description: Information about the target Capacity Reservation or Capacity Reservation group.
+ description: 'Describes an instance''s Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyInstanceCapacityReservationAttributes
+ operationId: POST_ModifyInstanceCapacityReservationAttributes
+ description: 'Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesRequest'
+ parameters: []
+ /?Action=ModifyInstanceCreditSpecification&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyInstanceCreditSpecification
+ operationId: GET_ModifyInstanceCreditSpecification
+ description: 'Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyInstanceCreditSpecificationResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
+ schema:
+ type: string
+ - name: InstanceCreditSpecification
+ in: query
+ required: true
+ description: Information about the credit option for CPU usage.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceCreditSpecificationRequest'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: ModifyInstanceCreditSpecification
+ operationId: POST_ModifyInstanceCreditSpecification
+ description: 'Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyInstanceCreditSpecificationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyInstanceCreditSpecificationRequest' + parameters: [] + /?Action=ModifyInstanceEventStartTime&Version=2016-11-15: + get: + x-aws-operation-name: ModifyInstanceEventStartTime + operationId: GET_ModifyInstanceEventStartTime + description: Modifies the start time for a scheduled Amazon EC2 instance event. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyInstanceEventStartTimeResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance with the scheduled event.
+ schema:
+ type: string
+ - name: InstanceEventId
+ in: query
+ required: true
+ description: The ID of the event whose date and time you are modifying.
+ schema:
+ type: string
+ - name: NotBefore
+ in: query
+ required: true
+ description: The new date and time when the event will take place.
+ schema:
+ type: string
+ format: date-time
+ 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'
+ post:
+ x-aws-operation-name: ModifyInstanceEventStartTime
+ operationId: POST_ModifyInstanceEventStartTime
+ description: Modifies the start time for a scheduled Amazon EC2 instance event.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyInstanceEventStartTimeResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyInstanceEventStartTimeRequest'
+ parameters: []
+ /?Action=ModifyInstanceEventWindow&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyInstanceEventWindow
+ operationId: GET_ModifyInstanceEventWindow
+ description: 'Modifies the specified event window.
You can define either a set of time ranges or a cron expression when modifying the event window, but not both.
To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.
If Amazon Web Services has already scheduled an event, modifying an event window won''t change the time of the scheduled event.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyInstanceEventWindowResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Name
+ in: query
+ required: false
+ description: The name of the event window.
+ schema:
+ type: string
+ - name: InstanceEventWindowId
+ in: query
+ required: true
+ description: The ID of the event window.
+ schema:
+ type: string
+ - name: TimeRange
+ in: query
+ required: false
+ description: The time ranges of the event window.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest'
+ - name: CronExpression
+ in: query
+ required: false
+ description: 'The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.
Constraints:
Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
' + schema: + type: string + 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' + post: + x-aws-operation-name: ModifyInstanceEventWindow + operationId: POST_ModifyInstanceEventWindow + description: 'Modifies the specified event window.
You can define either a set of time ranges or a cron expression when modifying the event window, but not both.
To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.
If Amazon Web Services has already scheduled an event, modifying an event window won''t change the time of the scheduled event.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyInstanceEventWindowResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyInstanceEventWindowRequest' + parameters: [] + /?Action=ModifyInstanceMaintenanceOptions&Version=2016-11-15: + get: + x-aws-operation-name: ModifyInstanceMaintenanceOptions + operationId: GET_ModifyInstanceMaintenanceOptions + description: 'Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyInstanceMaintenanceOptionsResult' + parameters: + - name: InstanceId + in: query + required: true + description: The ID of the instance. + schema: + type: string + - name: AutoRecovery + in: query + required: false + description: Disables the automatic recovery behavior of your instance or sets it to default. + schema: + type: string + enum: + - disabled + - default + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyInstanceMaintenanceOptions
+ operationId: POST_ModifyInstanceMaintenanceOptions
+ description: 'Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyInstanceMaintenanceOptionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyInstanceMaintenanceOptionsRequest'
+ parameters: []
+ /?Action=ModifyInstanceMetadataOptions&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyInstanceMetadataOptions
+ operationId: GET_ModifyInstanceMetadataOptions
+ description: 'Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyInstanceMetadataOptionsResult'
+ parameters:
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance.
+ schema:
+ type: string
+ - name: HttpTokens
+ in: query
+ required: false
+ description: 'The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
Possible values: Integers from 1 to 64
' + schema: + type: integer + - name: HttpEndpoint + in: query + required: false + description: 'Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
If you specify a value of disabled, you cannot access your instance metadata.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: HttpProtocolIpv6
+ in: query
+ required: false
+ description: Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only if you have enabled the HTTP metadata endpoint.
+ schema:
+ type: string
+ enum:
+ - disabled
+ - enabled
+ - name: InstanceMetadataTags
+ in: query
+ required: false
+ description: 'Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
Modifies the placement attributes for a specified instance. You can do the following:
Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
Change the instance tenancy of an instance.
Move an instance to or from a placement group.
At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.
To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.
The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.
To remove an instance from a placement group, specify an empty string ("").
' + schema: + type: string + - name: HostId + in: query + required: false + description: The ID of the Dedicated Host with which to associate the instance. + schema: + type: string + - name: InstanceId + in: query + required: true + description: The ID of the instance that you are modifying. + schema: + type: string + - name: Tenancy + in: query + required: false + description: 'The tenancy for the instance.
For T3 instances, you can''t change the tenancy from dedicated to host, or from host to dedicated. Attempting to make one of these unsupported tenancy changes results in the InvalidTenancy error code.
partition.
+ schema:
+ type: integer
+ - name: HostResourceGroupArn
+ in: query
+ required: false
+ description: The ARN of the host resource group in which to place the instance.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ModifyInstancePlacement
+ operationId: POST_ModifyInstancePlacement
+ description: 'Modifies the placement attributes for a specified instance. You can do the following:
Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
Change the instance tenancy of an instance.
Move an instance to or from a placement group.
At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.
To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamId
+ in: query
+ required: true
+ description: The ID of the IPAM you want to modify.
+ schema:
+ type: string
+ - name: Description
+ in: query
+ required: false
+ description: The description of the IPAM you want to modify.
+ schema:
+ type: string
+ - name: AddOperatingRegion
+ in: query
+ required: false
+ description: 'Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' + schema: + type: array + items: + $ref: '#/components/schemas/AddIpamOperatingRegion' + minItems: 0 + maxItems: 50 + - name: RemoveOperatingRegion + in: query + required: false + description: The operating Regions to remove. + schema: + type: array + items: + $ref: '#/components/schemas/RemoveIpamOperatingRegion' + minItems: 0 + maxItems: 50 + 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' + post: + x-aws-operation-name: ModifyIpam + operationId: POST_ModifyIpam + description: 'Modify the configurations of an IPAM. ' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyIpamResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyIpamRequest' + parameters: [] + /?Action=ModifyIpamPool&Version=2016-11-15: + get: + x-aws-operation-name: ModifyIpamPool + operationId: GET_ModifyIpamPool + description: 'Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyIpamPoolResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamPoolId
+ in: query
+ required: true
+ description: The ID of the IPAM pool you want to modify.
+ schema:
+ type: string
+ - name: Description
+ in: query
+ required: false
+ description: The description of the IPAM pool you want to modify.
+ schema:
+ type: string
+ - name: AutoImport
+ in: query
+ required: false
+ description: 'If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
' + schema: + type: boolean + - name: AllocationMinNetmaskLength + in: query + required: false + description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length. + schema: + type: integer + minimum: 0 + maximum: 128 + - name: AllocationMaxNetmaskLength + in: query + required: false + description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length. + schema: + type: integer + minimum: 0 + maximum: 128 + - name: AllocationDefaultNetmaskLength + in: query + required: false + description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.' + schema: + type: integer + minimum: 0 + maximum: 128 + - name: ClearAllocationDefaultNetmaskLength + in: query + required: false + description: Clear the default netmask length allocation rule for this pool. + schema: + type: boolean + - name: AddAllocationResourceTag + in: query + required: false + description: 'Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/RequestIpamResourceTag' + - xml: + name: item + - name: RemoveAllocationResourceTag + in: query + required: false + description: Remove tag allocation rules from a pool. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/RequestIpamResourceTag' + - xml: + name: item + 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' + post: + x-aws-operation-name: ModifyIpamPool + operationId: POST_ModifyIpamPool + description: 'Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyIpamPoolResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyIpamPoolRequest' + parameters: [] + /?Action=ModifyIpamResourceCidr&Version=2016-11-15: + get: + x-aws-operation-name: ModifyIpamResourceCidr + operationId: GET_ModifyIpamResourceCidr + description: 'Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.
For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyIpamResourceCidrResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ResourceId
+ in: query
+ required: true
+ description: The ID of the resource you want to modify.
+ schema:
+ type: string
+ - name: ResourceCidr
+ in: query
+ required: true
+ description: The CIDR of the resource you want to modify.
+ schema:
+ type: string
+ - name: ResourceRegion
+ in: query
+ required: true
+ description: The Amazon Web Services Region of the resource you want to modify.
+ schema:
+ type: string
+ - name: CurrentIpamScopeId
+ in: query
+ required: true
+ description: The ID of the current scope that the resource CIDR is in.
+ schema:
+ type: string
+ - name: DestinationIpamScopeId
+ in: query
+ required: false
+ description: The ID of the scope you want to transfer the resource CIDR to.
+ schema:
+ type: string
+ - name: Monitored
+ in: query
+ required: true
+ description: 'Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyIpamResourceCidr
+ operationId: POST_ModifyIpamResourceCidr
+ description: 'Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.
For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyIpamResourceCidrResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyIpamResourceCidrRequest' + parameters: [] + /?Action=ModifyIpamScope&Version=2016-11-15: + get: + x-aws-operation-name: ModifyIpamScope + operationId: GET_ModifyIpamScope + description: Modify an IPAM scope. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyIpamScopeResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamScopeId
+ in: query
+ required: true
+ description: The ID of the scope you want to modify.
+ schema:
+ type: string
+ - name: Description
+ in: query
+ required: false
+ description: The description of the scope you want to modify.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ModifyIpamScope
+ operationId: POST_ModifyIpamScope
+ description: Modify an IPAM scope.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyIpamScopeResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyIpamScopeRequest'
+ parameters: []
+ /?Action=ModifyLaunchTemplate&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyLaunchTemplate
+ operationId: GET_ModifyLaunchTemplate
+ description: 'Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyLaunchTemplateResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ClientToken
+ in: query
+ required: false
+ description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraint: Maximum 128 ASCII characters.
' + schema: + type: string + - name: LaunchTemplateId + in: query + required: false + description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request. + schema: + type: string + - name: LaunchTemplateName + in: query + required: false + description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. + schema: + type: string + pattern: '[a-zA-Z0-9\(\)\.\-/_]+' + minLength: 3 + maxLength: 128 + - name: SetDefaultVersion + in: query + required: false + description: The version number of the launch template to set as the default version. + schema: + type: string + 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' + post: + x-aws-operation-name: ModifyLaunchTemplate + operationId: POST_ModifyLaunchTemplate + description: 'Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyLaunchTemplateResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyLaunchTemplateRequest' + parameters: [] + /?Action=ModifyManagedPrefixList&Version=2016-11-15: + get: + x-aws-operation-name: ModifyManagedPrefixList + operationId: GET_ModifyManagedPrefixList + description: 'Modifies the specified managed prefix list.
Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.
If you specify a current version number that does not match the true current version number, the request fails.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyManagedPrefixListResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PrefixListId
+ in: query
+ required: true
+ description: The ID of the prefix list.
+ schema:
+ type: string
+ - name: CurrentVersion
+ in: query
+ required: false
+ description: The current version of the prefix list.
+ schema:
+ type: integer
+ - name: PrefixListName
+ in: query
+ required: false
+ description: A name for the prefix list.
+ schema:
+ type: string
+ - name: AddEntry
+ in: query
+ required: false
+ description: One or more entries to add to the prefix list.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/AddPrefixListEntry'
+ minItems: 0
+ maxItems: 100
+ - name: RemoveEntry
+ in: query
+ required: false
+ description: One or more entries to remove from the prefix list.
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/RemovePrefixListEntry'
+ minItems: 0
+ maxItems: 100
+ - name: MaxEntries
+ in: query
+ required: false
+ description: 'The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.
If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.
' + schema: + type: integer + 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' + post: + x-aws-operation-name: ModifyManagedPrefixList + operationId: POST_ModifyManagedPrefixList + description: 'Modifies the specified managed prefix list.
Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.
If you specify a current version number that does not match the true current version number, the request fails.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyManagedPrefixListResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyManagedPrefixListRequest' + parameters: [] + /?Action=ModifyNetworkInterfaceAttribute&Version=2016-11-15: + get: + x-aws-operation-name: ModifyNetworkInterfaceAttribute + operationId: GET_ModifyNetworkInterfaceAttribute + description: Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance. + responses: + '200': + description: Success + parameters: + - name: Attachment + in: query + required: false + description: 'Information about the interface attachment. If modifying the ''delete on termination'' attribute, you must specify the ID of the interface attachment.' + schema: + type: object + properties: + attachmentId: + allOf: + - $ref: '#/components/schemas/NetworkInterfaceAttachmentId' + - description: The ID of the network interface attachment. + deleteOnTermination: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Indicates whether the network interface is deleted when the instance is terminated. + description: Describes an attachment change. + - name: Description + in: query + required: false + description: A description for the network interface. + schema: + type: object + properties: + value: + allOf: + - $ref: '#/components/schemas/String' + - description: The attribute value. The value is case-sensitive. + description: Describes a value for a resource attribute that is a String. + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: SecurityGroupId
+ in: query
+ required: false
+ description: 'Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it''s just the default security group in the VPC. You must specify the ID of the security group, not the name.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: SecurityGroupId
+ - name: NetworkInterfaceId
+ in: query
+ required: true
+ description: The ID of the network interface.
+ schema:
+ type: string
+ - name: SourceDestCheck
+ in: query
+ required: false
+ description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
+ schema:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The attribute value. The valid values are true or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ 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'
+ post:
+ x-aws-operation-name: ModifyNetworkInterfaceAttribute
+ operationId: POST_ModifyNetworkInterfaceAttribute
+ description: Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyNetworkInterfaceAttributeRequest'
+ parameters: []
+ /?Action=ModifyPrivateDnsNameOptions&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyPrivateDnsNameOptions
+ operationId: GET_ModifyPrivateDnsNameOptions
+ description: Modifies the options for instance hostnames for the specified instance.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyPrivateDnsNameOptionsResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceId
+ in: query
+ required: false
+ description: The ID of the instance.
+ schema:
+ type: string
+ - name: PrivateDnsHostnameType
+ in: query
+ required: false
+ description: 'The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.'
+ schema:
+ type: string
+ enum:
+ - ip-name
+ - resource-name
+ - name: EnableResourceNameDnsARecord
+ in: query
+ required: false
+ description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
+ schema:
+ type: boolean
+ - name: EnableResourceNameDnsAAAARecord
+ in: query
+ required: false
+ description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyPrivateDnsNameOptions
+ operationId: POST_ModifyPrivateDnsNameOptions
+ description: Modifies the options for instance hostnames for the specified instance.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyPrivateDnsNameOptionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyPrivateDnsNameOptionsRequest'
+ parameters: []
+ /?Action=ModifyReservedInstances&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyReservedInstances
+ operationId: GET_ModifyReservedInstances
+ description: 'Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyReservedInstancesResult' + parameters: + - name: ReservedInstancesId + in: query + required: true + description: The IDs of the Reserved Instances to modify. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/ReservationId' + - xml: + name: ReservedInstancesId + - name: ClientToken + in: query + required: false + description: 'A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.' + schema: + type: string + - name: ReservedInstancesConfigurationSetItemType + in: query + required: true + description: The configuration settings for the Reserved Instances to modify. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/ReservedInstancesConfiguration' + - xml: + name: item + 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' + post: + x-aws-operation-name: ModifyReservedInstances + operationId: POST_ModifyReservedInstances + description: 'Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyReservedInstancesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyReservedInstancesRequest' + parameters: [] + /?Action=ModifySecurityGroupRules&Version=2016-11-15: + get: + x-aws-operation-name: ModifySecurityGroupRules + operationId: GET_ModifySecurityGroupRules + description: Modifies the rules of a security group. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifySecurityGroupRulesResult' + parameters: + - name: GroupId + in: query + required: true + description: The ID of the security group. + schema: + type: string + - name: SecurityGroupRule + in: query + required: true + description: Information about the security group properties to update. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SecurityGroupRuleUpdate' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifySecurityGroupRules
+ operationId: POST_ModifySecurityGroupRules
+ description: Modifies the rules of a security group.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifySecurityGroupRulesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifySecurityGroupRulesRequest'
+ parameters: []
+ /?Action=ModifySnapshotAttribute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifySnapshotAttribute
+ operationId: GET_ModifySnapshotAttribute
+ description: 'Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot''s list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.
Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + parameters: + - name: Attribute + in: query + required: false + description: The snapshot attribute to modify. Only volume creation permissions can be modified. + schema: + type: string + enum: + - productCodes + - createVolumePermission + - name: CreateVolumePermission + in: query + required: false + description: A JSON representation of the snapshot attribute modification. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/CreateVolumePermissionList' + - description: Removes the specified Amazon Web Services account ID or group from the list. + description: Describes modifications to the list of create volume permissions for a volume. + - name: UserGroup + in: query + required: false + description: The group to modify for the snapshot. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SecurityGroupName' + - xml: + name: GroupName + - name: OperationType + in: query + required: false + description: The type of operation to perform to the attribute. + schema: + type: string + enum: + - add + - remove + - name: SnapshotId + in: query + required: true + description: The ID of the snapshot. + schema: + type: string + - name: UserId + in: query + required: false + description: The account ID to modify for the snapshot. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: UserId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifySnapshotAttribute
+ operationId: POST_ModifySnapshotAttribute
+ description: 'Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot''s list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.
Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifySnapshotAttributeRequest' + parameters: [] + /?Action=ModifySnapshotTier&Version=2016-11-15: + get: + x-aws-operation-name: ModifySnapshotTier + operationId: GET_ModifySnapshotTier + description: 'Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifySnapshotTierResult' + parameters: + - name: SnapshotId + in: query + required: true + description: The ID of the snapshot. + schema: + type: string + - name: StorageTier + in: query + required: false + description: The name of the storage tier. You must specifyarchive.
+ schema:
+ type: string
+ enum:
+ - archive
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifySnapshotTier
+ operationId: POST_ModifySnapshotTier
+ description: 'Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifySnapshotTierResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifySnapshotTierRequest'
+ parameters: []
+ /?Action=ModifySpotFleetRequest&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifySpotFleetRequest
+ operationId: GET_ModifySpotFleetRequest
+ description: 'Modifies the specified Spot Fleet request.
You can only modify a Spot Fleet request of type maintain.
While the Spot Fleet request is being modified, it is in the modifying state.
To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacityOptimized, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.
If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifySpotFleetRequestResponse' + parameters: + - name: ExcessCapacityTerminationPolicy + in: query + required: false + description: Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet. + schema: + type: string + enum: + - noTermination + - default + - name: LaunchTemplateConfig + in: query + required: false + description: 'The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateConfig'
+ - xml:
+ name: item
+ - name: SpotFleetRequestId
+ in: query
+ required: true
+ description: The ID of the Spot Fleet request.
+ schema:
+ type: string
+ - name: TargetCapacity
+ in: query
+ required: false
+ description: The size of the fleet.
+ schema:
+ type: integer
+ - name: OnDemandTargetCapacity
+ in: query
+ required: false
+ description: The number of On-Demand Instances in the fleet.
+ schema:
+ type: integer
+ - name: Context
+ in: query
+ required: false
+ description: Reserved.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ModifySpotFleetRequest
+ operationId: POST_ModifySpotFleetRequest
+ description: 'Modifies the specified Spot Fleet request.
You can only modify a Spot Fleet request of type maintain.
While the Spot Fleet request is being modified, it is in the modifying state.
To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacityOptimized, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.
If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifySpotFleetRequestResponse' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifySpotFleetRequestRequest' + parameters: [] + /?Action=ModifySubnetAttribute&Version=2016-11-15: + get: + x-aws-operation-name: ModifySubnetAttribute + operationId: GET_ModifySubnetAttribute + description: 'Modifies a subnet attribute. You can only modify one attribute at a time.
Use this action to modify subnets on Amazon Web Services Outposts.
To modify a subnet on an Outpost rack, set both MapCustomerOwnedIpOnLaunch and CustomerOwnedIpv4Pool. These two parameters act as a single attribute.
To modify a subnet on an Outpost server, set either EnableLniAtDeviceIndex or DisableLniAtDeviceIndex.
For more information about Amazon Web Services Outposts, see the following:
' + responses: + '200': + description: Success + parameters: + - name: AssignIpv6AddressOnCreation + in: query + required: false + description: 'Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that''s created when launching an instance into the subnet (the instance therefore receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it''s created using version 2016-11-15 or later of the Amazon EC2 API.
true or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: MapPublicIpOnLaunch
+ in: query
+ required: false
+ description: Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address.
+ schema:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The attribute value. The valid values are true or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: SubnetId
+ in: query
+ required: true
+ description: The ID of the subnet.
+ schema:
+ type: string
+ - name: MapCustomerOwnedIpOnLaunch
+ in: query
+ required: false
+ description: 'Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
true or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: CustomerOwnedIpv4Pool
+ in: query
+ required: false
+ description: The customer-owned IPv4 address pool associated with the subnet.
You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
true or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: PrivateDnsHostnameTypeOnLaunch
+ in: query
+ required: false
+ description: 'The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).'
+ schema:
+ type: string
+ enum:
+ - ip-name
+ - resource-name
+ - name: EnableResourceNameDnsARecordOnLaunch
+ in: query
+ required: false
+ description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
+ schema:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The attribute value. The valid values are true or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: EnableResourceNameDnsAAAARecordOnLaunch
+ in: query
+ required: false
+ description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
+ schema:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The attribute value. The valid values are true or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: EnableLniAtDeviceIndex
+ in: query
+ required: false
+ description: ' Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1). A local network interface cannot be the primary network interface (eth0). '
+ schema:
+ type: integer
+ - name: DisableLniAtDeviceIndex
+ in: query
+ required: false
+ description: ' Specify true to indicate that local network interfaces at the current position should be disabled. '
+ schema:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The attribute value. The valid values are true or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ 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'
+ post:
+ x-aws-operation-name: ModifySubnetAttribute
+ operationId: POST_ModifySubnetAttribute
+ description: 'Modifies a subnet attribute. You can only modify one attribute at a time.
Use this action to modify subnets on Amazon Web Services Outposts.
To modify a subnet on an Outpost rack, set both MapCustomerOwnedIpOnLaunch and CustomerOwnedIpv4Pool. These two parameters act as a single attribute.
To modify a subnet on an Outpost server, set either EnableLniAtDeviceIndex or DisableLniAtDeviceIndex.
For more information about Amazon Web Services Outposts, see the following:
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifySubnetAttributeRequest' + parameters: [] + /?Action=ModifyTrafficMirrorFilterNetworkServices&Version=2016-11-15: + get: + x-aws-operation-name: ModifyTrafficMirrorFilterNetworkServices + operationId: GET_ModifyTrafficMirrorFilterNetworkServices + description: 'Allows or restricts mirroring network services.
By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyTrafficMirrorFilterNetworkServices
+ operationId: POST_ModifyTrafficMirrorFilterNetworkServices
+ description: 'Allows or restricts mirroring network services.
By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.
Modifies the specified Traffic Mirror rule.
DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.
The properties that you want to remove from the Traffic Mirror filter rule.
When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
' + schema: + type: array + items: + $ref: '#/components/schemas/TrafficMirrorFilterRuleField' + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyTrafficMirrorFilterRule
+ operationId: POST_ModifyTrafficMirrorFilterRule
+ description: Modifies the specified Traffic Mirror rule.
DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.
The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
+ schema: + type: integer + - name: VirtualNetworkId + in: query + required: false + description: The virtual network ID of the Traffic Mirror session. + schema: + type: integer + - name: Description + in: query + required: false + description: The description to assign to the Traffic Mirror session. + schema: + type: string + - name: RemoveField + in: query + required: false + description: 'The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the default.
' + schema: + type: array + items: + $ref: '#/components/schemas/TrafficMirrorSessionField' + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyTrafficMirrorSession
+ operationId: POST_ModifyTrafficMirrorSession
+ description: Modifies a Traffic Mirror session.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyTrafficMirrorSessionResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyTrafficMirrorSessionRequest'
+ parameters: []
+ /?Action=ModifyTransitGateway&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyTransitGateway
+ operationId: GET_ModifyTransitGateway
+ description: 'Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyTransitGatewayResult'
+ parameters:
+ - name: TransitGatewayId
+ in: query
+ required: true
+ description: The ID of the transit gateway.
+ schema:
+ type: string
+ - name: Description
+ in: query
+ required: false
+ description: The description for the transit gateway.
+ schema:
+ type: string
+ - name: Options
+ in: query
+ required: false
+ description: The options to modify.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableId'
+ - description: The ID of the default propagation route table.
+ description: The transit gateway options.
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyTransitGateway
+ operationId: POST_ModifyTransitGateway
+ description: 'Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyTransitGatewayResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyTransitGatewayRequest'
+ parameters: []
+ /?Action=ModifyTransitGatewayPrefixListReference&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyTransitGatewayPrefixListReference
+ operationId: GET_ModifyTransitGatewayPrefixListReference
+ description: Modifies a reference (route) to a prefix list in a specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceResult'
+ parameters:
+ - name: TransitGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the transit gateway route table.
+ schema:
+ type: string
+ - name: PrefixListId
+ in: query
+ required: true
+ description: The ID of the prefix list.
+ schema:
+ type: string
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: false
+ description: The ID of the attachment to which traffic is routed.
+ schema:
+ type: string
+ - name: Blackhole
+ in: query
+ required: false
+ description: Indicates whether to drop traffic that matches this route.
+ schema:
+ type: boolean
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyTransitGatewayPrefixListReference
+ operationId: POST_ModifyTransitGatewayPrefixListReference
+ description: Modifies a reference (route) to a prefix list in a specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceRequest'
+ parameters: []
+ /?Action=ModifyTransitGatewayVpcAttachment&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyTransitGatewayVpcAttachment
+ operationId: GET_ModifyTransitGatewayVpcAttachment
+ description: Modifies the specified VPC attachment.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentResult'
+ parameters:
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: true
+ description: The ID of the attachment.
+ schema:
+ type: string
+ - name: AddSubnetIds
+ in: query
+ required: false
+ description: The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - xml:
+ name: item
+ - name: RemoveSubnetIds
+ in: query
+ required: false
+ description: The IDs of one or more subnets to remove.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - xml:
+ name: item
+ - name: Options
+ in: query
+ required: false
+ description: The new VPC attachment options.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ApplianceModeSupportValue'
+ - description: 'Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.'
+ description: Describes the options for a VPC attachment.
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyTransitGatewayVpcAttachment
+ operationId: POST_ModifyTransitGatewayVpcAttachment
+ description: Modifies the specified VPC attachment.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentRequest'
+ parameters: []
+ /?Action=ModifyVolume&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyVolume
+ operationId: GET_ModifyVolume
+ description: 'You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) or Amazon EBS Elastic Volumes (Windows instances).
When you complete a resize operation on your volume, you need to extend the volume''s file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or Extend a Windows file system.
You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitor the progress of volume modifications.
With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.
After modifying a volume, you must wait at least six hours and ensure that the volume is in the in-use or available state before you can modify the same volume. This is sometimes referred to as a cooldown period.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VolumeId
+ in: query
+ required: true
+ description: The ID of the volume.
+ schema:
+ type: string
+ - name: Size
+ in: query
+ required: false
+ description: 'The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.
The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
Default: The existing size is retained.
' + schema: + type: integer + - name: VolumeType + in: query + required: false + description: 'The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: The existing type is retained.
' + schema: + type: string + enum: + - standard + - io1 + - io2 + - gp2 + - sc1 + - st1 + - gp3 + - name: Iops + in: query + required: false + description: 'The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1, io2, or gp3, the default is 3,000.
The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.
Default: The existing value is retained if the source and target volume type is gp3. Otherwise, the default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
' + schema: + type: integer + - name: MultiAttachEnabled + in: query + required: false + description: 'Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported withio1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyVolume
+ operationId: POST_ModifyVolume
+ description: 'You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) or Amazon EBS Elastic Volumes (Windows instances).
When you complete a resize operation on your volume, you need to extend the volume''s file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or Extend a Windows file system.
You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitor the progress of volume modifications.
With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.
After modifying a volume, you must wait at least six hours and ensure that the volume is in the in-use or available state before you can modify the same volume. This is sometimes referred to as a cooldown period.
Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
' + responses: + '200': + description: Success + parameters: + - name: AutoEnableIO + in: query + required: false + description: Indicates whether the volume should be auto-enabled for I/O operations. + schema: + type: object + properties: + value: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: The attribute value. The valid values aretrue or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: VolumeId
+ in: query
+ required: true
+ description: The ID of the volume.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyVolumeAttribute
+ operationId: POST_ModifyVolumeAttribute
+ description: 'Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVolumeAttributeRequest' + parameters: [] + /?Action=ModifyVpcAttribute&Version=2016-11-15: + get: + x-aws-operation-name: ModifyVpcAttribute + operationId: GET_ModifyVpcAttribute + description: Modifies the specified attribute of the specified VPC. + responses: + '200': + description: Success + parameters: + - name: EnableDnsHostnames + in: query + required: false + description: 'Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you''ve enabled DNS support.
' + schema: + type: object + properties: + value: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: The attribute value. The valid values aretrue or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: EnableDnsSupport
+ in: query
+ required: false
+ description: 'Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
' + schema: + type: object + properties: + value: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: The attribute value. The valid values aretrue or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ - name: VpcId
+ in: query
+ required: true
+ description: The ID of the VPC.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ModifyVpcAttribute
+ operationId: POST_ModifyVpcAttribute
+ description: Modifies the specified attribute of the specified VPC.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpcAttributeRequest'
+ parameters: []
+ /?Action=ModifyVpcEndpoint&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyVpcEndpoint
+ operationId: GET_ModifyVpcEndpoint
+ description: 'Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpcEndpointResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcEndpointId
+ in: query
+ required: true
+ description: The ID of the endpoint.
+ schema:
+ type: string
+ - name: ResetPolicy
+ in: query
+ required: false
+ description: (Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.
+ schema:
+ type: boolean
+ - name: PolicyDocument
+ in: query
+ required: false
+ description: (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.
+ schema:
+ type: string
+ - name: AddRouteTableId
+ in: query
+ required: false
+ description: (Gateway endpoint) One or more route tables IDs to associate with the endpoint.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableId'
+ - xml:
+ name: item
+ - name: RemoveRouteTableId
+ in: query
+ required: false
+ description: (Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableId'
+ - xml:
+ name: item
+ - name: AddSubnetId
+ in: query
+ required: false
+ description: '(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - xml:
+ name: item
+ - name: RemoveSubnetId
+ in: query
+ required: false
+ description: (Interface endpoint) One or more subnets IDs in which to remove the endpoint.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - xml:
+ name: item
+ - name: AddSecurityGroupId
+ in: query
+ required: false
+ description: (Interface endpoint) One or more security group IDs to associate with the network interface.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: item
+ - name: RemoveSecurityGroupId
+ in: query
+ required: false
+ description: (Interface endpoint) One or more security group IDs to disassociate from the network interface.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: item
+ - name: IpAddressType
+ in: query
+ required: false
+ description: The IP address type for the endpoint.
+ schema:
+ type: string
+ enum:
+ - ipv4
+ - dualstack
+ - ipv6
+ - name: DnsOptions
+ in: query
+ required: false
+ description: The DNS options for the endpoint.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/DnsRecordIpType'
+ - description: The DNS records created for the endpoint.
+ description: Describes the DNS options for an endpoint.
+ - name: PrivateDnsEnabled
+ in: query
+ required: false
+ description: (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyVpcEndpoint
+ operationId: POST_ModifyVpcEndpoint
+ description: 'Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpcEndpointResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpcEndpointRequest'
+ parameters: []
+ /?Action=ModifyVpcEndpointConnectionNotification&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyVpcEndpointConnectionNotification
+ operationId: GET_ModifyVpcEndpointConnectionNotification
+ description: 'Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified. '
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ConnectionNotificationId
+ in: query
+ required: true
+ description: The ID of the notification.
+ schema:
+ type: string
+ - name: ConnectionNotificationArn
+ in: query
+ required: false
+ description: The ARN for the SNS topic for the notification.
+ schema:
+ type: string
+ - name: ConnectionEvents
+ in: query
+ required: false
+ description: 'One or more events for the endpoint. Valid values are Accept, Connect, Delete, and Reject.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: ModifyVpcEndpointConnectionNotification
+ operationId: POST_ModifyVpcEndpointConnectionNotification
+ description: 'Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified. '
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationRequest'
+ parameters: []
+ /?Action=ModifyVpcEndpointServiceConfiguration&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyVpcEndpointServiceConfiguration
+ operationId: GET_ModifyVpcEndpointServiceConfiguration
+ description: 'Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ServiceId
+ in: query
+ required: true
+ description: The ID of the service.
+ schema:
+ type: string
+ - name: PrivateDnsName
+ in: query
+ required: false
+ description: (Interface endpoint configuration) The private DNS name to assign to the endpoint service.
+ schema:
+ type: string
+ - name: RemovePrivateDnsName
+ in: query
+ required: false
+ description: (Interface endpoint configuration) Removes the private DNS name of the endpoint service.
+ schema:
+ type: boolean
+ - name: AcceptanceRequired
+ in: query
+ required: false
+ description: Indicates whether requests to create an endpoint to your service must be accepted.
+ schema:
+ type: boolean
+ - name: AddNetworkLoadBalancerArn
+ in: query
+ required: false
+ description: The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: RemoveNetworkLoadBalancerArn
+ in: query
+ required: false
+ description: The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: AddGatewayLoadBalancerArn
+ in: query
+ required: false
+ description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: RemoveGatewayLoadBalancerArn
+ in: query
+ required: false
+ description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: AddSupportedIpAddressType
+ in: query
+ required: false
+ description: The IP address types to add to your service configuration.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: RemoveSupportedIpAddressType
+ in: query
+ required: false
+ description: The IP address types to remove from your service configuration.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: ModifyVpcEndpointServiceConfiguration
+ operationId: POST_ModifyVpcEndpointServiceConfiguration
+ description: 'Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationRequest' + parameters: [] + /?Action=ModifyVpcEndpointServicePayerResponsibility&Version=2016-11-15: + get: + x-aws-operation-name: ModifyVpcEndpointServicePayerResponsibility + operationId: GET_ModifyVpcEndpointServicePayerResponsibility + description: Modifies the payer responsibility for your VPC endpoint service. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcEndpointServicePayerResponsibilityResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ServiceId
+ in: query
+ required: true
+ description: The ID of the service.
+ schema:
+ type: string
+ - name: PayerResponsibility
+ in: query
+ required: true
+ description: 'The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.'
+ schema:
+ type: string
+ enum:
+ - ServiceOwner
+ 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'
+ post:
+ x-aws-operation-name: ModifyVpcEndpointServicePayerResponsibility
+ operationId: POST_ModifyVpcEndpointServicePayerResponsibility
+ description: Modifies the payer responsibility for your VPC endpoint service.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpcEndpointServicePayerResponsibilityResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpcEndpointServicePayerResponsibilityRequest'
+ parameters: []
+ /?Action=ModifyVpcEndpointServicePermissions&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyVpcEndpointServicePermissions
+ operationId: GET_ModifyVpcEndpointServicePermissions
+ description: 'Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.
If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ServiceId
+ in: query
+ required: true
+ description: The ID of the service.
+ schema:
+ type: string
+ - name: AddAllowedPrincipals
+ in: query
+ required: false
+ description: 'The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: RemoveAllowedPrincipals
+ in: query
+ required: false
+ description: The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: ModifyVpcEndpointServicePermissions
+ operationId: POST_ModifyVpcEndpointServicePermissions
+ description: 'Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.
If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsRequest' + parameters: [] + /?Action=ModifyVpcPeeringConnectionOptions&Version=2016-11-15: + get: + x-aws-operation-name: ModifyVpcPeeringConnectionOptions + operationId: GET_ModifyVpcPeeringConnectionOptions + description: 'Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
Enable/disable communication over the peering connection between an EC2-Classic instance that''s linked to your VPC (using ClassicLink) and instances in the peer VPC.
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that''s linked to the peer VPC.
Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsResult' + parameters: + - name: AccepterPeeringConnectionOptions + in: query + required: false + description: The VPC peering connection options for the accepter VPC. + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that''s linked to a peer VPC using ClassicLink.' + description: The VPC peering connection options. + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: RequesterPeeringConnectionOptions
+ in: query
+ required: false
+ description: The VPC peering connection options for the requester VPC.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that''s linked to a peer VPC using ClassicLink.'
+ description: The VPC peering connection options.
+ - name: VpcPeeringConnectionId
+ in: query
+ required: true
+ description: The ID of the VPC peering connection.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ModifyVpcPeeringConnectionOptions
+ operationId: POST_ModifyVpcPeeringConnectionOptions
+ description: 'Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
Enable/disable communication over the peering connection between an EC2-Classic instance that''s linked to your VPC (using ClassicLink) and instances in the peer VPC.
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that''s linked to the peer VPC.
Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsRequest' + parameters: [] + /?Action=ModifyVpcTenancy&Version=2016-11-15: + get: + x-aws-operation-name: ModifyVpcTenancy + operationId: GET_ModifyVpcTenancy + description: 'Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated.
After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.
For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcTenancyResult' + parameters: + - name: VpcId + in: query + required: true + description: The ID of the VPC. + schema: + type: string + - name: InstanceTenancy + in: query + required: true + description: 'The instance tenancy attribute for the VPC. ' + schema: + type: string + enum: + - default + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyVpcTenancy
+ operationId: POST_ModifyVpcTenancy
+ description: 'Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated.
After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.
For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcTenancyResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpcTenancyRequest' + parameters: [] + /?Action=ModifyVpnConnection&Version=2016-11-15: + get: + x-aws-operation-name: ModifyVpnConnection + operationId: GET_ModifyVpnConnection + description: 'Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:
An existing virtual private gateway to a new virtual private gateway
An existing virtual private gateway to a transit gateway
An existing transit gateway to a new transit gateway
An existing transit gateway to a virtual private gateway
Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.
This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.
You must delete the static routes before you migrate to the new gateway.
Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.
After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route tables in the Amazon Web Services Site-to-Site VPN User Guide.
When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.
If you deleted VPN static routes, you must add the static routes to the transit gateway route table.
After you perform this operation, the VPN endpoint''s IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpnConnectionResult' + parameters: + - name: VpnConnectionId + in: query + required: true + description: The ID of the VPN connection. + schema: + type: string + - name: TransitGatewayId + in: query + required: false + description: The ID of the transit gateway. + schema: + type: string + - name: CustomerGatewayId + in: query + required: false + description: The ID of the customer gateway at your end of the VPN connection. + schema: + type: string + - name: VpnGatewayId + in: query + required: false + description: The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyVpnConnection
+ operationId: POST_ModifyVpnConnection
+ description: 'Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:
An existing virtual private gateway to a new virtual private gateway
An existing virtual private gateway to a transit gateway
An existing transit gateway to a new transit gateway
An existing transit gateway to a virtual private gateway
Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.
This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.
You must delete the static routes before you migrate to the new gateway.
Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.
After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route tables in the Amazon Web Services Site-to-Site VPN User Guide.
When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.
If you deleted VPN static routes, you must add the static routes to the transit gateway route table.
After you perform this operation, the VPN endpoint''s IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpnConnectionResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpnConnectionRequest' + parameters: [] + /?Action=ModifyVpnConnectionOptions&Version=2016-11-15: + get: + x-aws-operation-name: ModifyVpnConnectionOptions + operationId: GET_ModifyVpnConnectionOptions + description: 'Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpnConnectionOptionsResult' + parameters: + - name: VpnConnectionId + in: query + required: true + description: 'The ID of the Site-to-Site VPN connection. ' + schema: + type: string + - name: LocalIpv4NetworkCidr + in: query + required: false + description: 'The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
Default: 0.0.0.0/0
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyVpnConnectionOptions
+ operationId: POST_ModifyVpnConnectionOptions
+ description: 'Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpnConnectionOptionsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpnConnectionOptionsRequest' + parameters: [] + /?Action=ModifyVpnTunnelCertificate&Version=2016-11-15: + get: + x-aws-operation-name: ModifyVpnTunnelCertificate + operationId: GET_ModifyVpnTunnelCertificate + description: Modifies the VPN tunnel endpoint certificate. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ModifyVpnTunnelCertificateResult' + parameters: + - name: VpnConnectionId + in: query + required: true + description: The ID of the Amazon Web Services Site-to-Site VPN connection. + schema: + type: string + - name: VpnTunnelOutsideIpAddress + in: query + required: true + description: The external IP address of the VPN tunnel. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyVpnTunnelCertificate
+ operationId: POST_ModifyVpnTunnelCertificate
+ description: Modifies the VPN tunnel endpoint certificate.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpnTunnelCertificateResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpnTunnelCertificateRequest'
+ parameters: []
+ /?Action=ModifyVpnTunnelOptions&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ModifyVpnTunnelOptions
+ operationId: GET_ModifyVpnTunnelOptions
+ description: 'Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpnTunnelOptionsResult'
+ parameters:
+ - name: VpnConnectionId
+ in: query
+ required: true
+ description: The ID of the Amazon Web Services Site-to-Site VPN connection.
+ schema:
+ type: string
+ - name: VpnTunnelOutsideIpAddress
+ in: query
+ required: true
+ description: The external IP address of the VPN tunnel.
+ schema:
+ type: string
+ - name: TunnelOptions
+ in: query
+ required: true
+ description: The tunnel options to modify.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ModifyVpnTunnelOptions
+ operationId: POST_ModifyVpnTunnelOptions
+ description: 'Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpnTunnelOptionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ModifyVpnTunnelOptionsRequest'
+ parameters: []
+ /?Action=MonitorInstances&Version=2016-11-15:
+ get:
+ x-aws-operation-name: MonitorInstances
+ operationId: GET_MonitorInstances
+ description: 'Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.
To disable detailed monitoring, see UnmonitorInstances.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/MonitorInstancesResult' + parameters: + - name: InstanceId + in: query + required: true + description: The IDs of the instances. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceId' + - xml: + name: InstanceId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: MonitorInstances
+ operationId: POST_MonitorInstances
+ description: 'Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.
To disable detailed monitoring, see UnmonitorInstances.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/MonitorInstancesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/MonitorInstancesRequest' + parameters: [] + /?Action=MoveAddressToVpc&Version=2016-11-15: + get: + x-aws-operation-name: MoveAddressToVpc + operationId: GET_MoveAddressToVpc + description: 'Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform. ' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/MoveAddressToVpcResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PublicIp
+ in: query
+ required: true
+ description: The Elastic IP address.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: MoveAddressToVpc
+ operationId: POST_MoveAddressToVpc
+ description: 'Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform. '
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/MoveAddressToVpcResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/MoveAddressToVpcRequest'
+ parameters: []
+ /?Action=MoveByoipCidrToIpam&Version=2016-11-15:
+ get:
+ x-aws-operation-name: MoveByoipCidrToIpam
+ operationId: GET_MoveByoipCidrToIpam
+ description: 'Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.
If you already have an IPv4 BYOIP CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/MoveByoipCidrToIpamResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Cidr
+ in: query
+ required: true
+ description: The BYOIP CIDR.
+ schema:
+ type: string
+ - name: IpamPoolId
+ in: query
+ required: true
+ description: The IPAM pool ID.
+ schema:
+ type: string
+ - name: IpamPoolOwner
+ in: query
+ required: true
+ description: The Amazon Web Services account ID of the owner of the IPAM pool.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: MoveByoipCidrToIpam
+ operationId: POST_MoveByoipCidrToIpam
+ description: 'Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.
If you already have an IPv4 BYOIP CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/MoveByoipCidrToIpamResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/MoveByoipCidrToIpamRequest' + parameters: [] + /?Action=ProvisionByoipCidr&Version=2016-11-15: + get: + x-aws-operation-name: ProvisionByoipCidr + operationId: GET_ProvisionByoipCidr + description: 'Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
' + schema: + type: boolean + - name: Description + in: query + required: false + description: A description for the address range and the address pool. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PoolTagSpecification
+ in: query
+ required: false
+ description: The tags to apply to the address pool.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: MultiRegion
+ in: query
+ required: false
+ description: Reserved.
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ProvisionByoipCidr
+ operationId: POST_ProvisionByoipCidr
+ description: 'Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.
For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ProvisionIpamPoolCidrResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamPoolId
+ in: query
+ required: true
+ description: The ID of the IPAM pool to which you want to assign a CIDR.
+ schema:
+ type: string
+ - name: Cidr
+ in: query
+ required: false
+ description: The CIDR you want to assign to the IPAM pool.
+ schema:
+ type: string
+ - name: CidrAuthorizationContext
+ in: query
+ required: false
+ description: A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The signed authorization message for the prefix and account.
+ description: A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
+ 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'
+ post:
+ x-aws-operation-name: ProvisionIpamPoolCidr
+ operationId: POST_ProvisionIpamPoolCidr
+ description: 'Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.
For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ProvisionIpamPoolCidrResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ProvisionIpamPoolCidrRequest' + parameters: [] + /?Action=ProvisionPublicIpv4PoolCidr&Version=2016-11-15: + get: + x-aws-operation-name: ProvisionPublicIpv4PoolCidr + operationId: GET_ProvisionPublicIpv4PoolCidr + description: 'Provision a CIDR to a public IPv4 pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ProvisionPublicIpv4PoolCidrResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamPoolId
+ in: query
+ required: true
+ description: The ID of the IPAM pool you would like to use to allocate this CIDR.
+ schema:
+ type: string
+ - name: PoolId
+ in: query
+ required: true
+ description: The ID of the public IPv4 pool you would like to use for this CIDR.
+ schema:
+ type: string
+ - name: NetmaskLength
+ in: query
+ required: true
+ description: The netmask length of the CIDR you would like to allocate to the public IPv4 pool.
+ schema:
+ type: integer
+ 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'
+ post:
+ x-aws-operation-name: ProvisionPublicIpv4PoolCidr
+ operationId: POST_ProvisionPublicIpv4PoolCidr
+ description: 'Provision a CIDR to a public IPv4 pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ProvisionPublicIpv4PoolCidrResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ProvisionPublicIpv4PoolCidrRequest' + parameters: [] + /?Action=PurchaseHostReservation&Version=2016-11-15: + get: + x-aws-operation-name: PurchaseHostReservation + operationId: GET_PurchaseHostReservation + description: Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/PurchaseHostReservationResult' + parameters: + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' + schema: + type: string + - name: CurrencyCode + in: query + required: false + description: 'The currency in which thetotalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.'
+ schema:
+ type: string
+ enum:
+ - USD
+ - name: HostIdSet
+ in: query
+ required: true
+ description: The IDs of the Dedicated Hosts with which the reservation will be associated.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DedicatedHostId'
+ - xml:
+ name: item
+ - name: LimitPrice
+ in: query
+ required: false
+ description: 'The specified limit is checked against the total upfront cost of the reservation (calculated as the offering''s upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.'
+ schema:
+ type: string
+ - name: OfferingId
+ in: query
+ required: true
+ description: The ID of the offering.
+ schema:
+ type: string
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply to the Dedicated Host Reservation during purchase.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: PurchaseHostReservation
+ operationId: POST_PurchaseHostReservation
+ description: Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/PurchaseHostReservationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/PurchaseHostReservationRequest'
+ parameters: []
+ /?Action=PurchaseReservedInstancesOffering&Version=2016-11-15:
+ get:
+ x-aws-operation-name: PurchaseReservedInstancesOffering
+ operationId: GET_PurchaseReservedInstancesOffering
+ description: 'Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you''ve purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/PurchaseReservedInstancesOfferingResult' + parameters: + - name: InstanceCount + in: query + required: true + description: The number of Reserved Instances to purchase. + schema: + type: integer + - name: ReservedInstancesOfferingId + in: query + required: true + description: The ID of the Reserved Instance offering to purchase. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: LimitPrice
+ in: query
+ required: false
+ description: Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
+ schema:
+ type: object
+ properties:
+ amount:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
+ currencyCode:
+ allOf:
+ - $ref: '#/components/schemas/CurrencyCodeValues'
+ - description: 'The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.'
+ description: Describes the limit price of a Reserved Instance offering.
+ - name: PurchaseTime
+ in: query
+ required: false
+ description: 'The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ schema:
+ type: string
+ format: date-time
+ 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'
+ post:
+ x-aws-operation-name: PurchaseReservedInstancesOffering
+ operationId: POST_PurchaseReservedInstancesOffering
+ description: 'Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you''ve purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/PurchaseReservedInstancesOfferingResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/PurchaseReservedInstancesOfferingRequest' + parameters: [] + /?Action=PurchaseScheduledInstances&Version=2016-11-15: + get: + x-aws-operation-name: PurchaseScheduledInstances + operationId: GET_PurchaseScheduledInstances + description: 'Purchases the Scheduled Instances with the specified schedule.
Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.
After you purchase a Scheduled Instance, you can''t cancel, modify, or resell your purchase.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/PurchaseScheduledInstancesResult' + parameters: + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PurchaseRequest
+ in: query
+ required: true
+ description: The purchase requests.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PurchaseRequest'
+ - xml:
+ name: PurchaseRequest
+ minItems: 1
+ 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'
+ post:
+ x-aws-operation-name: PurchaseScheduledInstances
+ operationId: POST_PurchaseScheduledInstances
+ description: 'Purchases the Scheduled Instances with the specified schedule.
Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.
After you purchase a Scheduled Instance, you can''t cancel, modify, or resell your purchase.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/PurchaseScheduledInstancesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/PurchaseScheduledInstancesRequest' + parameters: [] + /?Action=RebootInstances&Version=2016-11-15: + get: + x-aws-operation-name: RebootInstances + operationId: GET_RebootInstances + description: 'Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Troubleshoot an unreachable instance in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + parameters: + - name: InstanceId + in: query + required: true + description: The instance IDs. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceId' + - xml: + name: InstanceId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: RebootInstances
+ operationId: POST_RebootInstances
+ description: 'Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Troubleshoot an unreachable instance in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/RebootInstancesRequest' + parameters: [] + /?Action=RegisterImage&Version=2016-11-15: + get: + x-aws-operation-name: RegisterImage + operationId: GET_RegisterImage + description: 'Registers an AMI. When you''re creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating your own AMIs in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don''t have to register the AMI yourself.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can''t set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
Amazon Web Services Marketplace product codes
If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RegisterImageResult' + parameters: + - name: ImageLocation + in: query + required: false + description: 'The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have theaws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.'
+ schema:
+ type: string
+ - name: Architecture
+ in: query
+ required: false
+ description: 'The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
The block device mapping entries.
If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can''t specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/BlockDeviceMapping' + - xml: + name: BlockDeviceMapping + - name: Description + in: query + required: false + description: A description for your AMI. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: EnaSupport
+ in: query
+ required: false
+ description: Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
+ schema: + type: boolean + - name: KernelId + in: query + required: false + description: The ID of the kernel. + schema: + type: string + - name: Name + in: query + required: true + description: 'A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)
' + schema: + type: string + - name: BillingProduct + in: query + required: false + description: 'The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the Amazon Web Services Marketplace to bill for the use of an AMI.' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + - name: RamdiskId + in: query + required: false + description: The ID of the RAM disk. + schema: + type: string + - name: RootDeviceName + in: query + required: false + description: 'The device name of the root device volume (for example,/dev/sda1).'
+ schema:
+ type: string
+ - name: SriovNetSupport
+ in: query
+ required: false
+ description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
+ schema: + type: string + - name: VirtualizationType + in: query + required: false + description: 'The type of virtualization (hvm | paravirtual).
Default: paravirtual
v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.'
+ schema:
+ type: string
+ enum:
+ - v2.0
+ - name: UefiData
+ in: query
+ required: false
+ description: 'Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.'
+ schema:
+ type: string
+ minLength: 0
+ maxLength: 64000
+ 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'
+ post:
+ x-aws-operation-name: RegisterImage
+ operationId: POST_RegisterImage
+ description: 'Registers an AMI. When you''re creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating your own AMIs in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don''t have to register the AMI yourself.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can''t set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
Amazon Web Services Marketplace product codes
If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RegisterImageResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/RegisterImageRequest' + parameters: [] + /?Action=RegisterInstanceEventNotificationAttributes&Version=2016-11-15: + get: + x-aws-operation-name: RegisterInstanceEventNotificationAttributes + operationId: GET_RegisterInstanceEventNotificationAttributes + description: 'Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use DeregisterInstanceEventNotificationAttributes.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RegisterInstanceEventNotificationAttributesResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceTagAttribute
+ in: query
+ required: false
+ description: Information about the tag keys to register.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to register all tag keys in the current Region. Specify true to register all tag keys.
+ InstanceTagKey:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTagKeySet'
+ - description: The tag keys to register.
+ description: Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
+ 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'
+ post:
+ x-aws-operation-name: RegisterInstanceEventNotificationAttributes
+ operationId: POST_RegisterInstanceEventNotificationAttributes
+ description: 'Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use DeregisterInstanceEventNotificationAttributes.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RegisterInstanceEventNotificationAttributesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/RegisterInstanceEventNotificationAttributesRequest' + parameters: [] + /?Action=RegisterTransitGatewayMulticastGroupMembers&Version=2016-11-15: + get: + x-aws-operation-name: RegisterTransitGatewayMulticastGroupMembers + operationId: GET_RegisterTransitGatewayMulticastGroupMembers + description: 'Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupMembersResult' + parameters: + - name: TransitGatewayMulticastDomainId + in: query + required: false + description: The ID of the transit gateway multicast domain. + schema: + type: string + - name: GroupIpAddress + in: query + required: false + description: The IP address assigned to the transit gateway multicast group. + schema: + type: string + - name: NetworkInterfaceIds + in: query + required: false + description: The group members' network interface IDs to register with the transit gateway multicast group. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/NetworkInterfaceId' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: RegisterTransitGatewayMulticastGroupMembers
+ operationId: POST_RegisterTransitGatewayMulticastGroupMembers
+ description: 'Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupMembersResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupMembersRequest' + parameters: [] + /?Action=RegisterTransitGatewayMulticastGroupSources&Version=2016-11-15: + get: + x-aws-operation-name: RegisterTransitGatewayMulticastGroupSources + operationId: GET_RegisterTransitGatewayMulticastGroupSources + description: 'Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupSourcesResult' + parameters: + - name: TransitGatewayMulticastDomainId + in: query + required: false + description: The ID of the transit gateway multicast domain. + schema: + type: string + - name: GroupIpAddress + in: query + required: false + description: The IP address assigned to the transit gateway multicast group. + schema: + type: string + - name: NetworkInterfaceIds + in: query + required: false + description: The group sources' network interface IDs to register with the transit gateway multicast group. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/NetworkInterfaceId' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: RegisterTransitGatewayMulticastGroupSources
+ operationId: POST_RegisterTransitGatewayMulticastGroupSources
+ description: 'Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupSourcesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupSourcesRequest' + parameters: [] + /?Action=RejectTransitGatewayMulticastDomainAssociations&Version=2016-11-15: + get: + x-aws-operation-name: RejectTransitGatewayMulticastDomainAssociations + operationId: GET_RejectTransitGatewayMulticastDomainAssociations + description: Rejects a request to associate cross-account subnets with a transit gateway multicast domain. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RejectTransitGatewayMulticastDomainAssociationsResult' + parameters: + - name: TransitGatewayMulticastDomainId + in: query + required: false + description: The ID of the transit gateway multicast domain. + schema: + type: string + - name: TransitGatewayAttachmentId + in: query + required: false + description: The ID of the transit gateway attachment. + schema: + type: string + - name: SubnetIds + in: query + required: false + description: The IDs of the subnets to associate with the transit gateway multicast domain. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: RejectTransitGatewayMulticastDomainAssociations
+ operationId: POST_RejectTransitGatewayMulticastDomainAssociations
+ description: Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RejectTransitGatewayMulticastDomainAssociationsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RejectTransitGatewayMulticastDomainAssociationsRequest'
+ parameters: []
+ /?Action=RejectTransitGatewayPeeringAttachment&Version=2016-11-15:
+ get:
+ x-aws-operation-name: RejectTransitGatewayPeeringAttachment
+ operationId: GET_RejectTransitGatewayPeeringAttachment
+ description: Rejects a transit gateway peering attachment request.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentResult'
+ parameters:
+ - name: TransitGatewayAttachmentId
+ in: query
+ required: true
+ description: The ID of the transit gateway peering attachment.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: RejectTransitGatewayPeeringAttachment
+ operationId: POST_RejectTransitGatewayPeeringAttachment
+ description: Rejects a transit gateway peering attachment request.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentRequest'
+ parameters: []
+ /?Action=RejectTransitGatewayVpcAttachment&Version=2016-11-15:
+ get:
+ x-aws-operation-name: RejectTransitGatewayVpcAttachment
+ operationId: GET_RejectTransitGatewayVpcAttachment
+ description: Rejects a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: RejectTransitGatewayVpcAttachment
+ operationId: POST_RejectTransitGatewayVpcAttachment
+ description: Rejects a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ServiceId
+ in: query
+ required: true
+ description: The ID of the service.
+ schema:
+ type: string
+ - name: VpcEndpointId
+ in: query
+ required: true
+ description: The IDs of one or more VPC endpoints.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointId'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: RejectVpcEndpointConnections
+ operationId: POST_RejectVpcEndpointConnections
+ description: Rejects one or more VPC endpoint connection requests to your VPC endpoint service.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RejectVpcEndpointConnectionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RejectVpcEndpointConnectionsRequest'
+ parameters: []
+ /?Action=RejectVpcPeeringConnection&Version=2016-11-15:
+ get:
+ x-aws-operation-name: RejectVpcPeeringConnection
+ operationId: GET_RejectVpcPeeringConnection
+ description: 'Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RejectVpcPeeringConnectionResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcPeeringConnectionId
+ in: query
+ required: true
+ description: The ID of the VPC peering connection.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: RejectVpcPeeringConnection
+ operationId: POST_RejectVpcPeeringConnection
+ description: 'Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RejectVpcPeeringConnectionResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RejectVpcPeeringConnectionRequest'
+ parameters: []
+ /?Action=ReleaseAddress&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ReleaseAddress
+ operationId: GET_ReleaseAddress
+ description: 'Releases the specified Elastic IP address.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it''s associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you''ll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.
' + responses: + '200': + description: Success + parameters: + - name: AllocationId + in: query + required: false + description: '[EC2-VPC] The allocation ID. Required for EC2-VPC.' + schema: + type: string + - name: PublicIp + in: query + required: false + description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.' + schema: + type: string + - name: NetworkBorderGroup + in: query + required: false + description: 'The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you receive an InvalidParameterCombination error.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ReleaseAddress
+ operationId: POST_ReleaseAddress
+ description: 'Releases the specified Elastic IP address.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it''s associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.
[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).
After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you''ll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ReleaseAddressRequest' + parameters: [] + /?Action=ReleaseHosts&Version=2016-11-15: + get: + x-aws-operation-name: ReleaseHosts + operationId: GET_ReleaseHosts + description: 'When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.
When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.
Released hosts still appear in a DescribeHosts response.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ReleaseHostsResult' + parameters: + - name: HostId + in: query + required: true + description: The IDs of the Dedicated Hosts to release. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/DedicatedHostId' + - xml: + name: item + 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' + post: + x-aws-operation-name: ReleaseHosts + operationId: POST_ReleaseHosts + description: 'When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.
When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.
Released hosts still appear in a DescribeHosts response.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ReleaseHostsResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ReleaseHostsRequest' + parameters: [] + /?Action=ReleaseIpamPoolAllocation&Version=2016-11-15: + get: + x-aws-operation-name: ReleaseIpamPoolAllocation + operationId: GET_ReleaseIpamPoolAllocation + description: 'Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide. ' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ReleaseIpamPoolAllocationResult' + parameters: + - name: DryRun + in: query + required: false + description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: IpamPoolId
+ in: query
+ required: true
+ description: The ID of the IPAM pool which contains the allocation you want to release.
+ schema:
+ type: string
+ - name: Cidr
+ in: query
+ required: true
+ description: The CIDR of the allocation you want to release.
+ schema:
+ type: string
+ - name: IpamPoolAllocationId
+ in: query
+ required: true
+ description: The ID of the allocation.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ReleaseIpamPoolAllocation
+ operationId: POST_ReleaseIpamPoolAllocation
+ description: 'Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide. '
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ReleaseIpamPoolAllocationResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ReleaseIpamPoolAllocationRequest'
+ parameters: []
+ /?Action=ReplaceIamInstanceProfileAssociation&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ReplaceIamInstanceProfileAssociation
+ operationId: GET_ReplaceIamInstanceProfileAssociation
+ description: Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.
Use DescribeIamInstanceProfileAssociations to get the association ID.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationResult' + parameters: + - name: IamInstanceProfile + in: query + required: true + description: The IAM instance profile. + schema: + type: object + properties: + arn: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Resource Name (ARN) of the instance profile. + name: + allOf: + - $ref: '#/components/schemas/String' + - description: The name of the instance profile. + description: Describes an IAM instance profile. + - name: AssociationId + in: query + required: true + description: The ID of the existing IAM instance profile association. + schema: + type: string + 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' + post: + x-aws-operation-name: ReplaceIamInstanceProfileAssociation + operationId: POST_ReplaceIamInstanceProfileAssociation + description:Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.
Use DescribeIamInstanceProfileAssociations to get the association ID.
+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationRequest' + parameters: [] + /?Action=ReplaceNetworkAclAssociation&Version=2016-11-15: + get: + x-aws-operation-name: ReplaceNetworkAclAssociation + operationId: GET_ReplaceNetworkAclAssociation + description: 'Changes which network ACL a subnet is associated with. By default when you create a subnet, it''s automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
This is an idempotent operation.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ReplaceNetworkAclAssociationResult' + parameters: + - name: AssociationId + in: query + required: true + description: The ID of the current association between the original network ACL and the subnet. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NetworkAclId
+ in: query
+ required: true
+ description: The ID of the new network ACL to associate with the subnet.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ReplaceNetworkAclAssociation
+ operationId: POST_ReplaceNetworkAclAssociation
+ description: 'Changes which network ACL a subnet is associated with. By default when you create a subnet, it''s automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
This is an idempotent operation.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ReplaceNetworkAclAssociationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ReplaceNetworkAclAssociationRequest' + parameters: [] + /?Action=ReplaceNetworkAclEntry&Version=2016-11-15: + get: + x-aws-operation-name: ReplaceNetworkAclEntry + operationId: GET_ReplaceNetworkAclEntry + description: 'Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.' + responses: + '200': + description: Success + parameters: + - name: CidrBlock + in: query + required: false + description: 'The IPv4 network range to allow or deny, in CIDR notation (for example172.16.0.0/24).'
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Egress
+ in: query
+ required: true
+ description: 'Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
' + schema: + type: boolean + - name: Icmp + in: query + required: false + description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.' + schema: + type: object + properties: + code: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The ICMP code. A value of -1 means all codes for the specified ICMP type. + type: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The ICMP type. A value of -1 means all types. + description: Describes the ICMP type and code. + - name: Ipv6CidrBlock + in: query + required: false + description: 'The IPv6 network range to allow or deny, in CIDR notation (for example2001:bd8:1234:1a00::/64).'
+ schema:
+ type: string
+ - name: NetworkAclId
+ in: query
+ required: true
+ description: The ID of the ACL.
+ schema:
+ type: string
+ - name: PortRange
+ in: query
+ required: false
+ description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).'
+ schema:
+ type: object
+ properties:
+ from:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The first port in the range.
+ to:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The last port in the range.
+ description: Describes a range of ports.
+ - name: Protocol
+ in: query
+ required: true
+ description: 'The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.'
+ schema:
+ type: string
+ - name: RuleAction
+ in: query
+ required: true
+ description: Indicates whether to allow or deny the traffic that matches the rule.
+ schema:
+ type: string
+ enum:
+ - allow
+ - deny
+ - name: RuleNumber
+ in: query
+ required: true
+ description: The rule number of the entry to replace.
+ schema:
+ type: integer
+ 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'
+ post:
+ x-aws-operation-name: ReplaceNetworkAclEntry
+ operationId: POST_ReplaceNetworkAclEntry
+ description: 'Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ReplaceNetworkAclEntryRequest'
+ parameters: []
+ /?Action=ReplaceRoute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ReplaceRoute
+ operationId: GET_ReplaceRoute
+ description: 'Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + parameters: + - name: DestinationCidrBlock + in: query + required: false + description: The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table. + schema: + type: string + - name: DestinationIpv6CidrBlock + in: query + required: false + description: The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table. + schema: + type: string + - name: DestinationPrefixListId + in: query + required: false + description: The ID of the prefix list for the route. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: VpcEndpointId
+ in: query
+ required: false
+ description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
+ schema:
+ type: string
+ - name: EgressOnlyInternetGatewayId
+ in: query
+ required: false
+ description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
+ schema:
+ type: string
+ - name: GatewayId
+ in: query
+ required: false
+ description: The ID of an internet gateway or virtual private gateway.
+ schema:
+ type: string
+ - name: InstanceId
+ in: query
+ required: false
+ description: The ID of a NAT instance in your VPC.
+ schema:
+ type: string
+ - name: LocalTarget
+ in: query
+ required: false
+ description: Specifies whether to reset the local route to its default target (local).
+ schema:
+ type: boolean
+ - name: NatGatewayId
+ in: query
+ required: false
+ description: '[IPv4 traffic only] The ID of a NAT gateway.'
+ schema:
+ type: string
+ - name: TransitGatewayId
+ in: query
+ required: false
+ description: The ID of a transit gateway.
+ schema:
+ type: string
+ - name: LocalGatewayId
+ in: query
+ required: false
+ description: The ID of the local gateway.
+ schema:
+ type: string
+ - name: CarrierGatewayId
+ in: query
+ required: false
+ description: '[IPv4 traffic only] The ID of a carrier gateway.'
+ schema:
+ type: string
+ - name: NetworkInterfaceId
+ in: query
+ required: false
+ description: The ID of a network interface.
+ schema:
+ type: string
+ - name: RouteTableId
+ in: query
+ required: true
+ description: The ID of the route table.
+ schema:
+ type: string
+ - name: VpcPeeringConnectionId
+ in: query
+ required: false
+ description: The ID of a VPC peering connection.
+ schema:
+ type: string
+ - name: CoreNetworkArn
+ in: query
+ required: false
+ description: The Amazon Resource Name (ARN) of the core network.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ReplaceRoute
+ operationId: POST_ReplaceRoute
+ description: 'Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ReplaceRouteRequest' + parameters: [] + /?Action=ReplaceRouteTableAssociation&Version=2016-11-15: + get: + x-aws-operation-name: ReplaceRouteTableAssociation + operationId: GET_ReplaceRouteTableAssociation + description: 'Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
You can also use this operation to change which table is the main route table in the VPC. Specify the main route table''s association ID and the route table ID of the new main route table.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ReplaceRouteTableAssociationResult' + parameters: + - name: AssociationId + in: query + required: true + description: The association ID. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: RouteTableId
+ in: query
+ required: true
+ description: The ID of the new route table to associate with the subnet.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ReplaceRouteTableAssociation
+ operationId: POST_ReplaceRouteTableAssociation
+ description: 'Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.
You can also use this operation to change which table is the main route table in the VPC. Specify the main route table''s association ID and the route table ID of the new main route table.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ReplaceRouteTableAssociationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ReplaceRouteTableAssociationRequest' + parameters: [] + /?Action=ReplaceTransitGatewayRoute&Version=2016-11-15: + get: + x-aws-operation-name: ReplaceTransitGatewayRoute + operationId: GET_ReplaceTransitGatewayRoute + description: Replaces the specified route in the specified transit gateway route table. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ReplaceTransitGatewayRouteResult' + parameters: + - name: DestinationCidrBlock + in: query + required: true + description: The CIDR range used for the destination match. Routing decisions are based on the most specific match. + schema: + type: string + - name: TransitGatewayRouteTableId + in: query + required: true + description: The ID of the route table. + schema: + type: string + - name: TransitGatewayAttachmentId + in: query + required: false + description: The ID of the attachment. + schema: + type: string + - name: Blackhole + in: query + required: false + description: Indicates whether traffic matching this route is to be dropped. + schema: + type: boolean + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ReplaceTransitGatewayRoute
+ operationId: POST_ReplaceTransitGatewayRoute
+ description: Replaces the specified route in the specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ReplaceTransitGatewayRouteResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ReplaceTransitGatewayRouteRequest'
+ parameters: []
+ /?Action=ReportInstanceStatus&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ReportInstanceStatus
+ operationId: GET_ReportInstanceStatus
+ description: 'Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
' + responses: + '200': + description: Success + parameters: + - name: Description + in: query + required: false + description: Descriptive text about the health state of your instance. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: EndTime
+ in: query
+ required: false
+ description: The time at which the reported instance health state ended.
+ schema:
+ type: string
+ format: date-time
+ - name: InstanceId
+ in: query
+ required: true
+ description: The instances.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - xml:
+ name: InstanceId
+ - name: ReasonCode
+ in: query
+ required: true
+ description: 'The reason codes that describe the health state of your instance.
instance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems that I believe are network related.
performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ReportInstanceStatusRequest' + parameters: [] + /?Action=RequestSpotFleet&Version=2016-11-15: + get: + x-aws-operation-name: RequestSpotFleet + operationId: GET_RequestSpotFleet + description: 'Creates a Spot Fleet request.
The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.
You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.
Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.
You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported.
For more information, see Spot Fleet requests in the Amazon EC2 User Guide for Linux Instances.
We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: SpotFleetRequestConfig
+ in: query
+ required: true
+ description: The configuration for the Spot Fleet request.
+ schema:
+ type: object
+ required:
+ - IamFleetRole
+ - TargetCapacity
+ properties:
+ allocationStrategy:
+ allOf:
+ - $ref: '#/components/schemas/AllocationStrategy'
+ - description: 'Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.
If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.'
+ spotMaintenanceStrategies:
+ allOf:
+ - $ref: '#/components/schemas/SpotMaintenanceStrategies'
+ - description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.'
+ excessCapacityTerminationPolicy:
+ allOf:
+ - $ref: '#/components/schemas/ExcessCapacityTerminationPolicy'
+ - description: Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
+ fulfilledCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
+ onDemandFulfilledCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
+ iamFleetRole:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.'
+ launchSpecifications:
+ allOf:
+ - $ref: '#/components/schemas/LaunchSpecsList'
+ - description: 'The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can''t specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.'
+ launchTemplateConfigs:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateConfigList'
+ - description: 'The launch template and overrides. If you specify LaunchTemplateConfigs, you can''t specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.'
+ spotPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
+ targetCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.'
+ onDemandTargetCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.'
+ onDemandMaxTotalPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The maximum amount per hour for On-Demand Instances that you''re willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.'
+ spotMaxTotalPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The maximum amount per hour for Spot Instances that you''re willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.'
+ terminateInstancesWithExpiration:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
+ type:
+ allOf:
+ - $ref: '#/components/schemas/FleetType'
+ - description: 'The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.'
+ validFrom:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.'
+ validUntil:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.'
+ replaceUnhealthyInstances:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether Spot Fleet should replace unhealthy instances.
+ instanceInterruptionBehavior:
+ allOf:
+ - $ref: '#/components/schemas/InstanceInterruptionBehavior'
+ - description: The behavior when a Spot Instance is interrupted. The default is terminate.
+ loadBalancersConfig:
+ allOf:
+ - $ref: '#/components/schemas/LoadBalancersConfig'
+ - description: 'One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
' + instancePoolsToUseCount: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
' + context: + allOf: + - $ref: '#/components/schemas/String' + - description: Reserved. + targetCapacityUnitType: + allOf: + - $ref: '#/components/schemas/TargetCapacityUnitType' + - description: 'The unit for the target capacity.
Default: units (translates to number of instances)
ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.'
+ description: Describes the configuration of a Spot Fleet request.
+ 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'
+ post:
+ x-aws-operation-name: RequestSpotFleet
+ operationId: POST_RequestSpotFleet
+ description: 'Creates a Spot Fleet request.
The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.
You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.
Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.
You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported.
For more information, see Spot Fleet requests in the Amazon EC2 User Guide for Linux Instances.
We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.
Creates a Spot Instance request.
For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.
We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.
The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
' + schema: + type: string + - name: BlockDurationMinutes + in: query + required: false + description: Deprecated. + schema: + type: integer + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceCount
+ in: query
+ required: false
+ description: 'The maximum number of Spot Instances to launch.
Default: 1
' + schema: + type: integer + - name: LaunchGroup + in: query + required: false + description: 'The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
' + schema: + type: string + - name: LaunchSpecification + in: query + required: false + description: The launch specification. + schema: + type: object + properties: + SecurityGroupId: + allOf: + - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupIdList' + - description: One or more security group IDs. + SecurityGroup: + allOf: + - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupList' + - description: 'One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.' + addressingType: + allOf: + - $ref: '#/components/schemas/String' + - description: Deprecated. + blockDeviceMapping: + allOf: + - $ref: '#/components/schemas/BlockDeviceMappingList' + - description: 'One or more block device mapping entries. You can''t specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.' + ebsOptimized: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Indicates whether basic or detailed monitoring is enabled for the instance.
Default: Disabled
' + NetworkInterface: + allOf: + - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecificationList' + - description: 'One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.' + placement: + allOf: + - $ref: '#/components/schemas/SpotPlacement' + - description: The placement information for the instance. + ramdiskId: + allOf: + - $ref: '#/components/schemas/RamdiskId' + - description: The ID of the RAM disk. + subnetId: + allOf: + - $ref: '#/components/schemas/SubnetId' + - description: The ID of the subnet in which to launch the instance. + userData: + allOf: + - $ref: '#/components/schemas/String' + - description: The Base64-encoded user data for the instance. User data is limited to 16 KB. + description: Describes the launch specification for an instance. + - name: SpotPrice + in: query + required: false + description: The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. + schema: + type: string + - name: Type + in: query + required: false + description: 'The Spot Instance request type.
Default: one-time
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.
' + schema: + type: string + format: date-time + - name: ValidUntil + in: query + required: false + description: 'The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags. '
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: InstanceInterruptionBehavior
+ in: query
+ required: false
+ description: The behavior when a Spot Instance is interrupted. The default is terminate.
+ schema:
+ type: string
+ enum:
+ - hibernate
+ - stop
+ - terminate
+ 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'
+ post:
+ x-aws-operation-name: RequestSpotInstances
+ operationId: POST_RequestSpotInstances
+ description: 'Creates a Spot Instance request.
For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.
We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ResetAddressAttribute
+ operationId: POST_ResetAddressAttribute
+ description: 'Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ResetAddressAttributeResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ResetAddressAttributeRequest'
+ parameters: []
+ /?Action=ResetEbsDefaultKmsKeyId&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ResetEbsDefaultKmsKeyId
+ operationId: GET_ResetEbsDefaultKmsKeyId
+ description: 'Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.
After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ResetEbsDefaultKmsKeyIdResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ResetEbsDefaultKmsKeyId
+ operationId: POST_ResetEbsDefaultKmsKeyId
+ description: 'Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.
After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ResetEbsDefaultKmsKeyIdResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ResetEbsDefaultKmsKeyIdRequest' + parameters: [] + /?Action=ResetFpgaImageAttribute&Version=2016-11-15: + get: + x-aws-operation-name: ResetFpgaImageAttribute + operationId: GET_ResetFpgaImageAttribute + description: Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ResetFpgaImageAttributeResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: FpgaImageId
+ in: query
+ required: true
+ description: The ID of the AFI.
+ schema:
+ type: string
+ - name: Attribute
+ in: query
+ required: false
+ description: The attribute.
+ schema:
+ type: string
+ enum:
+ - loadPermission
+ 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'
+ post:
+ x-aws-operation-name: ResetFpgaImageAttribute
+ operationId: POST_ResetFpgaImageAttribute
+ description: Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ResetFpgaImageAttributeResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ResetFpgaImageAttributeRequest'
+ parameters: []
+ /?Action=ResetImageAttribute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ResetImageAttribute
+ operationId: GET_ResetImageAttribute
+ description: Resets an attribute of an AMI to its default value.
+ responses:
+ '200':
+ description: Success
+ parameters:
+ - name: Attribute
+ in: query
+ required: true
+ description: The attribute to reset (currently you can only reset the launch permission attribute).
+ schema:
+ type: string
+ enum:
+ - launchPermission
+ - name: ImageId
+ in: query
+ required: true
+ description: The ID of the AMI.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ResetImageAttribute
+ operationId: POST_ResetImageAttribute
+ description: Resets an attribute of an AMI to its default value.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ResetImageAttributeRequest'
+ parameters: []
+ /?Action=ResetInstanceAttribute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ResetInstanceAttribute
+ operationId: GET_ResetInstanceAttribute
+ description: 'Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.
The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide.
The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceId
+ in: query
+ required: true
+ description: The ID of the instance.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ResetInstanceAttribute
+ operationId: POST_ResetInstanceAttribute
+ description: 'Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.
The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: NetworkInterfaceId
+ in: query
+ required: true
+ description: The ID of the network interface.
+ schema:
+ type: string
+ - name: SourceDestCheck
+ in: query
+ required: false
+ description: The source/destination checking attribute. Resets the value to true.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: ResetNetworkInterfaceAttribute
+ operationId: POST_ResetNetworkInterfaceAttribute
+ description: Resets a network interface attribute. You can specify only one attribute at a time.
+ responses:
+ '200':
+ description: Success
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/ResetNetworkInterfaceAttributeRequest'
+ parameters: []
+ /?Action=ResetSnapshotAttribute&Version=2016-11-15:
+ get:
+ x-aws-operation-name: ResetSnapshotAttribute
+ operationId: GET_ResetSnapshotAttribute
+ description: 'Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + parameters: + - name: Attribute + in: query + required: true + description: 'The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.' + schema: + type: string + enum: + - productCodes + - createVolumePermission + - name: SnapshotId + in: query + required: true + description: The ID of the snapshot. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: ResetSnapshotAttribute
+ operationId: POST_ResetSnapshotAttribute
+ description: 'Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/ResetSnapshotAttributeRequest' + parameters: [] + /?Action=RestoreAddressToClassic&Version=2016-11-15: + get: + x-aws-operation-name: RestoreAddressToClassic + operationId: GET_RestoreAddressToClassic + description: Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RestoreAddressToClassicResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PublicIp
+ in: query
+ required: true
+ description: The Elastic IP address.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: RestoreAddressToClassic
+ operationId: POST_RestoreAddressToClassic
+ description: Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RestoreAddressToClassicResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RestoreAddressToClassicRequest'
+ parameters: []
+ /?Action=RestoreImageFromRecycleBin&Version=2016-11-15:
+ get:
+ x-aws-operation-name: RestoreImageFromRecycleBin
+ operationId: GET_RestoreImageFromRecycleBin
+ description: 'Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RestoreImageFromRecycleBinResult'
+ parameters:
+ - name: ImageId
+ in: query
+ required: true
+ description: The ID of the AMI to restore.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: RestoreImageFromRecycleBin
+ operationId: POST_RestoreImageFromRecycleBin
+ description: 'Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RestoreImageFromRecycleBinResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RestoreImageFromRecycleBinRequest'
+ parameters: []
+ /?Action=RestoreManagedPrefixListVersion&Version=2016-11-15:
+ get:
+ x-aws-operation-name: RestoreManagedPrefixListVersion
+ operationId: GET_RestoreManagedPrefixListVersion
+ description: Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RestoreManagedPrefixListVersionResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: PrefixListId
+ in: query
+ required: true
+ description: The ID of the prefix list.
+ schema:
+ type: string
+ - name: PreviousVersion
+ in: query
+ required: true
+ description: The version to restore.
+ schema:
+ type: integer
+ - name: CurrentVersion
+ in: query
+ required: true
+ description: The current version number for the prefix list.
+ schema:
+ type: integer
+ 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'
+ post:
+ x-aws-operation-name: RestoreManagedPrefixListVersion
+ operationId: POST_RestoreManagedPrefixListVersion
+ description: Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RestoreManagedPrefixListVersionResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RestoreManagedPrefixListVersionRequest'
+ parameters: []
+ /?Action=RestoreSnapshotFromRecycleBin&Version=2016-11-15:
+ get:
+ x-aws-operation-name: RestoreSnapshotFromRecycleBin
+ operationId: GET_RestoreSnapshotFromRecycleBin
+ description: 'Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RestoreSnapshotFromRecycleBinResult'
+ parameters:
+ - name: SnapshotId
+ in: query
+ required: true
+ description: The ID of the snapshot to restore.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: RestoreSnapshotFromRecycleBin
+ operationId: POST_RestoreSnapshotFromRecycleBin
+ description: 'Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RestoreSnapshotFromRecycleBinResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RestoreSnapshotFromRecycleBinRequest'
+ parameters: []
+ /?Action=RestoreSnapshotTier&Version=2016-11-15:
+ get:
+ x-aws-operation-name: RestoreSnapshotTier
+ operationId: GET_RestoreSnapshotTier
+ description: 'Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.
For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RestoreSnapshotTierResult' + parameters: + - name: SnapshotId + in: query + required: true + description: The ID of the snapshot to restore. + schema: + type: string + - name: TemporaryRestoreDays + in: query + required: false + description: 'Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore parameter or set it to false.
true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.'
+ schema:
+ type: boolean
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: RestoreSnapshotTier
+ operationId: POST_RestoreSnapshotTier
+ description: 'Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.
For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RestoreSnapshotTierResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/RestoreSnapshotTierRequest' + parameters: [] + /?Action=RevokeClientVpnIngress&Version=2016-11-15: + get: + x-aws-operation-name: RevokeClientVpnIngress + operationId: GET_RevokeClientVpnIngress + description: 'Removes an ingress authorization rule from a Client VPN endpoint. ' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RevokeClientVpnIngressResult' + parameters: + - name: ClientVpnEndpointId + in: query + required: true + description: The ID of the Client VPN endpoint with which the authorization rule is associated. + schema: + type: string + - name: TargetNetworkCidr + in: query + required: true + description: 'The IPv4 address range, in CIDR notation, of the network for which access is being removed.' + schema: + type: string + - name: AccessGroupId + in: query + required: false + description: 'The ID of the Active Directory group for which to revoke access. ' + schema: + type: string + - name: RevokeAllGroups + in: query + required: false + description: Indicates whether access should be revoked for all clients. + schema: + type: boolean + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: RevokeClientVpnIngress
+ operationId: POST_RevokeClientVpnIngress
+ description: 'Removes an ingress authorization rule from a Client VPN endpoint. '
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RevokeClientVpnIngressResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/RevokeClientVpnIngressRequest'
+ parameters: []
+ /?Action=RevokeSecurityGroupEgress&Version=2016-11-15:
+ get:
+ x-aws-operation-name: RevokeSecurityGroupEgress
+ operationId: GET_RevokeSecurityGroupEgress
+ description: '[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule''s values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
[Default VPC] If the values you specify do not match the existing rule''s values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RevokeSecurityGroupEgressResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: GroupId
+ in: query
+ required: true
+ description: The ID of the security group.
+ schema:
+ type: string
+ - name: IpPermissions
+ in: query
+ required: false
+ description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpPermission'
+ - xml:
+ name: item
+ - name: SecurityGroupRuleId
+ in: query
+ required: false
+ description: The IDs of the security group rules.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ - name: CidrIp
+ in: query
+ required: false
+ description: Not supported. Use a set of IP permissions to specify the CIDR.
+ schema:
+ type: string
+ - name: FromPort
+ in: query
+ required: false
+ description: Not supported. Use a set of IP permissions to specify the port.
+ schema:
+ type: integer
+ - name: IpProtocol
+ in: query
+ required: false
+ description: Not supported. Use a set of IP permissions to specify the protocol name or number.
+ schema:
+ type: string
+ - name: ToPort
+ in: query
+ required: false
+ description: Not supported. Use a set of IP permissions to specify the port.
+ schema:
+ type: integer
+ - name: SourceSecurityGroupName
+ in: query
+ required: false
+ description: Not supported. Use a set of IP permissions to specify a destination security group.
+ schema:
+ type: string
+ - name: SourceSecurityGroupOwnerId
+ in: query
+ required: false
+ description: Not supported. Use a set of IP permissions to specify a destination security group.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: RevokeSecurityGroupEgress
+ operationId: POST_RevokeSecurityGroupEgress
+ description: '[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule''s values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
[Default VPC] If the values you specify do not match the existing rule''s values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RevokeSecurityGroupEgressResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/RevokeSecurityGroupEgressRequest' + parameters: [] + /?Action=RevokeSecurityGroupIngress&Version=2016-11-15: + get: + x-aws-operation-name: RevokeSecurityGroupIngress + operationId: GET_RevokeSecurityGroupIngress + description: 'Removes the specified inbound (ingress) rules from a security group.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule''s values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
[EC2-Classic, default VPC] If the values you specify do not match the existing rule''s values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RevokeSecurityGroupIngressResult' + parameters: + - name: CidrIp + in: query + required: false + description: The CIDR IP address range. You can't specify this parameter when specifying a source security group. + schema: + type: string + - name: FromPort + in: query + required: false + description: 'The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use-1 to specify all ICMP types.'
+ schema:
+ type: integer
+ - name: GroupId
+ in: query
+ required: false
+ description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.'
+ schema:
+ type: string
+ - name: GroupName
+ in: query
+ required: false
+ description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.'
+ schema:
+ type: string
+ - name: IpPermissions
+ in: query
+ required: false
+ description: The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpPermission'
+ - xml:
+ name: item
+ - name: IpProtocol
+ in: query
+ required: false
+ description: 'The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.'
+ schema:
+ type: string
+ - name: SourceSecurityGroupName
+ in: query
+ required: false
+ description: '[EC2-Classic, default VPC] The name of the source security group. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.'
+ schema:
+ type: string
+ - name: SourceSecurityGroupOwnerId
+ in: query
+ required: false
+ description: '[EC2-Classic] The Amazon Web Services account ID of the source security group, if the source security group is in a different account. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.'
+ schema:
+ type: string
+ - name: ToPort
+ in: query
+ required: false
+ description: 'The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.'
+ schema:
+ type: integer
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: SecurityGroupRuleId
+ in: query
+ required: false
+ description: The IDs of the security group rules.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: RevokeSecurityGroupIngress
+ operationId: POST_RevokeSecurityGroupIngress
+ description: 'Removes the specified inbound (ingress) rules from a security group.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule''s values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
[EC2-Classic, default VPC] If the values you specify do not match the existing rule''s values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RevokeSecurityGroupIngressResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/RevokeSecurityGroupIngressRequest' + parameters: [] + /?Action=RunInstances&Version=2016-11-15: + get: + x-aws-operation-name: RunInstances + operationId: GET_RunInstances + description: 'Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
[EC2-VPC] If you don''t specify a subnet ID, we choose a default subnet from your default VPC for you. If you don''t have a default VPC, you must specify a subnet ID in the request.
[EC2-Classic] If don''t specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC.
[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don''t specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance types.
If you don''t specify a security group ID, we use the default security group. For more information, see Security groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it''s in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.
For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/Reservation' + parameters: + - name: BlockDeviceMapping + in: query + required: false + description: 'The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/BlockDeviceMapping' + - xml: + name: BlockDeviceMapping + - name: ImageId + in: query + required: false + description: The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template. + schema: + type: string + - name: InstanceType + in: query + required: false + description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
Default: m1.small
[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you''ve specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
' + schema: + type: integer + - name: Ipv6Address + in: query + required: false + description: '[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you''ve specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceIpv6Address' + - xml: + name: item + - name: KernelId + in: query + required: false + description: 'The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can''t connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.
Constraints: Between 1 and the maximum number you''re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.
' + schema: + type: integer + - name: MinCount + in: query + required: true + description: 'The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you''re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
' + schema: + type: integer + - name: Monitoring + in: query + required: false + description: Specifies whether detailed monitoring is enabled for the instance. + schema: + type: object + required: + - Enabled + properties: + enabled: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.' + description: Describes the monitoring of an instance. + - name: Placement + in: query + required: false + description: The placement for the instance. + schema: + type: object + properties: + availabilityZone: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet.
' + affinity: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
' + groupName: + allOf: + - $ref: '#/components/schemas/PlacementGroupName' + - description: The name of the placement group the instance is in. + partitionNumber: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.
This parameter is not supported by CreateFleet.
' + hostId: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
' + tenancy: + allOf: + - $ref: '#/components/schemas/Tenancy' + - description: 'The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
T3 instances that use the unlimited CPU credit option do not support host tenancy.
Reserved for future use.
This parameter is not supported by CreateFleet.
' + hostResourceGroupArn: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
This parameter is not supported by CreateFleet.
' + description: Describes the placement of an instance. + - name: RamdiskId + in: query + required: false + description: 'The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SecurityGroupId' + - xml: + name: SecurityGroupId + - name: SecurityGroup + in: query + required: false + description: '[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/SecurityGroupName' + - xml: + name: SecurityGroup + - name: SubnetId + in: query + required: false + description: '[EC2-VPC] The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
' + schema: + type: string + - name: UserData + in: query + required: false + description: 'The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.' + schema: + type: string + format: password + - name: AdditionalInfo + in: query + required: false + description: Reserved. + schema: + type: string + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
' + schema: + type: string + - name: DisableApiTermination + in: query + required: false + description: 'If you set this parameter to true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: EbsOptimized
+ in: query
+ required: false
+ description: 'Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can''t specify this option if you''ve specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you''re launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
' + schema: + type: string + - name: ElasticGpuSpecification + in: query + required: false + description: 'An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/ElasticGpuSpecification' + - xml: + name: item + - name: ElasticInferenceAccelerator + in: query + required: false + description:An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
+ schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/ElasticInferenceAccelerator' + - xml: + name: item + - name: TagSpecification + in: query + required: false + description: 'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/TagSpecification' + - xml: + name: item + - name: LaunchTemplate + in: query + required: false + description: 'The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.' + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The version number of the launch template.
Default: The default version for the launch template.
' + description: 'The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.' + - name: InstanceMarketOptions + in: query + required: false + description: 'The market (purchasing) option for the instances.
For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.
The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.
Default: standard (T2 instances) or unlimited (T3/T3a instances)
For T3 instances with host tenancy, only standard is supported.
standard and unlimited.'
+ description: 'The credit option for CPU usage of a T2, T3, or T3a instance.'
+ - name: CpuOptions
+ in: query
+ required: false
+ description: 'The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.'
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.'
+ description: The CPU options for the instance. Both the core count and threads per core must be specified in the request.
+ - name: CapacityReservationSpecification
+ in: query
+ required: false
+ description: 'Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationTarget'
+ - description: Information about the target Capacity Reservation or Capacity Reservation group.
+ description: 'Describes an instance''s Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.
Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
You can''t enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
' + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'If you set this parameter to true, your instance is enabled for hibernation.
Default: false
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
You can''t enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
' + schema: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter totrue.'
+ description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.'
+ - name: PrivateDnsNameOptions
+ in: query
+ required: false
+ description: The options for the instance hostname. The default values are inherited from the subnet.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
+ description: Describes the options for instance hostnames.
+ - name: MaintenanceOptions
+ in: query
+ required: false
+ description: The maintenance and recovery options for the instance.
+ schema:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/InstanceAutoRecoveryState'
+ - description: 'Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.'
+ description: The maintenance options for the instance.
+ 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'
+ post:
+ x-aws-operation-name: RunInstances
+ operationId: POST_RunInstances
+ description: 'Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
[EC2-VPC] If you don''t specify a subnet ID, we choose a default subnet from your default VPC for you. If you don''t have a default VPC, you must specify a subnet ID in the request.
[EC2-Classic] If don''t specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC.
[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don''t specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance types.
If you don''t specify a security group ID, we use the default security group. For more information, see Security groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it''s in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.
For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/Reservation' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/RunInstancesRequest' + parameters: [] + /?Action=RunScheduledInstances&Version=2016-11-15: + get: + x-aws-operation-name: RunScheduledInstances + operationId: GET_RunScheduledInstances + description: 'Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can''t stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RunScheduledInstancesResult' + parameters: + - name: ClientToken + in: query + required: false + description: 'Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: InstanceCount
+ in: query
+ required: false
+ description: 'The number of instances.
Default: 1
' + schema: + type: integer + - name: LaunchSpecification + in: query + required: true + description: 'The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.' + schema: + type: object + required: + - ImageId + properties: + BlockDeviceMapping: + allOf: + - $ref: '#/components/schemas/ScheduledInstancesMonitoring' + - description: Enable or disable monitoring for the instances. + NetworkInterface: + allOf: + - $ref: '#/components/schemas/RamdiskId' + - description: The ID of the RAM disk. + SecurityGroupId: + allOf: + - $ref: '#/components/schemas/String' + - description: The base64-encoded MIME user data. + description: 'Describes the launch specification for a Scheduled Instance.
If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.
Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can''t stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/RunScheduledInstancesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/RunScheduledInstancesRequest' + parameters: [] + /?Action=SearchLocalGatewayRoutes&Version=2016-11-15: + get: + x-aws-operation-name: SearchLocalGatewayRoutes + operationId: GET_SearchLocalGatewayRoutes + description: Searches for routes in the specified local gateway route table. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/SearchLocalGatewayRoutesResult' + parameters: + - name: LocalGatewayRouteTableId + in: query + required: true + description: The ID of the local gateway route table. + schema: + type: string + - name: Filter + in: query + required: false + description: 'One or more filters.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route.
type - The route type.
nextToken value.'
+ schema:
+ type: integer
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: SearchLocalGatewayRoutes
+ operationId: POST_SearchLocalGatewayRoutes
+ description: Searches for routes in the specified local gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/SearchLocalGatewayRoutesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/SearchLocalGatewayRoutesRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=SearchTransitGatewayMulticastGroups&Version=2016-11-15:
+ get:
+ x-aws-operation-name: SearchTransitGatewayMulticastGroups
+ operationId: GET_SearchTransitGatewayMulticastGroups
+ description: Searches one or more transit gateway multicast groups and returns the group membership information.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/SearchTransitGatewayMulticastGroupsResult'
+ parameters:
+ - name: TransitGatewayMulticastDomainId
+ in: query
+ required: false
+ description: The ID of the transit gateway multicast domain.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: false
+ description: 'One or more filters. The possible values are:
group-ip-address - The IP address of the transit gateway multicast group.
is-group-member - The resource is a group member. Valid values are true | false.
is-group-source - The resource is a group source. Valid values are true | false.
member-type - The member type. Valid values are igmp | static.
resource-id - The ID of the resource.
resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.
source-type - The source type. Valid values are igmp | static.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
nextToken value.'
+ schema:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ - name: NextToken
+ in: query
+ required: false
+ description: The token for the next page of results.
+ schema:
+ type: string
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: SearchTransitGatewayMulticastGroups
+ operationId: POST_SearchTransitGatewayMulticastGroups
+ description: Searches one or more transit gateway multicast groups and returns the group membership information.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/SearchTransitGatewayMulticastGroupsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/SearchTransitGatewayMulticastGroupsRequest'
+ parameters:
+ - name: MaxResults
+ in: query
+ schema:
+ type: string
+ description: Pagination limit
+ required: false
+ - name: NextToken
+ in: query
+ schema:
+ type: string
+ description: Pagination token
+ required: false
+ /?Action=SearchTransitGatewayRoutes&Version=2016-11-15:
+ get:
+ x-aws-operation-name: SearchTransitGatewayRoutes
+ operationId: GET_SearchTransitGatewayRoutes
+ description: Searches for routes in the specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/SearchTransitGatewayRoutesResult'
+ parameters:
+ - name: TransitGatewayRouteTableId
+ in: query
+ required: true
+ description: The ID of the transit gateway route table.
+ schema:
+ type: string
+ - name: Filter
+ in: query
+ required: true
+ description: 'One or more filters. The possible values are:
attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
type - The type of route (propagated | static).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: SearchTransitGatewayRoutes
+ operationId: POST_SearchTransitGatewayRoutes
+ description: Searches for routes in the specified transit gateway route table.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/SearchTransitGatewayRoutesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/SearchTransitGatewayRoutesRequest'
+ parameters: []
+ /?Action=SendDiagnosticInterrupt&Version=2016-11-15:
+ get:
+ x-aws-operation-name: SendDiagnosticInterrupt
+ operationId: GET_SendDiagnosticInterrupt
+ description: 'Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).
In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.
Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.
For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) (Linux instances) or Send a diagnostic interrupt (for advanced users) (Windows instances).
' + responses: + '200': + description: Success + parameters: + - name: InstanceId + in: query + required: true + description: The ID of the instance. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: SendDiagnosticInterrupt
+ operationId: POST_SendDiagnosticInterrupt
+ description: 'Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).
In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.
Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.
For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) (Linux instances) or Send a diagnostic interrupt (for advanced users) (Windows instances).
' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/SendDiagnosticInterruptRequest' + parameters: [] + /?Action=StartInstances&Version=2016-11-15: + get: + x-aws-operation-name: StartInstances + operationId: GET_StartInstances + description: 'Starts an Amazon EBS-backed instance that you''ve previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
If you attempt to start a T3 instance with host tenancy and the unlimted CPU credit option, the request fails. The unlimited CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to standard, or change its tenancy to default or dedicated.
For more information, see Stop and start your instance in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/StartInstancesResult' + parameters: + - name: InstanceId + in: query + required: true + description: The IDs of the instances. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceId' + - xml: + name: InstanceId + - name: AdditionalInfo + in: query + required: false + description: Reserved. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: StartInstances
+ operationId: POST_StartInstances
+ description: 'Starts an Amazon EBS-backed instance that you''ve previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
If you attempt to start a T3 instance with host tenancy and the unlimted CPU credit option, the request fails. The unlimited CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to standard, or change its tenancy to default or dedicated.
For more information, see Stop and start your instance in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/StartInstancesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/StartInstancesRequest' + parameters: [] + /?Action=StartNetworkInsightsAccessScopeAnalysis&Version=2016-11-15: + get: + x-aws-operation-name: StartNetworkInsightsAccessScopeAnalysis + operationId: GET_StartNetworkInsightsAccessScopeAnalysis + description: Starts analyzing the specified Network Access Scope. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/StartNetworkInsightsAccessScopeAnalysisResult' + parameters: + - name: NetworkInsightsAccessScopeId + in: query + required: true + description: The ID of the Network Access Scope. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: ClientToken
+ in: query
+ required: true
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: StartNetworkInsightsAccessScopeAnalysis
+ operationId: POST_StartNetworkInsightsAccessScopeAnalysis
+ description: Starts analyzing the specified Network Access Scope.
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/StartNetworkInsightsAccessScopeAnalysisResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/StartNetworkInsightsAccessScopeAnalysisRequest'
+ parameters: []
+ /?Action=StartNetworkInsightsAnalysis&Version=2016-11-15:
+ get:
+ x-aws-operation-name: StartNetworkInsightsAnalysis
+ operationId: GET_StartNetworkInsightsAnalysis
+ description: 'Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/StartNetworkInsightsAnalysisResult'
+ parameters:
+ - name: NetworkInsightsPathId
+ in: query
+ required: true
+ description: The ID of the path.
+ schema:
+ type: string
+ - name: FilterInArn
+ in: query
+ required: false
+ description: The Amazon Resource Names (ARN) of the resources that the path must traverse.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - xml:
+ name: item
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: TagSpecification
+ in: query
+ required: false
+ description: The tags to apply.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ - name: ClientToken
+ in: query
+ required: true
+ description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: StartNetworkInsightsAnalysis
+ operationId: POST_StartNetworkInsightsAnalysis
+ description: 'Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/StartNetworkInsightsAnalysisResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/StartNetworkInsightsAnalysisRequest'
+ parameters: []
+ /?Action=StartVpcEndpointServicePrivateDnsVerification&Version=2016-11-15:
+ get:
+ x-aws-operation-name: StartVpcEndpointServicePrivateDnsVerification
+ operationId: GET_StartVpcEndpointServicePrivateDnsVerification
+ description: 'Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.
The service provider must successfully perform the verification before the consumer can use the name to access the service.
Before the service provider runs this command, they must add a record to the DNS server.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/StartVpcEndpointServicePrivateDnsVerificationResult' + parameters: + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: ServiceId
+ in: query
+ required: true
+ description: The ID of the endpoint service.
+ schema:
+ type: string
+ 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'
+ post:
+ x-aws-operation-name: StartVpcEndpointServicePrivateDnsVerification
+ operationId: POST_StartVpcEndpointServicePrivateDnsVerification
+ description: 'Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.
The service provider must successfully perform the verification before the consumer can use the name to access the service.
Before the service provider runs this command, they must add a record to the DNS server.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/StartVpcEndpointServicePrivateDnsVerificationResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/StartVpcEndpointServicePrivateDnsVerificationRequest' + parameters: [] + /?Action=StopInstances&Version=2016-11-15: + get: + x-aws-operation-name: StopInstances + operationId: GET_StopInstances + description: 'Stops an Amazon EBS-backed instance. For more information, see Stop and start your instance in the Amazon EC2 User Guide.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
We don''t charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can''t stop or hibernate instance store-backed instances. You can''t use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/StopInstancesResult' + parameters: + - name: InstanceId + in: query + required: true + description: The IDs of the instances. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceId' + - xml: + name: InstanceId + - name: Hibernate + in: query + required: false + description: 'Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: Force
+ in: query
+ required: false
+ description: 'Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
Stops an Amazon EBS-backed instance. For more information, see Stop and start your instance in the Amazon EC2 User Guide.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
We don''t charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can''t stop or hibernate instance store-backed instances. You can''t use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/StopInstancesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/StopInstancesRequest' + parameters: [] + /?Action=TerminateClientVpnConnections&Version=2016-11-15: + get: + x-aws-operation-name: TerminateClientVpnConnections + operationId: GET_TerminateClientVpnConnections + description: 'Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/TerminateClientVpnConnectionsResult' + parameters: + - name: ClientVpnEndpointId + in: query + required: true + description: The ID of the Client VPN endpoint to which the client is connected. + schema: + type: string + - name: ConnectionId + in: query + required: false + description: The ID of the client connection to be terminated. + schema: + type: string + - name: Username + in: query + required: false + description: The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections. + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: TerminateClientVpnConnections
+ operationId: POST_TerminateClientVpnConnections
+ description: 'Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/TerminateClientVpnConnectionsResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/TerminateClientVpnConnectionsRequest'
+ parameters: []
+ /?Action=TerminateInstances&Version=2016-11-15:
+ get:
+ x-aws-operation-name: TerminateInstances
+ operationId: GET_TerminateInstances
+ description: 'Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.
For example, say you have the following instances:
Instance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection.
Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/TerminateInstancesResult' + parameters: + - name: InstanceId + in: query + required: true + description: 'The IDs of the instances.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
' + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceId' + - xml: + name: InstanceId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: TerminateInstances
+ operationId: POST_TerminateInstances
+ description: 'Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.
For example, say you have the following instances:
Instance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection.
Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/TerminateInstancesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/TerminateInstancesRequest' + parameters: [] + /?Action=UnassignIpv6Addresses&Version=2016-11-15: + get: + x-aws-operation-name: UnassignIpv6Addresses + operationId: GET_UnassignIpv6Addresses + description: Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/UnassignIpv6AddressesResult' + parameters: + - name: Ipv6Addresses + in: query + required: false + description: The IPv6 addresses to unassign from the network interface. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + - name: Ipv6Prefix + in: query + required: false + description: One or more IPv6 prefixes to unassign from the network interface. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + - name: NetworkInterfaceId + in: query + required: true + description: The ID of the network interface. + schema: + type: string + 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' + post: + x-aws-operation-name: UnassignIpv6Addresses + operationId: POST_UnassignIpv6Addresses + description: Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface. + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/UnassignIpv6AddressesResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/UnassignIpv6AddressesRequest' + parameters: [] + /?Action=UnassignPrivateIpAddresses&Version=2016-11-15: + get: + x-aws-operation-name: UnassignPrivateIpAddresses + operationId: GET_UnassignPrivateIpAddresses + description: 'Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.' + responses: + '200': + description: Success + parameters: + - name: NetworkInterfaceId + in: query + required: true + description: The ID of the network interface. + schema: + type: string + - name: PrivateIpAddress + in: query + required: false + description: The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: PrivateIpAddress + - name: Ipv4Prefix + in: query + required: false + description: The IPv4 prefixes to unassign from the network interface. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + 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' + post: + x-aws-operation-name: UnassignPrivateIpAddresses + operationId: POST_UnassignPrivateIpAddresses + description: 'Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.' + responses: + '200': + description: Success + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/UnassignPrivateIpAddressesRequest' + parameters: [] + /?Action=UnmonitorInstances&Version=2016-11-15: + get: + x-aws-operation-name: UnmonitorInstances + operationId: GET_UnmonitorInstances + description: 'Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/UnmonitorInstancesResult' + parameters: + - name: InstanceId + in: query + required: true + description: The IDs of the instances. + schema: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceId' + - xml: + name: InstanceId + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: UnmonitorInstances
+ operationId: POST_UnmonitorInstances
+ description: 'Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/UnmonitorInstancesResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/UnmonitorInstancesRequest'
+ parameters: []
+ /?Action=UpdateSecurityGroupRuleDescriptionsEgress&Version=2016-11-15:
+ get:
+ x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsEgress
+ operationId: GET_UpdateSecurityGroupRuleDescriptionsEgress
+ description: '[VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: GroupId
+ in: query
+ required: false
+ description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.'
+ schema:
+ type: string
+ - name: GroupName
+ in: query
+ required: false
+ description: '[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.'
+ schema:
+ type: string
+ - name: IpPermissions
+ in: query
+ required: false
+ description: The IP permissions for the security group rule. You must specify either the IP permissions or the description.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpPermission'
+ - xml:
+ name: item
+ - name: SecurityGroupRuleDescription
+ in: query
+ required: false
+ description: The description for the egress security group rules. You must specify either the description or the IP permissions.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRuleDescription'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsEgress
+ operationId: POST_UpdateSecurityGroupRuleDescriptionsEgress
+ description: '[VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressRequest'
+ parameters: []
+ /?Action=UpdateSecurityGroupRuleDescriptionsIngress&Version=2016-11-15:
+ get:
+ x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsIngress
+ operationId: GET_UpdateSecurityGroupRuleDescriptionsIngress
+ description: 'Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressResult'
+ parameters:
+ - name: DryRun
+ in: query
+ required: false
+ description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ - name: GroupId
+ in: query
+ required: false
+ description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.'
+ schema:
+ type: string
+ - name: GroupName
+ in: query
+ required: false
+ description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.'
+ schema:
+ type: string
+ - name: IpPermissions
+ in: query
+ required: false
+ description: The IP permissions for the security group rule. You must specify either IP permissions or a description.
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpPermission'
+ - xml:
+ name: item
+ - name: SecurityGroupRuleDescription
+ in: query
+ required: false
+ description: '[VPC only] The description for the ingress security group rules. You must specify either a description or IP permissions.'
+ schema:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRuleDescription'
+ - xml:
+ name: item
+ 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'
+ post:
+ x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsIngress
+ operationId: POST_UpdateSecurityGroupRuleDescriptionsIngress
+ description: 'Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.'
+ responses:
+ '200':
+ description: Success
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressResult'
+ requestBody:
+ content:
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressRequest'
+ parameters: []
+ /?Action=WithdrawByoipCidr&Version=2016-11-15:
+ get:
+ x-aws-operation-name: WithdrawByoipCidr
+ operationId: GET_WithdrawByoipCidr
+ description: 'Stops advertising an address range that is provisioned as an address pool.
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/WithdrawByoipCidrResult' + parameters: + - name: Cidr + in: query + required: true + description: 'The address range, in CIDR notation.' + schema: + type: string + - name: DryRun + in: query + required: false + description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ schema:
+ type: boolean
+ 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'
+ post:
+ x-aws-operation-name: WithdrawByoipCidr
+ operationId: POST_WithdrawByoipCidr
+ description: 'Stops advertising an address range that is provisioned as an address pool.
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.
' + responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/WithdrawByoipCidrResult' + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/WithdrawByoipCidrRequest' + parameters: [] +components: + x-stackQL-resources: + account_attributes: + name: account_attributes + methods: + account_attributes_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeAccountAttributes&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/accountAttributeSet/item + openAPIDocKey: '200' + id: aws.ec2_api.account_attributes + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/account_attributes/methods/account_attributes_Describe' + update: [] + title: account_attributes + address: + name: address + methods: + address_Allocate: + operation: + $ref: '#/paths/~1?Action=AllocateAddress&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + address_Associate: + operation: + $ref: '#/paths/~1?Action=AssociateAddress&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + address_Disassociate: + operation: + $ref: '#/paths/~1?Action=DisassociateAddress&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + address_Release: + operation: + $ref: '#/paths/~1?Action=ReleaseAddress&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.address + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: address + address_attribute: + name: address_attribute + methods: + address_attribute_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyAddressAttribute&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + address_attribute_Reset: + operation: + $ref: '#/paths/~1?Action=ResetAddressAttribute&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.address_attribute + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: address_attribute + address_to_classic: + name: address_to_classic + methods: + address_to_classic_Restore: + operation: + $ref: '#/paths/~1?Action=RestoreAddressToClassic&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.address_to_classic + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: address_to_classic + address_to_vpc: + name: address_to_vpc + methods: + address_to_vpc_Move: + operation: + $ref: '#/paths/~1?Action=MoveAddressToVpc&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.address_to_vpc + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: address_to_vpc + addresses: + name: addresses + methods: + addresses_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeAddresses&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/addressesSet/item + openAPIDocKey: '200' + id: aws.ec2_api.addresses + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/addresses/methods/addresses_Describe' + update: [] + title: addresses + addresses_attribute: + name: addresses_attribute + methods: + addresses_attribute_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeAddressesAttribute&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/addressSet/item + openAPIDocKey: '200' + id: aws.ec2_api.addresses_attribute + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/addresses_attribute/methods/addresses_attribute_Describe' + update: [] + title: addresses_attribute + aggregate_id_format: + name: aggregate_id_format + methods: + aggregate_id_format_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeAggregateIdFormat&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/statusSet/item + openAPIDocKey: '200' + id: aws.ec2_api.aggregate_id_format + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/aggregate_id_format/methods/aggregate_id_format_Describe' + update: [] + title: aggregate_id_format + associated_enclave_certificate_iam_roles: + name: associated_enclave_certificate_iam_roles + methods: + associated_enclave_certificate_iam_roles_Get: + operation: + $ref: '#/paths/~1?Action=GetAssociatedEnclaveCertificateIamRoles&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/associatedRoleSet/item + openAPIDocKey: '200' + id: aws.ec2_api.associated_enclave_certificate_iam_roles + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/associated_enclave_certificate_iam_roles/methods/associated_enclave_certificate_iam_roles_Get' + update: [] + title: associated_enclave_certificate_iam_roles + associated_ipv6_pool_cidrs: + name: associated_ipv6_pool_cidrs + methods: + associated_ipv6_pool_cidrs_Get: + operation: + $ref: '#/paths/~1?Action=GetAssociatedIpv6PoolCidrs&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/ipv6CidrAssociationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.associated_ipv6_pool_cidrs + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/associated_ipv6_pool_cidrs/methods/associated_ipv6_pool_cidrs_Get' + update: [] + title: associated_ipv6_pool_cidrs + availability_zone_group: + name: availability_zone_group + methods: + availability_zone_group_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyAvailabilityZoneGroup&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.availability_zone_group + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: availability_zone_group + availability_zones: + name: availability_zones + methods: + availability_zones_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeAvailabilityZones&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/availabilityZoneInfo/item + openAPIDocKey: '200' + id: aws.ec2_api.availability_zones + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/availability_zones/methods/availability_zones_Describe' + update: [] + title: availability_zones + bundle_tasks: + name: bundle_tasks + methods: + bundle_task_Cancel: + operation: + $ref: '#/paths/~1?Action=CancelBundleTask&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + bundle_tasks_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeBundleTasks&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/bundleInstanceTasksSet/item + openAPIDocKey: '200' + id: aws.ec2_api.bundle_tasks + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/bundle_tasks/methods/bundle_tasks_Describe' + update: [] + title: bundle_tasks + byoip_cidr_to_ipam: + name: byoip_cidr_to_ipam + methods: + byoip_cidr_to_ipam_Move: + operation: + $ref: '#/paths/~1?Action=MoveByoipCidrToIpam&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.byoip_cidr_to_ipam + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: byoip_cidr_to_ipam + byoip_cidrs: + name: byoip_cidrs + methods: + byoip_cidr_Advertise: + operation: + $ref: '#/paths/~1?Action=AdvertiseByoipCidr&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + byoip_cidr_Deprovision: + operation: + $ref: '#/paths/~1?Action=DeprovisionByoipCidr&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + byoip_cidr_Provision: + operation: + $ref: '#/paths/~1?Action=ProvisionByoipCidr&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + byoip_cidr_Withdraw: + operation: + $ref: '#/paths/~1?Action=WithdrawByoipCidr&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + byoip_cidrs_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeByoipCidrs&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/byoipCidrSet/item + openAPIDocKey: '200' + id: aws.ec2_api.byoip_cidrs + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/byoip_cidrs/methods/byoip_cidrs_Describe' + update: [] + title: byoip_cidrs + capacity_reservation_fleets: + name: capacity_reservation_fleets + methods: + capacity_reservation_fleet_Create: + operation: + $ref: '#/paths/~1?Action=CreateCapacityReservationFleet&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + capacity_reservation_fleet_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyCapacityReservationFleet&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + capacity_reservation_fleets_Cancel: + operation: + $ref: '#/paths/~1?Action=CancelCapacityReservationFleets&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + capacity_reservation_fleets_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeCapacityReservationFleets&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/capacityReservationFleetSet/item + openAPIDocKey: '200' + id: aws.ec2_api.capacity_reservation_fleets + sqlVerbs: + delete: [] + insert: + - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/capacity_reservation_fleet_Create' + select: + - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/capacity_reservation_fleets_Describe' + update: [] + title: capacity_reservation_fleets + capacity_reservation_usage: + name: capacity_reservation_usage + methods: + capacity_reservation_usage_Get: + operation: + $ref: '#/paths/~1?Action=GetCapacityReservationUsage&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.capacity_reservation_usage + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/capacity_reservation_usage/methods/capacity_reservation_usage_Get' + update: [] + title: capacity_reservation_usage + capacity_reservations: + name: capacity_reservations + methods: + capacity_reservation_Cancel: + operation: + $ref: '#/paths/~1?Action=CancelCapacityReservation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + capacity_reservation_Create: + operation: + $ref: '#/paths/~1?Action=CreateCapacityReservation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + capacity_reservation_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyCapacityReservation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + capacity_reservations_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeCapacityReservations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/capacityReservationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.capacity_reservations + sqlVerbs: + delete: [] + insert: + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/capacity_reservation_Create' + select: + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/capacity_reservations_Describe' + update: [] + title: capacity_reservations + carrier_gateways: + name: carrier_gateways + methods: + carrier_gateway_Create: + operation: + $ref: '#/paths/~1?Action=CreateCarrierGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + carrier_gateway_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteCarrierGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + carrier_gateways_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeCarrierGateways&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/carrierGatewaySet/item + openAPIDocKey: '200' + id: aws.ec2_api.carrier_gateways + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/carrier_gateway_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/carrier_gateway_Create' + select: + - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/carrier_gateways_Describe' + update: [] + title: carrier_gateways + classic_link_instances: + name: classic_link_instances + methods: + classic_link_instances_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeClassicLinkInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/instancesSet/item + openAPIDocKey: '200' + id: aws.ec2_api.classic_link_instances + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/classic_link_instances/methods/classic_link_instances_Describe' + update: [] + title: classic_link_instances + classic_link_vpc: + name: classic_link_vpc + methods: + classic_link_vpc_Attach: + operation: + $ref: '#/paths/~1?Action=AttachClassicLinkVpc&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + classic_link_vpc_Detach: + operation: + $ref: '#/paths/~1?Action=DetachClassicLinkVpc&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.classic_link_vpc + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: classic_link_vpc + client_vpn_authorization_rules: + name: client_vpn_authorization_rules + methods: + client_vpn_authorization_rules_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeClientVpnAuthorizationRules&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/authorizationRule/item + openAPIDocKey: '200' + id: aws.ec2_api.client_vpn_authorization_rules + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/client_vpn_authorization_rules/methods/client_vpn_authorization_rules_Describe' + update: [] + title: client_vpn_authorization_rules + client_vpn_client_certificate_revocation_list: + name: client_vpn_client_certificate_revocation_list + methods: + client_vpn_client_certificate_revocation_list_Export: + operation: + $ref: '#/paths/~1?Action=ExportClientVpnClientCertificateRevocationList&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + client_vpn_client_certificate_revocation_list_Import: + operation: + $ref: '#/paths/~1?Action=ImportClientVpnClientCertificateRevocationList&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.client_vpn_client_certificate_revocation_list + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: client_vpn_client_certificate_revocation_list + client_vpn_client_configuration: + name: client_vpn_client_configuration + methods: + client_vpn_client_configuration_Export: + operation: + $ref: '#/paths/~1?Action=ExportClientVpnClientConfiguration&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.client_vpn_client_configuration + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: client_vpn_client_configuration + client_vpn_connections: + name: client_vpn_connections + methods: + client_vpn_connections_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeClientVpnConnections&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/connections/item + openAPIDocKey: '200' + client_vpn_connections_Terminate: + operation: + $ref: '#/paths/~1?Action=TerminateClientVpnConnections&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.client_vpn_connections + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/client_vpn_connections/methods/client_vpn_connections_Describe' + update: [] + title: client_vpn_connections + client_vpn_endpoints: + name: client_vpn_endpoints + methods: + client_vpn_endpoint_Create: + operation: + $ref: '#/paths/~1?Action=CreateClientVpnEndpoint&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + client_vpn_endpoint_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteClientVpnEndpoint&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + client_vpn_endpoint_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyClientVpnEndpoint&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + client_vpn_endpoints_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeClientVpnEndpoints&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/clientVpnEndpoint/item + openAPIDocKey: '200' + id: aws.ec2_api.client_vpn_endpoints + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/client_vpn_endpoints/methods/client_vpn_endpoint_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/client_vpn_endpoints/methods/client_vpn_endpoint_Create' + select: + - $ref: '#/components/x-stackQL-resources/client_vpn_endpoints/methods/client_vpn_endpoints_Describe' + update: [] + title: client_vpn_endpoints + client_vpn_ingress: + name: client_vpn_ingress + methods: + client_vpn_ingress_Authorize: + operation: + $ref: '#/paths/~1?Action=AuthorizeClientVpnIngress&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + client_vpn_ingress_Revoke: + operation: + $ref: '#/paths/~1?Action=RevokeClientVpnIngress&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.client_vpn_ingress + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: client_vpn_ingress + client_vpn_routes: + name: client_vpn_routes + methods: + client_vpn_route_Create: + operation: + $ref: '#/paths/~1?Action=CreateClientVpnRoute&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + client_vpn_route_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteClientVpnRoute&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + client_vpn_routes_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeClientVpnRoutes&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/routes/item + openAPIDocKey: '200' + id: aws.ec2_api.client_vpn_routes + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/client_vpn_routes/methods/client_vpn_route_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/client_vpn_routes/methods/client_vpn_route_Create' + select: + - $ref: '#/components/x-stackQL-resources/client_vpn_routes/methods/client_vpn_routes_Describe' + update: [] + title: client_vpn_routes + client_vpn_target_networks: + name: client_vpn_target_networks + methods: + client_vpn_target_network_Associate: + operation: + $ref: '#/paths/~1?Action=AssociateClientVpnTargetNetwork&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + client_vpn_target_network_Disassociate: + operation: + $ref: '#/paths/~1?Action=DisassociateClientVpnTargetNetwork&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + client_vpn_target_networks_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeClientVpnTargetNetworks&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/clientVpnTargetNetworks/item + openAPIDocKey: '200' + id: aws.ec2_api.client_vpn_target_networks + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/client_vpn_target_networks/methods/client_vpn_target_networks_Describe' + update: [] + title: client_vpn_target_networks + coip_pool_usage: + name: coip_pool_usage + methods: + coip_pool_usage_Get: + operation: + $ref: '#/paths/~1?Action=GetCoipPoolUsage&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/coipAddressUsageSet/item + openAPIDocKey: '200' + id: aws.ec2_api.coip_pool_usage + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/coip_pool_usage/methods/coip_pool_usage_Get' + update: [] + title: coip_pool_usage + coip_pools: + name: coip_pools + methods: + coip_pools_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeCoipPools&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/coipPoolSet/item + openAPIDocKey: '200' + id: aws.ec2_api.coip_pools + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/coip_pools/methods/coip_pools_Describe' + update: [] + title: coip_pools + console_output: + name: console_output + methods: + console_output_Get: + operation: + $ref: '#/paths/~1?Action=GetConsoleOutput&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.console_output + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/console_output/methods/console_output_Get' + update: [] + title: console_output + console_screenshot: + name: console_screenshot + methods: + console_screenshot_Get: + operation: + $ref: '#/paths/~1?Action=GetConsoleScreenshot&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.console_screenshot + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/console_screenshot/methods/console_screenshot_Get' + update: [] + title: console_screenshot + conversion_tasks: + name: conversion_tasks + methods: + conversion_task_Cancel: + operation: + $ref: '#/paths/~1?Action=CancelConversionTask&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + conversion_tasks_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeConversionTasks&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/conversionTasks/item + openAPIDocKey: '200' + id: aws.ec2_api.conversion_tasks + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/conversion_tasks/methods/conversion_tasks_Describe' + update: [] + title: conversion_tasks + customer_gateways: + name: customer_gateways + methods: + customer_gateway_Create: + operation: + $ref: '#/paths/~1?Action=CreateCustomerGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + customer_gateway_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteCustomerGateway&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + customer_gateways_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeCustomerGateways&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/customerGatewaySet/item + openAPIDocKey: '200' + id: aws.ec2_api.customer_gateways + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/customer_gateway_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/customer_gateway_Create' + select: + - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/customer_gateways_Describe' + update: [] + title: customer_gateways + default_credit_specification: + name: default_credit_specification + methods: + default_credit_specification_Get: + operation: + $ref: '#/paths/~1?Action=GetDefaultCreditSpecification&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/instanceFamilyCreditSpecification + openAPIDocKey: '200' + default_credit_specification_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyDefaultCreditSpecification&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.default_credit_specification + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/default_credit_specification/methods/default_credit_specification_Get' + update: [] + title: default_credit_specification + default_subnet: + name: default_subnet + methods: + default_subnet_Create: + operation: + $ref: '#/paths/~1?Action=CreateDefaultSubnet&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.default_subnet + sqlVerbs: + delete: [] + insert: + - $ref: '#/components/x-stackQL-resources/default_subnet/methods/default_subnet_Create' + select: [] + update: [] + title: default_subnet + default_vpc: + name: default_vpc + methods: + default_vpc_Create: + operation: + $ref: '#/paths/~1?Action=CreateDefaultVpc&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.default_vpc + sqlVerbs: + delete: [] + insert: + - $ref: '#/components/x-stackQL-resources/default_vpc/methods/default_vpc_Create' + select: [] + update: [] + title: default_vpc + dhcp_options: + name: dhcp_options + methods: + dhcp_options_Associate: + operation: + $ref: '#/paths/~1?Action=AssociateDhcpOptions&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + dhcp_options_Create: + operation: + $ref: '#/paths/~1?Action=CreateDhcpOptions&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + dhcp_options_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteDhcpOptions&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + dhcp_options_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeDhcpOptions&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/dhcpOptionsSet/item + openAPIDocKey: '200' + id: aws.ec2_api.dhcp_options + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/dhcp_options_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/dhcp_options_Create' + select: + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/dhcp_options_Describe' + update: [] + title: dhcp_options + diagnostic_interrupt: + name: diagnostic_interrupt + methods: + diagnostic_interrupt_Send: + operation: + $ref: '#/paths/~1?Action=SendDiagnosticInterrupt&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.diagnostic_interrupt + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: diagnostic_interrupt + ebs_default_kms_key_id: + name: ebs_default_kms_key_id + methods: + ebs_default_kms_key_id_Get: + operation: + $ref: '#/paths/~1?Action=GetEbsDefaultKmsKeyId&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + ebs_default_kms_key_id_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyEbsDefaultKmsKeyId&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ebs_default_kms_key_id_Reset: + operation: + $ref: '#/paths/~1?Action=ResetEbsDefaultKmsKeyId&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.ebs_default_kms_key_id + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/ebs_default_kms_key_id/methods/ebs_default_kms_key_id_Get' + update: [] + title: ebs_default_kms_key_id + ebs_encryption_by_default: + name: ebs_encryption_by_default + methods: + ebs_encryption_by_default_Disable: + operation: + $ref: '#/paths/~1?Action=DisableEbsEncryptionByDefault&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ebs_encryption_by_default_Enable: + operation: + $ref: '#/paths/~1?Action=EnableEbsEncryptionByDefault&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ebs_encryption_by_default_Get: + operation: + $ref: '#/paths/~1?Action=GetEbsEncryptionByDefault&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.ebs_encryption_by_default + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/ebs_encryption_by_default/methods/ebs_encryption_by_default_Get' + update: [] + title: ebs_encryption_by_default + egress_only_internet_gateways: + name: egress_only_internet_gateways + methods: + egress_only_internet_gateway_Create: + operation: + $ref: '#/paths/~1?Action=CreateEgressOnlyInternetGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + egress_only_internet_gateway_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteEgressOnlyInternetGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + egress_only_internet_gateways_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeEgressOnlyInternetGateways&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/egressOnlyInternetGatewaySet/item + openAPIDocKey: '200' + id: aws.ec2_api.egress_only_internet_gateways + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/egress_only_internet_gateway_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/egress_only_internet_gateway_Create' + select: + - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/egress_only_internet_gateways_Describe' + update: [] + title: egress_only_internet_gateways + elastic_gpus: + name: elastic_gpus + methods: + elastic_gpus_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeElasticGpus&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/elasticGpuSet/item + openAPIDocKey: '200' + id: aws.ec2_api.elastic_gpus + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/elastic_gpus/methods/elastic_gpus_Describe' + update: [] + title: elastic_gpus + enclave_certificate_iam_role: + name: enclave_certificate_iam_role + methods: + enclave_certificate_iam_role_Associate: + operation: + $ref: '#/paths/~1?Action=AssociateEnclaveCertificateIamRole&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + enclave_certificate_iam_role_Disassociate: + operation: + $ref: '#/paths/~1?Action=DisassociateEnclaveCertificateIamRole&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.enclave_certificate_iam_role + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: enclave_certificate_iam_role + export_image_tasks: + name: export_image_tasks + methods: + export_image_tasks_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeExportImageTasks&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/exportImageTaskSet/item + openAPIDocKey: '200' + id: aws.ec2_api.export_image_tasks + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/export_image_tasks/methods/export_image_tasks_Describe' + update: [] + title: export_image_tasks + export_tasks: + name: export_tasks + methods: + export_task_Cancel: + operation: + $ref: '#/paths/~1?Action=CancelExportTask&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + export_tasks_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeExportTasks&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/exportTaskSet/item + openAPIDocKey: '200' + id: aws.ec2_api.export_tasks + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/export_tasks/methods/export_tasks_Describe' + update: [] + title: export_tasks + fast_launch: + name: fast_launch + methods: + fast_launch_Disable: + operation: + $ref: '#/paths/~1?Action=DisableFastLaunch&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + fast_launch_Enable: + operation: + $ref: '#/paths/~1?Action=EnableFastLaunch&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.fast_launch + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: fast_launch + fast_launch_images: + name: fast_launch_images + methods: + fast_launch_images_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeFastLaunchImages&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/fastLaunchImageSet/item + openAPIDocKey: '200' + id: aws.ec2_api.fast_launch_images + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/fast_launch_images/methods/fast_launch_images_Describe' + update: [] + title: fast_launch_images + fast_snapshot_restores: + name: fast_snapshot_restores + methods: + fast_snapshot_restores_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeFastSnapshotRestores&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/fastSnapshotRestoreSet/item + openAPIDocKey: '200' + fast_snapshot_restores_Disable: + operation: + $ref: '#/paths/~1?Action=DisableFastSnapshotRestores&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + fast_snapshot_restores_Enable: + operation: + $ref: '#/paths/~1?Action=EnableFastSnapshotRestores&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.fast_snapshot_restores + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/fast_snapshot_restores/methods/fast_snapshot_restores_Describe' + update: [] + title: fast_snapshot_restores + fleet_history: + name: fleet_history + methods: + fleet_history_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeFleetHistory&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.fleet_history + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/fleet_history/methods/fleet_history_Describe' + update: [] + title: fleet_history + fleet_instances: + name: fleet_instances + methods: + fleet_instances_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeFleetInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/activeInstanceSet/item + openAPIDocKey: '200' + id: aws.ec2_api.fleet_instances + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/fleet_instances/methods/fleet_instances_Describe' + update: [] + title: fleet_instances + fleets: + name: fleets + methods: + fleet_Create: + operation: + $ref: '#/paths/~1?Action=CreateFleet&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + fleet_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyFleet&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + fleets_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteFleets&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + fleets_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeFleets&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/fleetSet/item + openAPIDocKey: '200' + id: aws.ec2_api.fleets + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/fleets/methods/fleets_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/fleets/methods/fleet_Create' + select: + - $ref: '#/components/x-stackQL-resources/fleets/methods/fleets_Describe' + update: [] + title: fleets + flow_logs: + name: flow_logs + methods: + flow_logs_Create: + operation: + $ref: '#/paths/~1?Action=CreateFlowLogs&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + flow_logs_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteFlowLogs&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + flow_logs_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeFlowLogs&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/flowLogSet/item + openAPIDocKey: '200' + id: aws.ec2_api.flow_logs + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/flow_logs/methods/flow_logs_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/flow_logs/methods/flow_logs_Create' + select: + - $ref: '#/components/x-stackQL-resources/flow_logs/methods/flow_logs_Describe' + update: [] + title: flow_logs + flow_logs_integration_template: + name: flow_logs_integration_template + methods: + flow_logs_integration_template_Get: + operation: + $ref: '#/paths/~1?Action=GetFlowLogsIntegrationTemplate&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.flow_logs_integration_template + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/flow_logs_integration_template/methods/flow_logs_integration_template_Get' + update: [] + title: flow_logs_integration_template + fpga_image_attribute: + name: fpga_image_attribute + methods: + fpga_image_attribute_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeFpgaImageAttribute&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + fpga_image_attribute_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyFpgaImageAttribute&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + fpga_image_attribute_Reset: + operation: + $ref: '#/paths/~1?Action=ResetFpgaImageAttribute&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.fpga_image_attribute + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/fpga_image_attribute/methods/fpga_image_attribute_Describe' + update: [] + title: fpga_image_attribute + fpga_images: + name: fpga_images + methods: + fpga_image_Copy: + operation: + $ref: '#/paths/~1?Action=CopyFpgaImage&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + fpga_image_Create: + operation: + $ref: '#/paths/~1?Action=CreateFpgaImage&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + fpga_image_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteFpgaImage&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + fpga_images_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeFpgaImages&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/fpgaImageSet/item + openAPIDocKey: '200' + id: aws.ec2_api.fpga_images + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/fpga_images/methods/fpga_image_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/fpga_images/methods/fpga_image_Create' + select: + - $ref: '#/components/x-stackQL-resources/fpga_images/methods/fpga_images_Describe' + update: [] + title: fpga_images + groups_for_capacity_reservation: + name: groups_for_capacity_reservation + methods: + groups_for_capacity_reservation_Get: + operation: + $ref: '#/paths/~1?Action=GetGroupsForCapacityReservation&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/capacityReservationGroupSet/item + openAPIDocKey: '200' + id: aws.ec2_api.groups_for_capacity_reservation + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/groups_for_capacity_reservation/methods/groups_for_capacity_reservation_Get' + update: [] + title: groups_for_capacity_reservation + host_reservation_offerings: + name: host_reservation_offerings + methods: + host_reservation_offerings_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeHostReservationOfferings&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/offeringSet/item + openAPIDocKey: '200' + id: aws.ec2_api.host_reservation_offerings + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/host_reservation_offerings/methods/host_reservation_offerings_Describe' + update: [] + title: host_reservation_offerings + host_reservation_purchase_preview: + name: host_reservation_purchase_preview + methods: + host_reservation_purchase_preview_Get: + operation: + $ref: '#/paths/~1?Action=GetHostReservationPurchasePreview&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.host_reservation_purchase_preview + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/host_reservation_purchase_preview/methods/host_reservation_purchase_preview_Get' + update: [] + title: host_reservation_purchase_preview + host_reservations: + name: host_reservations + methods: + host_reservation_Purchase: + operation: + $ref: '#/paths/~1?Action=PurchaseHostReservation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + host_reservations_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeHostReservations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/hostReservationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.host_reservations + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/host_reservations/methods/host_reservations_Describe' + update: [] + title: host_reservations + hosts: + name: hosts + methods: + hosts_Allocate: + operation: + $ref: '#/paths/~1?Action=AllocateHosts&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + hosts_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeHosts&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/hostSet/item + openAPIDocKey: '200' + hosts_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyHosts&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + hosts_Release: + operation: + $ref: '#/paths/~1?Action=ReleaseHosts&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.hosts + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/hosts/methods/hosts_Describe' + update: [] + title: hosts + iam_instance_profile: + name: iam_instance_profile + methods: + iam_instance_profile_Associate: + operation: + $ref: '#/paths/~1?Action=AssociateIamInstanceProfile&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + iam_instance_profile_Disassociate: + operation: + $ref: '#/paths/~1?Action=DisassociateIamInstanceProfile&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.iam_instance_profile + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: iam_instance_profile + iam_instance_profile_associations: + name: iam_instance_profile_associations + methods: + iam_instance_profile_association_Replace: + operation: + $ref: '#/paths/~1?Action=ReplaceIamInstanceProfileAssociation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + iam_instance_profile_associations_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeIamInstanceProfileAssociations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/iamInstanceProfileAssociationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.iam_instance_profile_associations + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/iam_instance_profile_associations/methods/iam_instance_profile_associations_Describe' + update: [] + title: iam_instance_profile_associations + id_format: + name: id_format + methods: + id_format_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeIdFormat&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/statusSet/item + openAPIDocKey: '200' + id_format_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyIdFormat&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.id_format + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/id_format/methods/id_format_Describe' + update: [] + title: id_format + identity_id_format: + name: identity_id_format + methods: + identity_id_format_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeIdentityIdFormat&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/statusSet/item + openAPIDocKey: '200' + identity_id_format_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyIdentityIdFormat&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.identity_id_format + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/identity_id_format/methods/identity_id_format_Describe' + update: [] + title: identity_id_format + image_attribute: + name: image_attribute + methods: + image_attribute_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeImageAttribute&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + image_attribute_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyImageAttribute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + image_attribute_Reset: + operation: + $ref: '#/paths/~1?Action=ResetImageAttribute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.image_attribute + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/image_attribute/methods/image_attribute_Describe' + update: [] + title: image_attribute + image_deprecation: + name: image_deprecation + methods: + image_deprecation_Disable: + operation: + $ref: '#/paths/~1?Action=DisableImageDeprecation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + image_deprecation_Enable: + operation: + $ref: '#/paths/~1?Action=EnableImageDeprecation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.image_deprecation + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: image_deprecation + image_from_recycle_bin: + name: image_from_recycle_bin + methods: + image_from_recycle_bin_Restore: + operation: + $ref: '#/paths/~1?Action=RestoreImageFromRecycleBin&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.image_from_recycle_bin + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: image_from_recycle_bin + images: + name: images + methods: + image_Copy: + operation: + $ref: '#/paths/~1?Action=CopyImage&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + image_Create: + operation: + $ref: '#/paths/~1?Action=CreateImage&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + image_Deregister: + operation: + $ref: '#/paths/~1?Action=DeregisterImage&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + image_Export: + operation: + $ref: '#/paths/~1?Action=ExportImage&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + image_Import: + operation: + $ref: '#/paths/~1?Action=ImportImage&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + image_Register: + operation: + $ref: '#/paths/~1?Action=RegisterImage&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + images_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeImages&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.images + sqlVerbs: + delete: [] + insert: + - $ref: '#/components/x-stackQL-resources/images/methods/image_Create' + select: + - $ref: '#/components/x-stackQL-resources/images/methods/images_Describe' + update: [] + title: images + images_in_recycle_bin: + name: images_in_recycle_bin + methods: + images_in_recycle_bin_List: + operation: + $ref: '#/paths/~1?Action=ListImagesInRecycleBin&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/imageSet/item + openAPIDocKey: '200' + id: aws.ec2_api.images_in_recycle_bin + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/images_in_recycle_bin/methods/images_in_recycle_bin_List' + update: [] + title: images_in_recycle_bin + import_image_tasks: + name: import_image_tasks + methods: + import_image_tasks_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeImportImageTasks&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/importImageTaskSet/item + openAPIDocKey: '200' + id: aws.ec2_api.import_image_tasks + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/import_image_tasks/methods/import_image_tasks_Describe' + update: [] + title: import_image_tasks + import_snapshot_tasks: + name: import_snapshot_tasks + methods: + import_snapshot_tasks_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeImportSnapshotTasks&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/importSnapshotTaskSet/item + openAPIDocKey: '200' + id: aws.ec2_api.import_snapshot_tasks + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/import_snapshot_tasks/methods/import_snapshot_tasks_Describe' + update: [] + title: import_snapshot_tasks + import_task: + name: import_task + methods: + import_task_Cancel: + operation: + $ref: '#/paths/~1?Action=CancelImportTask&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.import_task + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: import_task + instance_attribute: + name: instance_attribute + methods: + instance_attribute_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeInstanceAttribute&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + instance_attribute_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyInstanceAttribute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + instance_attribute_Reset: + operation: + $ref: '#/paths/~1?Action=ResetInstanceAttribute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.instance_attribute + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/instance_attribute/methods/instance_attribute_Describe' + update: [] + title: instance_attribute + instance_capacity_reservation_attributes: + name: instance_capacity_reservation_attributes + methods: + instance_capacity_reservation_attributes_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyInstanceCapacityReservationAttributes&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.instance_capacity_reservation_attributes + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: instance_capacity_reservation_attributes + instance_credit_specifications: + name: instance_credit_specifications + methods: + instance_credit_specification_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyInstanceCreditSpecification&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instance_credit_specifications_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeInstanceCreditSpecifications&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/instanceCreditSpecificationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.instance_credit_specifications + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/instance_credit_specifications/methods/instance_credit_specifications_Describe' + update: [] + title: instance_credit_specifications + instance_event_notification_attributes: + name: instance_event_notification_attributes + methods: + instance_event_notification_attributes_Deregister: + operation: + $ref: '#/paths/~1?Action=DeregisterInstanceEventNotificationAttributes&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instance_event_notification_attributes_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeInstanceEventNotificationAttributes&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + instance_event_notification_attributes_Register: + operation: + $ref: '#/paths/~1?Action=RegisterInstanceEventNotificationAttributes&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.instance_event_notification_attributes + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/instance_event_notification_attributes/methods/instance_event_notification_attributes_Describe' + update: [] + title: instance_event_notification_attributes + instance_event_start_time: + name: instance_event_start_time + methods: + instance_event_start_time_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyInstanceEventStartTime&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.instance_event_start_time + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: instance_event_start_time + instance_event_windows: + name: instance_event_windows + methods: + instance_event_window_Associate: + operation: + $ref: '#/paths/~1?Action=AssociateInstanceEventWindow&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instance_event_window_Create: + operation: + $ref: '#/paths/~1?Action=CreateInstanceEventWindow&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instance_event_window_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteInstanceEventWindow&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instance_event_window_Disassociate: + operation: + $ref: '#/paths/~1?Action=DisassociateInstanceEventWindow&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instance_event_window_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyInstanceEventWindow&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instance_event_windows_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeInstanceEventWindows&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/instanceEventWindowSet/item + openAPIDocKey: '200' + id: aws.ec2_api.instance_event_windows + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/instance_event_windows/methods/instance_event_window_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/instance_event_windows/methods/instance_event_window_Create' + select: + - $ref: '#/components/x-stackQL-resources/instance_event_windows/methods/instance_event_windows_Describe' + update: [] + title: instance_event_windows + instance_export_task: + name: instance_export_task + methods: + instance_export_task_Create: + operation: + $ref: '#/paths/~1?Action=CreateInstanceExportTask&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.instance_export_task + sqlVerbs: + delete: [] + insert: + - $ref: '#/components/x-stackQL-resources/instance_export_task/methods/instance_export_task_Create' + select: [] + update: [] + title: instance_export_task + instance_maintenance_options: + name: instance_maintenance_options + methods: + instance_maintenance_options_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyInstanceMaintenanceOptions&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.instance_maintenance_options + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: instance_maintenance_options + instance_metadata_options: + name: instance_metadata_options + methods: + instance_metadata_options_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyInstanceMetadataOptions&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.instance_metadata_options + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: instance_metadata_options + instance_placement: + name: instance_placement + methods: + instance_placement_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyInstancePlacement&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.instance_placement + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: instance_placement + instance_status: + name: instance_status + methods: + instance_status_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeInstanceStatus&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/instanceStatusSet/item + openAPIDocKey: '200' + instance_status_Report: + operation: + $ref: '#/paths/~1?Action=ReportInstanceStatus&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.instance_status + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/instance_status/methods/instance_status_Describe' + update: [] + title: instance_status + instance_type_offerings: + name: instance_type_offerings + methods: + instance_type_offerings_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeInstanceTypeOfferings&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/instanceTypeOfferingSet/item + openAPIDocKey: '200' + id: aws.ec2_api.instance_type_offerings + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/instance_type_offerings/methods/instance_type_offerings_Describe' + update: [] + title: instance_type_offerings + instance_types: + name: instance_types + methods: + instance_types_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeInstanceTypes&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/instanceTypeSet/item + openAPIDocKey: '200' + id: aws.ec2_api.instance_types + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/instance_types/methods/instance_types_Describe' + update: [] + title: instance_types + instance_types_from_instance_requirements: + name: instance_types_from_instance_requirements + methods: + instance_types_from_instance_requirements_Get: + operation: + $ref: '#/paths/~1?Action=GetInstanceTypesFromInstanceRequirements&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/instanceTypeSet/item + openAPIDocKey: '200' + id: aws.ec2_api.instance_types_from_instance_requirements + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/instance_types_from_instance_requirements/methods/instance_types_from_instance_requirements_Get' + update: [] + title: instance_types_from_instance_requirements + instance_uefi_data: + name: instance_uefi_data + methods: + instance_uefi_data_Get: + operation: + $ref: '#/paths/~1?Action=GetInstanceUefiData&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.instance_uefi_data + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/instance_uefi_data/methods/instance_uefi_data_Get' + update: [] + title: instance_uefi_data + instances: + name: instances + methods: + instance_Bundle: + operation: + $ref: '#/paths/~1?Action=BundleInstance&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instance_Import: + operation: + $ref: '#/paths/~1?Action=ImportInstance&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instances_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/reservationSet/item/instancesSet/item + openAPIDocKey: '200' + instances_Monitor: + operation: + $ref: '#/paths/~1?Action=MonitorInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instances_Reboot: + operation: + $ref: '#/paths/~1?Action=RebootInstances&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + instances_Run: + operation: + $ref: '#/paths/~1?Action=RunInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instances_Start: + operation: + $ref: '#/paths/~1?Action=StartInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instances_Stop: + operation: + $ref: '#/paths/~1?Action=StopInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instances_Terminate: + operation: + $ref: '#/paths/~1?Action=TerminateInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + instances_Unmonitor: + operation: + $ref: '#/paths/~1?Action=UnmonitorInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.instances + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/instances/methods/instances_Describe' + update: [] + title: instances + internet_gateways: + name: internet_gateways + methods: + internet_gateway_Attach: + operation: + $ref: '#/paths/~1?Action=AttachInternetGateway&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + internet_gateway_Create: + operation: + $ref: '#/paths/~1?Action=CreateInternetGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + internet_gateway_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteInternetGateway&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + internet_gateway_Detach: + operation: + $ref: '#/paths/~1?Action=DetachInternetGateway&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + internet_gateways_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeInternetGateways&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/internetGatewaySet/item + openAPIDocKey: '200' + id: aws.ec2_api.internet_gateways + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/internet_gateway_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/internet_gateway_Create' + select: + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/internet_gateways_Describe' + update: [] + title: internet_gateways + ipam_address_history: + name: ipam_address_history + methods: + ipam_address_history_Get: + operation: + $ref: '#/paths/~1?Action=GetIpamAddressHistory&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/historyRecordSet/item + openAPIDocKey: '200' + id: aws.ec2_api.ipam_address_history + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/ipam_address_history/methods/ipam_address_history_Get' + update: [] + title: ipam_address_history + ipam_organization_admin_account: + name: ipam_organization_admin_account + methods: + ipam_organization_admin_account_Disable: + operation: + $ref: '#/paths/~1?Action=DisableIpamOrganizationAdminAccount&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_organization_admin_account_Enable: + operation: + $ref: '#/paths/~1?Action=EnableIpamOrganizationAdminAccount&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.ipam_organization_admin_account + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: ipam_organization_admin_account + ipam_pool_allocations: + name: ipam_pool_allocations + methods: + ipam_pool_allocation_Release: + operation: + $ref: '#/paths/~1?Action=ReleaseIpamPoolAllocation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_pool_allocations_Get: + operation: + $ref: '#/paths/~1?Action=GetIpamPoolAllocations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/ipamPoolAllocationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.ipam_pool_allocations + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/ipam_pool_allocations/methods/ipam_pool_allocations_Get' + update: [] + title: ipam_pool_allocations + ipam_pool_cidrs: + name: ipam_pool_cidrs + methods: + ipam_pool_cidr_Allocate: + operation: + $ref: '#/paths/~1?Action=AllocateIpamPoolCidr&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_pool_cidr_Deprovision: + operation: + $ref: '#/paths/~1?Action=DeprovisionIpamPoolCidr&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_pool_cidr_Provision: + operation: + $ref: '#/paths/~1?Action=ProvisionIpamPoolCidr&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_pool_cidrs_Get: + operation: + $ref: '#/paths/~1?Action=GetIpamPoolCidrs&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/ipamPoolCidrSet/item + openAPIDocKey: '200' + id: aws.ec2_api.ipam_pool_cidrs + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/ipam_pool_cidrs/methods/ipam_pool_cidrs_Get' + update: [] + title: ipam_pool_cidrs + ipam_pools: + name: ipam_pools + methods: + ipam_pool_Create: + operation: + $ref: '#/paths/~1?Action=CreateIpamPool&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_pool_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteIpamPool&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_pool_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyIpamPool&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_pools_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeIpamPools&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/ipamPoolSet/item + openAPIDocKey: '200' + id: aws.ec2_api.ipam_pools + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/ipam_pool_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/ipam_pool_Create' + select: + - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/ipam_pools_Describe' + update: [] + title: ipam_pools + ipam_resource_cidrs: + name: ipam_resource_cidrs + methods: + ipam_resource_cidr_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyIpamResourceCidr&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_resource_cidrs_Get: + operation: + $ref: '#/paths/~1?Action=GetIpamResourceCidrs&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/ipamResourceCidrSet/item + openAPIDocKey: '200' + id: aws.ec2_api.ipam_resource_cidrs + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/ipam_resource_cidrs/methods/ipam_resource_cidrs_Get' + update: [] + title: ipam_resource_cidrs + ipam_scopes: + name: ipam_scopes + methods: + ipam_scope_Create: + operation: + $ref: '#/paths/~1?Action=CreateIpamScope&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_scope_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteIpamScope&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_scope_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyIpamScope&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_scopes_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeIpamScopes&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/ipamScopeSet/item + openAPIDocKey: '200' + id: aws.ec2_api.ipam_scopes + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/ipam_scope_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/ipam_scope_Create' + select: + - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/ipam_scopes_Describe' + update: [] + title: ipam_scopes + ipams: + name: ipams + methods: + ipam_Create: + operation: + $ref: '#/paths/~1?Action=CreateIpam&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteIpam&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipam_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyIpam&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipams_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeIpams&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/ipamSet/item + openAPIDocKey: '200' + id: aws.ec2_api.ipams + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/ipams/methods/ipam_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/ipams/methods/ipam_Create' + select: + - $ref: '#/components/x-stackQL-resources/ipams/methods/ipams_Describe' + update: [] + title: ipams + ipv6_addresses: + name: ipv6_addresses + methods: + ipv6_addresses_Assign: + operation: + $ref: '#/paths/~1?Action=AssignIpv6Addresses&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + ipv6_addresses_Unassign: + operation: + $ref: '#/paths/~1?Action=UnassignIpv6Addresses&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.ipv6_addresses + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: ipv6_addresses + ipv6_pools: + name: ipv6_pools + methods: + ipv6_pools_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeIpv6Pools&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/ipv6PoolSet/item + openAPIDocKey: '200' + id: aws.ec2_api.ipv6_pools + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/ipv6_pools/methods/ipv6_pools_Describe' + update: [] + title: ipv6_pools + key_pairs: + name: key_pairs + methods: + key_pair_Create: + operation: + $ref: '#/paths/~1?Action=CreateKeyPair&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + key_pair_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteKeyPair&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + key_pair_Import: + operation: + $ref: '#/paths/~1?Action=ImportKeyPair&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + key_pairs_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeKeyPairs&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.key_pairs + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/key_pairs/methods/key_pair_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/key_pairs/methods/key_pair_Create' + select: + - $ref: '#/components/x-stackQL-resources/key_pairs/methods/key_pairs_Describe' + update: [] + title: key_pairs + launch_template_data: + name: launch_template_data + methods: + launch_template_data_Get: + operation: + $ref: '#/paths/~1?Action=GetLaunchTemplateData&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.launch_template_data + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/launch_template_data/methods/launch_template_data_Get' + update: [] + title: launch_template_data + launch_template_versions: + name: launch_template_versions + methods: + launch_template_version_Create: + operation: + $ref: '#/paths/~1?Action=CreateLaunchTemplateVersion&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + launch_template_versions_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteLaunchTemplateVersions&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + launch_template_versions_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeLaunchTemplateVersions&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/launchTemplateVersionSet/item + openAPIDocKey: '200' + id: aws.ec2_api.launch_template_versions + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/launch_template_versions/methods/launch_template_versions_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/launch_template_versions/methods/launch_template_version_Create' + select: + - $ref: '#/components/x-stackQL-resources/launch_template_versions/methods/launch_template_versions_Describe' + update: [] + title: launch_template_versions + launch_templates: + name: launch_templates + methods: + launch_template_Create: + operation: + $ref: '#/paths/~1?Action=CreateLaunchTemplate&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + launch_template_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteLaunchTemplate&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + launch_template_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyLaunchTemplate&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + launch_templates_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeLaunchTemplates&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/launchTemplates/item + openAPIDocKey: '200' + id: aws.ec2_api.launch_templates + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/launch_templates/methods/launch_template_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/launch_templates/methods/launch_template_Create' + select: + - $ref: '#/components/x-stackQL-resources/launch_templates/methods/launch_templates_Describe' + update: [] + title: launch_templates + local_gateway_route_table_virtual_interface_group_associations: + name: local_gateway_route_table_virtual_interface_group_associations + methods: + local_gateway_route_table_virtual_interface_group_associations_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/localGatewayRouteTableVirtualInterfaceGroupAssociationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.local_gateway_route_table_virtual_interface_group_associations + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_virtual_interface_group_associations/methods/local_gateway_route_table_virtual_interface_group_associations_Describe' + update: [] + title: local_gateway_route_table_virtual_interface_group_associations + local_gateway_route_table_vpc_associations: + name: local_gateway_route_table_vpc_associations + methods: + local_gateway_route_table_vpc_association_Create: + operation: + $ref: '#/paths/~1?Action=CreateLocalGatewayRouteTableVpcAssociation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + local_gateway_route_table_vpc_association_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteLocalGatewayRouteTableVpcAssociation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + local_gateway_route_table_vpc_associations_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeLocalGatewayRouteTableVpcAssociations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/localGatewayRouteTableVpcAssociationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.local_gateway_route_table_vpc_associations + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_vpc_associations/methods/local_gateway_route_table_vpc_association_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_vpc_associations/methods/local_gateway_route_table_vpc_association_Create' + select: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_vpc_associations/methods/local_gateway_route_table_vpc_associations_Describe' + update: [] + title: local_gateway_route_table_vpc_associations + local_gateway_route_tables: + name: local_gateway_route_tables + methods: + local_gateway_route_tables_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeLocalGatewayRouteTables&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/localGatewayRouteTableSet/item + openAPIDocKey: '200' + id: aws.ec2_api.local_gateway_route_tables + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tables/methods/local_gateway_route_tables_Describe' + update: [] + title: local_gateway_route_tables + local_gateway_routes: + name: local_gateway_routes + methods: + local_gateway_route_Create: + operation: + $ref: '#/paths/~1?Action=CreateLocalGatewayRoute&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + local_gateway_route_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteLocalGatewayRoute&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + local_gateway_routes_Search: + operation: + $ref: '#/paths/~1?Action=SearchLocalGatewayRoutes&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.local_gateway_routes + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/local_gateway_route_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/local_gateway_route_Create' + select: [] + update: [] + title: local_gateway_routes + local_gateway_virtual_interface_groups: + name: local_gateway_virtual_interface_groups + methods: + local_gateway_virtual_interface_groups_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeLocalGatewayVirtualInterfaceGroups&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/localGatewayVirtualInterfaceGroupSet/item + openAPIDocKey: '200' + id: aws.ec2_api.local_gateway_virtual_interface_groups + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/local_gateway_virtual_interface_groups/methods/local_gateway_virtual_interface_groups_Describe' + update: [] + title: local_gateway_virtual_interface_groups + local_gateway_virtual_interfaces: + name: local_gateway_virtual_interfaces + methods: + local_gateway_virtual_interfaces_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeLocalGatewayVirtualInterfaces&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/localGatewayVirtualInterfaceSet/item + openAPIDocKey: '200' + id: aws.ec2_api.local_gateway_virtual_interfaces + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/local_gateway_virtual_interfaces/methods/local_gateway_virtual_interfaces_Describe' + update: [] + title: local_gateway_virtual_interfaces + local_gateways: + name: local_gateways + methods: + local_gateways_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeLocalGateways&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/localGatewaySet/item + openAPIDocKey: '200' + id: aws.ec2_api.local_gateways + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/local_gateways/methods/local_gateways_Describe' + update: [] + title: local_gateways + managed_prefix_list_associations: + name: managed_prefix_list_associations + methods: + managed_prefix_list_associations_Get: + operation: + $ref: '#/paths/~1?Action=GetManagedPrefixListAssociations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/prefixListAssociationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.managed_prefix_list_associations + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/managed_prefix_list_associations/methods/managed_prefix_list_associations_Get' + update: [] + title: managed_prefix_list_associations + managed_prefix_list_entries: + name: managed_prefix_list_entries + methods: + managed_prefix_list_entries_Get: + operation: + $ref: '#/paths/~1?Action=GetManagedPrefixListEntries&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/entrySet/item + openAPIDocKey: '200' + id: aws.ec2_api.managed_prefix_list_entries + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/managed_prefix_list_entries/methods/managed_prefix_list_entries_Get' + update: [] + title: managed_prefix_list_entries + managed_prefix_list_version: + name: managed_prefix_list_version + methods: + managed_prefix_list_version_Restore: + operation: + $ref: '#/paths/~1?Action=RestoreManagedPrefixListVersion&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.managed_prefix_list_version + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: managed_prefix_list_version + managed_prefix_lists: + name: managed_prefix_lists + methods: + managed_prefix_list_Create: + operation: + $ref: '#/paths/~1?Action=CreateManagedPrefixList&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + managed_prefix_list_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteManagedPrefixList&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + managed_prefix_list_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyManagedPrefixList&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + managed_prefix_lists_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeManagedPrefixLists&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/prefixListSet/item + openAPIDocKey: '200' + id: aws.ec2_api.managed_prefix_lists + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/managed_prefix_lists/methods/managed_prefix_list_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/managed_prefix_lists/methods/managed_prefix_list_Create' + select: + - $ref: '#/components/x-stackQL-resources/managed_prefix_lists/methods/managed_prefix_lists_Describe' + update: [] + title: managed_prefix_lists + moving_addresses: + name: moving_addresses + methods: + moving_addresses_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeMovingAddresses&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/movingAddressStatusSet/item + openAPIDocKey: '200' + id: aws.ec2_api.moving_addresses + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/moving_addresses/methods/moving_addresses_Describe' + update: [] + title: moving_addresses + nat_gateways: + name: nat_gateways + methods: + nat_gateway_Create: + operation: + $ref: '#/paths/~1?Action=CreateNatGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + nat_gateway_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteNatGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + nat_gateways_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeNatGateways&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/natGatewaySet/item + openAPIDocKey: '200' + id: aws.ec2_api.nat_gateways + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/nat_gateway_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/nat_gateway_Create' + select: + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/nat_gateways_Describe' + update: [] + title: nat_gateways + network_acl_association: + name: network_acl_association + methods: + network_acl_association_Replace: + operation: + $ref: '#/paths/~1?Action=ReplaceNetworkAclAssociation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.network_acl_association + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: network_acl_association + network_acl_entry: + name: network_acl_entry + methods: + network_acl_entry_Create: + operation: + $ref: '#/paths/~1?Action=CreateNetworkAclEntry&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + network_acl_entry_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteNetworkAclEntry&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + network_acl_entry_Replace: + operation: + $ref: '#/paths/~1?Action=ReplaceNetworkAclEntry&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.network_acl_entry + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/network_acl_entry/methods/network_acl_entry_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/network_acl_entry/methods/network_acl_entry_Create' + select: [] + update: [] + title: network_acl_entry + network_acls: + name: network_acls + methods: + network_acl_Create: + operation: + $ref: '#/paths/~1?Action=CreateNetworkAcl&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + network_acl_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteNetworkAcl&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + network_acls_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeNetworkAcls&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/networkAclSet/item + openAPIDocKey: '200' + id: aws.ec2_api.network_acls + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/network_acls/methods/network_acl_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/network_acls/methods/network_acl_Create' + select: + - $ref: '#/components/x-stackQL-resources/network_acls/methods/network_acls_Describe' + update: [] + title: network_acls + network_insights_access_scope_analyses: + name: network_insights_access_scope_analyses + methods: + network_insights_access_scope_analyses_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeNetworkInsightsAccessScopeAnalyses&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/networkInsightsAccessScopeAnalysisSet/item + openAPIDocKey: '200' + id: aws.ec2_api.network_insights_access_scope_analyses + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analyses/methods/network_insights_access_scope_analyses_Describe' + update: [] + title: network_insights_access_scope_analyses + network_insights_access_scope_analysis: + name: network_insights_access_scope_analysis + methods: + network_insights_access_scope_analysis_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteNetworkInsightsAccessScopeAnalysis&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + network_insights_access_scope_analysis_Start: + operation: + $ref: '#/paths/~1?Action=StartNetworkInsightsAccessScopeAnalysis&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.network_insights_access_scope_analysis + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analysis/methods/network_insights_access_scope_analysis_Delete' + insert: [] + select: [] + update: [] + title: network_insights_access_scope_analysis + network_insights_access_scope_analysis_findings: + name: network_insights_access_scope_analysis_findings + methods: + network_insights_access_scope_analysis_findings_Get: + operation: + $ref: '#/paths/~1?Action=GetNetworkInsightsAccessScopeAnalysisFindings&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/analysisFindingSet/item + openAPIDocKey: '200' + id: aws.ec2_api.network_insights_access_scope_analysis_findings + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analysis_findings/methods/network_insights_access_scope_analysis_findings_Get' + update: [] + title: network_insights_access_scope_analysis_findings + network_insights_access_scope_content: + name: network_insights_access_scope_content + methods: + network_insights_access_scope_content_Get: + operation: + $ref: '#/paths/~1?Action=GetNetworkInsightsAccessScopeContent&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.network_insights_access_scope_content + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_content/methods/network_insights_access_scope_content_Get' + update: [] + title: network_insights_access_scope_content + network_insights_access_scopes: + name: network_insights_access_scopes + methods: + network_insights_access_scope_Create: + operation: + $ref: '#/paths/~1?Action=CreateNetworkInsightsAccessScope&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + network_insights_access_scope_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteNetworkInsightsAccessScope&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + network_insights_access_scopes_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeNetworkInsightsAccessScopes&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/networkInsightsAccessScopeSet/item + openAPIDocKey: '200' + id: aws.ec2_api.network_insights_access_scopes + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/network_insights_access_scope_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/network_insights_access_scope_Create' + select: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/network_insights_access_scopes_Describe' + update: [] + title: network_insights_access_scopes + network_insights_analyses: + name: network_insights_analyses + methods: + network_insights_analyses_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeNetworkInsightsAnalyses&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/networkInsightsAnalysisSet/item + openAPIDocKey: '200' + id: aws.ec2_api.network_insights_analyses + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/network_insights_analyses/methods/network_insights_analyses_Describe' + update: [] + title: network_insights_analyses + network_insights_analysis: + name: network_insights_analysis + methods: + network_insights_analysis_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteNetworkInsightsAnalysis&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + network_insights_analysis_Start: + operation: + $ref: '#/paths/~1?Action=StartNetworkInsightsAnalysis&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.network_insights_analysis + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/network_insights_analysis/methods/network_insights_analysis_Delete' + insert: [] + select: [] + update: [] + title: network_insights_analysis + network_insights_paths: + name: network_insights_paths + methods: + network_insights_path_Create: + operation: + $ref: '#/paths/~1?Action=CreateNetworkInsightsPath&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + network_insights_path_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteNetworkInsightsPath&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + network_insights_paths_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeNetworkInsightsPaths&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/networkInsightsPathSet/item + openAPIDocKey: '200' + id: aws.ec2_api.network_insights_paths + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/network_insights_path_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/network_insights_path_Create' + select: + - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/network_insights_paths_Describe' + update: [] + title: network_insights_paths + network_interface_attribute: + name: network_interface_attribute + methods: + network_interface_attribute_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeNetworkInterfaceAttribute&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + network_interface_attribute_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyNetworkInterfaceAttribute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + network_interface_attribute_Reset: + operation: + $ref: '#/paths/~1?Action=ResetNetworkInterfaceAttribute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.network_interface_attribute + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/network_interface_attribute/methods/network_interface_attribute_Describe' + update: [] + title: network_interface_attribute + network_interface_permissions: + name: network_interface_permissions + methods: + network_interface_permission_Create: + operation: + $ref: '#/paths/~1?Action=CreateNetworkInterfacePermission&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + network_interface_permission_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteNetworkInterfacePermission&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + network_interface_permissions_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeNetworkInterfacePermissions&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/networkInterfacePermissions/item + openAPIDocKey: '200' + id: aws.ec2_api.network_interface_permissions + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/network_interface_permissions/methods/network_interface_permission_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/network_interface_permissions/methods/network_interface_permission_Create' + select: + - $ref: '#/components/x-stackQL-resources/network_interface_permissions/methods/network_interface_permissions_Describe' + update: [] + title: network_interface_permissions + network_interfaces: + name: network_interfaces + methods: + network_interface_Attach: + operation: + $ref: '#/paths/~1?Action=AttachNetworkInterface&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + network_interface_Create: + operation: + $ref: '#/paths/~1?Action=CreateNetworkInterface&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + network_interface_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteNetworkInterface&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + network_interface_Detach: + operation: + $ref: '#/paths/~1?Action=DetachNetworkInterface&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + network_interfaces_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeNetworkInterfaces&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/networkInterfaceSet/item + openAPIDocKey: '200' + id: aws.ec2_api.network_interfaces + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/network_interface_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/network_interface_Create' + select: + - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/network_interfaces_Describe' + update: [] + title: network_interfaces + password_data: + name: password_data + methods: + password_data_Get: + operation: + $ref: '#/paths/~1?Action=GetPasswordData&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.password_data + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/password_data/methods/password_data_Get' + update: [] + title: password_data + placement_groups: + name: placement_groups + methods: + placement_group_Create: + operation: + $ref: '#/paths/~1?Action=CreatePlacementGroup&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + placement_group_Delete: + operation: + $ref: '#/paths/~1?Action=DeletePlacementGroup&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + placement_groups_Describe: + operation: + $ref: '#/paths/~1?Action=DescribePlacementGroups&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/placementGroupSet/item + openAPIDocKey: '200' + id: aws.ec2_api.placement_groups + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/placement_groups/methods/placement_group_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/placement_groups/methods/placement_group_Create' + select: + - $ref: '#/components/x-stackQL-resources/placement_groups/methods/placement_groups_Describe' + update: [] + title: placement_groups + prefix_lists: + name: prefix_lists + methods: + prefix_lists_Describe: + operation: + $ref: '#/paths/~1?Action=DescribePrefixLists&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/prefixListSet/item + openAPIDocKey: '200' + id: aws.ec2_api.prefix_lists + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/prefix_lists/methods/prefix_lists_Describe' + update: [] + title: prefix_lists + principal_id_format: + name: principal_id_format + methods: + principal_id_format_Describe: + operation: + $ref: '#/paths/~1?Action=DescribePrincipalIdFormat&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/principalSet/item + openAPIDocKey: '200' + id: aws.ec2_api.principal_id_format + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/principal_id_format/methods/principal_id_format_Describe' + update: [] + title: principal_id_format + private_dns_name_options: + name: private_dns_name_options + methods: + private_dns_name_options_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyPrivateDnsNameOptions&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.private_dns_name_options + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: private_dns_name_options + private_ip_addresses: + name: private_ip_addresses + methods: + private_ip_addresses_Assign: + operation: + $ref: '#/paths/~1?Action=AssignPrivateIpAddresses&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + private_ip_addresses_Unassign: + operation: + $ref: '#/paths/~1?Action=UnassignPrivateIpAddresses&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.private_ip_addresses + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: private_ip_addresses + product_instance: + name: product_instance + methods: + product_instance_Confirm: + operation: + $ref: '#/paths/~1?Action=ConfirmProductInstance&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.product_instance + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: product_instance + public_ipv4_pool_cidr: + name: public_ipv4_pool_cidr + methods: + public_ipv4_pool_cidr_Deprovision: + operation: + $ref: '#/paths/~1?Action=DeprovisionPublicIpv4PoolCidr&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + public_ipv4_pool_cidr_Provision: + operation: + $ref: '#/paths/~1?Action=ProvisionPublicIpv4PoolCidr&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.public_ipv4_pool_cidr + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: public_ipv4_pool_cidr + public_ipv4_pools: + name: public_ipv4_pools + methods: + public_ipv4_pool_Create: + operation: + $ref: '#/paths/~1?Action=CreatePublicIpv4Pool&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + public_ipv4_pool_Delete: + operation: + $ref: '#/paths/~1?Action=DeletePublicIpv4Pool&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + public_ipv4_pools_Describe: + operation: + $ref: '#/paths/~1?Action=DescribePublicIpv4Pools&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/publicIpv4PoolSet/item + openAPIDocKey: '200' + id: aws.ec2_api.public_ipv4_pools + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/public_ipv4_pools/methods/public_ipv4_pool_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/public_ipv4_pools/methods/public_ipv4_pool_Create' + select: + - $ref: '#/components/x-stackQL-resources/public_ipv4_pools/methods/public_ipv4_pools_Describe' + update: [] + title: public_ipv4_pools + queued_reserved_instances: + name: queued_reserved_instances + methods: + queued_reserved_instances_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteQueuedReservedInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.queued_reserved_instances + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/queued_reserved_instances/methods/queued_reserved_instances_Delete' + insert: [] + select: [] + update: [] + title: queued_reserved_instances + regions: + name: regions + methods: + regions_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeRegions&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/regionInfo/item + openAPIDocKey: '200' + id: aws.ec2_api.regions + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/regions/methods/regions_Describe' + update: [] + title: regions + replace_root_volume_tasks: + name: replace_root_volume_tasks + methods: + replace_root_volume_task_Create: + operation: + $ref: '#/paths/~1?Action=CreateReplaceRootVolumeTask&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + replace_root_volume_tasks_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeReplaceRootVolumeTasks&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/replaceRootVolumeTaskSet/item + openAPIDocKey: '200' + id: aws.ec2_api.replace_root_volume_tasks + sqlVerbs: + delete: [] + insert: + - $ref: '#/components/x-stackQL-resources/replace_root_volume_tasks/methods/replace_root_volume_task_Create' + select: + - $ref: '#/components/x-stackQL-resources/replace_root_volume_tasks/methods/replace_root_volume_tasks_Describe' + update: [] + title: replace_root_volume_tasks + reserved_instances: + name: reserved_instances + methods: + reserved_instances_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeReservedInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/reservedInstancesSet/item + openAPIDocKey: '200' + reserved_instances_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyReservedInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.reserved_instances + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/reserved_instances/methods/reserved_instances_Describe' + update: [] + title: reserved_instances + reserved_instances_exchange_quote: + name: reserved_instances_exchange_quote + methods: + reserved_instances_exchange_quote_Accept: + operation: + $ref: '#/paths/~1?Action=AcceptReservedInstancesExchangeQuote&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + reserved_instances_exchange_quote_Get: + operation: + $ref: '#/paths/~1?Action=GetReservedInstancesExchangeQuote&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.reserved_instances_exchange_quote + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/reserved_instances_exchange_quote/methods/reserved_instances_exchange_quote_Get' + update: [] + title: reserved_instances_exchange_quote + reserved_instances_listings: + name: reserved_instances_listings + methods: + reserved_instances_listing_Cancel: + operation: + $ref: '#/paths/~1?Action=CancelReservedInstancesListing&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + reserved_instances_listing_Create: + operation: + $ref: '#/paths/~1?Action=CreateReservedInstancesListing&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + reserved_instances_listings_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeReservedInstancesListings&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/reservedInstancesListingsSet/item + openAPIDocKey: '200' + id: aws.ec2_api.reserved_instances_listings + sqlVerbs: + delete: [] + insert: + - $ref: '#/components/x-stackQL-resources/reserved_instances_listings/methods/reserved_instances_listing_Create' + select: + - $ref: '#/components/x-stackQL-resources/reserved_instances_listings/methods/reserved_instances_listings_Describe' + update: [] + title: reserved_instances_listings + reserved_instances_modifications: + name: reserved_instances_modifications + methods: + reserved_instances_modifications_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeReservedInstancesModifications&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/reservedInstancesModificationsSet/item + openAPIDocKey: '200' + id: aws.ec2_api.reserved_instances_modifications + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/reserved_instances_modifications/methods/reserved_instances_modifications_Describe' + update: [] + title: reserved_instances_modifications + reserved_instances_offerings: + name: reserved_instances_offerings + methods: + reserved_instances_offering_Purchase: + operation: + $ref: '#/paths/~1?Action=PurchaseReservedInstancesOffering&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + reserved_instances_offerings_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeReservedInstancesOfferings&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/reservedInstancesOfferingsSet/item + openAPIDocKey: '200' + id: aws.ec2_api.reserved_instances_offerings + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/reserved_instances_offerings/methods/reserved_instances_offerings_Describe' + update: [] + title: reserved_instances_offerings + restore_image_task: + name: restore_image_task + methods: + restore_image_task_Create: + operation: + $ref: '#/paths/~1?Action=CreateRestoreImageTask&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.restore_image_task + sqlVerbs: + delete: [] + insert: + - $ref: '#/components/x-stackQL-resources/restore_image_task/methods/restore_image_task_Create' + select: [] + update: [] + title: restore_image_task + route: + name: route + methods: + route_Create: + operation: + $ref: '#/paths/~1?Action=CreateRoute&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + route_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteRoute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + route_Replace: + operation: + $ref: '#/paths/~1?Action=ReplaceRoute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.route + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/route/methods/route_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/route/methods/route_Create' + select: [] + update: [] + title: route + route_table_association: + name: route_table_association + methods: + route_table_association_Replace: + operation: + $ref: '#/paths/~1?Action=ReplaceRouteTableAssociation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.route_table_association + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: route_table_association + route_tables: + name: route_tables + methods: + route_table_Associate: + operation: + $ref: '#/paths/~1?Action=AssociateRouteTable&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + route_table_Create: + operation: + $ref: '#/paths/~1?Action=CreateRouteTable&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + route_table_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteRouteTable&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + route_table_Disassociate: + operation: + $ref: '#/paths/~1?Action=DisassociateRouteTable&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + route_tables_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeRouteTables&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/routeTableSet/item + openAPIDocKey: '200' + id: aws.ec2_api.route_tables + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/route_tables/methods/route_table_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/route_tables/methods/route_table_Create' + select: + - $ref: '#/components/x-stackQL-resources/route_tables/methods/route_tables_Describe' + update: [] + title: route_tables + scheduled_instance_availability: + name: scheduled_instance_availability + methods: + scheduled_instance_availability_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeScheduledInstanceAvailability&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/scheduledInstanceAvailabilitySet/item + openAPIDocKey: '200' + id: aws.ec2_api.scheduled_instance_availability + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/scheduled_instance_availability/methods/scheduled_instance_availability_Describe' + update: [] + title: scheduled_instance_availability + scheduled_instances: + name: scheduled_instances + methods: + scheduled_instances_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeScheduledInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/scheduledInstanceSet/item + openAPIDocKey: '200' + scheduled_instances_Purchase: + operation: + $ref: '#/paths/~1?Action=PurchaseScheduledInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + scheduled_instances_Run: + operation: + $ref: '#/paths/~1?Action=RunScheduledInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.scheduled_instances + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/scheduled_instances/methods/scheduled_instances_Describe' + update: [] + title: scheduled_instances + security_group_egress: + name: security_group_egress + methods: + security_group_egress_Authorize: + operation: + $ref: '#/paths/~1?Action=AuthorizeSecurityGroupEgress&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + security_group_egress_Revoke: + operation: + $ref: '#/paths/~1?Action=RevokeSecurityGroupEgress&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.security_group_egress + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: security_group_egress + security_group_ingress: + name: security_group_ingress + methods: + security_group_ingress_Authorize: + operation: + $ref: '#/paths/~1?Action=AuthorizeSecurityGroupIngress&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + security_group_ingress_Revoke: + operation: + $ref: '#/paths/~1?Action=RevokeSecurityGroupIngress&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.security_group_ingress + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: security_group_ingress + security_group_references: + name: security_group_references + methods: + security_group_references_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSecurityGroupReferences&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/securityGroupReferenceSet/item + openAPIDocKey: '200' + id: aws.ec2_api.security_group_references + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/security_group_references/methods/security_group_references_Describe' + update: [] + title: security_group_references + security_group_rule_descriptions_egress: + name: security_group_rule_descriptions_egress + methods: + security_group_rule_descriptions_egress_Update: + operation: + $ref: '#/paths/~1?Action=UpdateSecurityGroupRuleDescriptionsEgress&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.security_group_rule_descriptions_egress + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: security_group_rule_descriptions_egress + security_group_rule_descriptions_ingress: + name: security_group_rule_descriptions_ingress + methods: + security_group_rule_descriptions_ingress_Update: + operation: + $ref: '#/paths/~1?Action=UpdateSecurityGroupRuleDescriptionsIngress&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.security_group_rule_descriptions_ingress + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: security_group_rule_descriptions_ingress + security_group_rules: + name: security_group_rules + methods: + security_group_rules_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSecurityGroupRules&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/securityGroupRuleSet/item + openAPIDocKey: '200' + security_group_rules_Modify: + operation: + $ref: '#/paths/~1?Action=ModifySecurityGroupRules&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.security_group_rules + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/security_group_rules/methods/security_group_rules_Describe' + update: [] + title: security_group_rules + security_groups: + name: security_groups + methods: + security_group_Create: + operation: + $ref: '#/paths/~1?Action=CreateSecurityGroup&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + security_group_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteSecurityGroup&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + security_groups_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSecurityGroups&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/securityGroupInfo/item + openAPIDocKey: '200' + id: aws.ec2_api.security_groups + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/security_groups/methods/security_group_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/security_groups/methods/security_group_Create' + select: + - $ref: '#/components/x-stackQL-resources/security_groups/methods/security_groups_Describe' + update: [] + title: security_groups + security_groups_to_client_vpn_target_network: + name: security_groups_to_client_vpn_target_network + methods: + security_groups_to_client_vpn_target_network_Apply: + operation: + $ref: '#/paths/~1?Action=ApplySecurityGroupsToClientVpnTargetNetwork&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.security_groups_to_client_vpn_target_network + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: security_groups_to_client_vpn_target_network + serial_console_access: + name: serial_console_access + methods: + serial_console_access_Disable: + operation: + $ref: '#/paths/~1?Action=DisableSerialConsoleAccess&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + serial_console_access_Enable: + operation: + $ref: '#/paths/~1?Action=EnableSerialConsoleAccess&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.serial_console_access + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: serial_console_access + serial_console_access_status: + name: serial_console_access_status + methods: + serial_console_access_status_Get: + operation: + $ref: '#/paths/~1?Action=GetSerialConsoleAccessStatus&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.serial_console_access_status + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/serial_console_access_status/methods/serial_console_access_status_Get' + update: [] + title: serial_console_access_status + snapshot_attribute: + name: snapshot_attribute + methods: + snapshot_attribute_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSnapshotAttribute&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + snapshot_attribute_Modify: + operation: + $ref: '#/paths/~1?Action=ModifySnapshotAttribute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + snapshot_attribute_Reset: + operation: + $ref: '#/paths/~1?Action=ResetSnapshotAttribute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.snapshot_attribute + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/snapshot_attribute/methods/snapshot_attribute_Describe' + update: [] + title: snapshot_attribute + snapshot_from_recycle_bin: + name: snapshot_from_recycle_bin + methods: + snapshot_from_recycle_bin_Restore: + operation: + $ref: '#/paths/~1?Action=RestoreSnapshotFromRecycleBin&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.snapshot_from_recycle_bin + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: snapshot_from_recycle_bin + snapshot_tier: + name: snapshot_tier + methods: + snapshot_tier_Modify: + operation: + $ref: '#/paths/~1?Action=ModifySnapshotTier&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + snapshot_tier_Restore: + operation: + $ref: '#/paths/~1?Action=RestoreSnapshotTier&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.snapshot_tier + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: snapshot_tier + snapshot_tier_status: + name: snapshot_tier_status + methods: + snapshot_tier_status_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSnapshotTierStatus&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/snapshotTierStatusSet/item + openAPIDocKey: '200' + id: aws.ec2_api.snapshot_tier_status + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/snapshot_tier_status/methods/snapshot_tier_status_Describe' + update: [] + title: snapshot_tier_status + snapshots: + name: snapshots + methods: + snapshot_Copy: + operation: + $ref: '#/paths/~1?Action=CopySnapshot&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + snapshot_Create: + operation: + $ref: '#/paths/~1?Action=CreateSnapshot&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + snapshot_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteSnapshot&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + snapshot_Import: + operation: + $ref: '#/paths/~1?Action=ImportSnapshot&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + snapshots_Create: + operation: + $ref: '#/paths/~1?Action=CreateSnapshots&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + snapshots_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSnapshots&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/snapshotSet/item + openAPIDocKey: '200' + id: aws.ec2_api.snapshots + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/snapshots/methods/snapshot_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/snapshots/methods/snapshot_Create' + - $ref: '#/components/x-stackQL-resources/snapshots/methods/snapshots_Create' + select: + - $ref: '#/components/x-stackQL-resources/snapshots/methods/snapshots_Describe' + update: [] + title: snapshots + snapshots_in_recycle_bin: + name: snapshots_in_recycle_bin + methods: + snapshots_in_recycle_bin_List: + operation: + $ref: '#/paths/~1?Action=ListSnapshotsInRecycleBin&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/snapshotSet/item + openAPIDocKey: '200' + id: aws.ec2_api.snapshots_in_recycle_bin + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/snapshots_in_recycle_bin/methods/snapshots_in_recycle_bin_List' + update: [] + title: snapshots_in_recycle_bin + spot_datafeed_subscription: + name: spot_datafeed_subscription + methods: + spot_datafeed_subscription_Create: + operation: + $ref: '#/paths/~1?Action=CreateSpotDatafeedSubscription&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + spot_datafeed_subscription_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteSpotDatafeedSubscription&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + spot_datafeed_subscription_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSpotDatafeedSubscription&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/spotDatafeedSubscription/* + openAPIDocKey: '200' + id: aws.ec2_api.spot_datafeed_subscription + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/spot_datafeed_subscription/methods/spot_datafeed_subscription_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/spot_datafeed_subscription/methods/spot_datafeed_subscription_Create' + select: + - $ref: '#/components/x-stackQL-resources/spot_datafeed_subscription/methods/spot_datafeed_subscription_Describe' + update: [] + title: spot_datafeed_subscription + spot_fleet: + name: spot_fleet + methods: + spot_fleet_Request: + operation: + $ref: '#/paths/~1?Action=RequestSpotFleet&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.spot_fleet + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: spot_fleet + spot_fleet_instances: + name: spot_fleet_instances + methods: + spot_fleet_instances_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSpotFleetInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/activeInstanceSet/item + openAPIDocKey: '200' + id: aws.ec2_api.spot_fleet_instances + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/spot_fleet_instances/methods/spot_fleet_instances_Describe' + update: [] + title: spot_fleet_instances + spot_fleet_request_history: + name: spot_fleet_request_history + methods: + spot_fleet_request_history_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSpotFleetRequestHistory&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/historyRecordSet/item + openAPIDocKey: '200' + id: aws.ec2_api.spot_fleet_request_history + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/spot_fleet_request_history/methods/spot_fleet_request_history_Describe' + update: [] + title: spot_fleet_request_history + spot_fleet_requests: + name: spot_fleet_requests + methods: + spot_fleet_request_Modify: + operation: + $ref: '#/paths/~1?Action=ModifySpotFleetRequest&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + spot_fleet_requests_Cancel: + operation: + $ref: '#/paths/~1?Action=CancelSpotFleetRequests&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + spot_fleet_requests_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSpotFleetRequests&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/spotFleetRequestConfigSet/item + openAPIDocKey: '200' + id: aws.ec2_api.spot_fleet_requests + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/spot_fleet_requests/methods/spot_fleet_requests_Describe' + update: [] + title: spot_fleet_requests + spot_instance_requests: + name: spot_instance_requests + methods: + spot_instance_requests_Cancel: + operation: + $ref: '#/paths/~1?Action=CancelSpotInstanceRequests&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + spot_instance_requests_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSpotInstanceRequests&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/spotInstanceRequestSet/item + openAPIDocKey: '200' + id: aws.ec2_api.spot_instance_requests + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/spot_instance_requests/methods/spot_instance_requests_Describe' + update: [] + title: spot_instance_requests + spot_instances: + name: spot_instances + methods: + spot_instances_Request: + operation: + $ref: '#/paths/~1?Action=RequestSpotInstances&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.spot_instances + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: spot_instances + spot_placement_scores: + name: spot_placement_scores + methods: + spot_placement_scores_Get: + operation: + $ref: '#/paths/~1?Action=GetSpotPlacementScores&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/spotPlacementScoreSet/item + openAPIDocKey: '200' + id: aws.ec2_api.spot_placement_scores + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/spot_placement_scores/methods/spot_placement_scores_Get' + update: [] + title: spot_placement_scores + spot_price_history: + name: spot_price_history + methods: + spot_price_history_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSpotPriceHistory&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/spotPriceHistorySet/item + openAPIDocKey: '200' + id: aws.ec2_api.spot_price_history + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/spot_price_history/methods/spot_price_history_Describe' + update: [] + title: spot_price_history + stale_security_groups: + name: stale_security_groups + methods: + stale_security_groups_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeStaleSecurityGroups&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/staleSecurityGroupSet/item + openAPIDocKey: '200' + id: aws.ec2_api.stale_security_groups + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/stale_security_groups/methods/stale_security_groups_Describe' + update: [] + title: stale_security_groups + store_image_tasks: + name: store_image_tasks + methods: + store_image_task_Create: + operation: + $ref: '#/paths/~1?Action=CreateStoreImageTask&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + store_image_tasks_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeStoreImageTasks&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/storeImageTaskResultSet/item + openAPIDocKey: '200' + id: aws.ec2_api.store_image_tasks + sqlVerbs: + delete: [] + insert: + - $ref: '#/components/x-stackQL-resources/store_image_tasks/methods/store_image_task_Create' + select: + - $ref: '#/components/x-stackQL-resources/store_image_tasks/methods/store_image_tasks_Describe' + update: [] + title: store_image_tasks + subnet_attribute: + name: subnet_attribute + methods: + subnet_attribute_Modify: + operation: + $ref: '#/paths/~1?Action=ModifySubnetAttribute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.subnet_attribute + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: subnet_attribute + subnet_cidr_block: + name: subnet_cidr_block + methods: + subnet_cidr_block_Associate: + operation: + $ref: '#/paths/~1?Action=AssociateSubnetCidrBlock&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + subnet_cidr_block_Disassociate: + operation: + $ref: '#/paths/~1?Action=DisassociateSubnetCidrBlock&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.subnet_cidr_block + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: subnet_cidr_block + subnet_cidr_reservations: + name: subnet_cidr_reservations + methods: + subnet_cidr_reservation_Create: + operation: + $ref: '#/paths/~1?Action=CreateSubnetCidrReservation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + subnet_cidr_reservation_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteSubnetCidrReservation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + subnet_cidr_reservations_Get: + operation: + $ref: '#/paths/~1?Action=GetSubnetCidrReservations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.subnet_cidr_reservations + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/subnet_cidr_reservations/methods/subnet_cidr_reservation_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/subnet_cidr_reservations/methods/subnet_cidr_reservation_Create' + select: + - $ref: '#/components/x-stackQL-resources/subnet_cidr_reservations/methods/subnet_cidr_reservations_Get' + update: [] + title: subnet_cidr_reservations + subnets: + name: subnets + methods: + subnet_Create: + operation: + $ref: '#/paths/~1?Action=CreateSubnet&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + subnet_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteSubnet&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + subnets_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeSubnets&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/subnetSet/item + openAPIDocKey: '200' + id: aws.ec2_api.subnets + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/subnets/methods/subnet_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/subnets/methods/subnet_Create' + select: + - $ref: '#/components/x-stackQL-resources/subnets/methods/subnets_Describe' + update: [] + title: subnets + tags: + name: tags + methods: + tags_Create: + operation: + $ref: '#/paths/~1?Action=CreateTags&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + tags_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTags&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + tags_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTags&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/tagSet/item + openAPIDocKey: '200' + id: aws.ec2_api.tags + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/tags/methods/tags_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/tags/methods/tags_Create' + select: + - $ref: '#/components/x-stackQL-resources/tags/methods/tags_Describe' + update: [] + title: tags + traffic_mirror_filter_network_services: + name: traffic_mirror_filter_network_services + methods: + traffic_mirror_filter_network_services_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyTrafficMirrorFilterNetworkServices&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.traffic_mirror_filter_network_services + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: traffic_mirror_filter_network_services + traffic_mirror_filter_rule: + name: traffic_mirror_filter_rule + methods: + traffic_mirror_filter_rule_Create: + operation: + $ref: '#/paths/~1?Action=CreateTrafficMirrorFilterRule&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + traffic_mirror_filter_rule_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTrafficMirrorFilterRule&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + traffic_mirror_filter_rule_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyTrafficMirrorFilterRule&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.traffic_mirror_filter_rule + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_filter_rule/methods/traffic_mirror_filter_rule_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_filter_rule/methods/traffic_mirror_filter_rule_Create' + select: [] + update: [] + title: traffic_mirror_filter_rule + traffic_mirror_filters: + name: traffic_mirror_filters + methods: + traffic_mirror_filter_Create: + operation: + $ref: '#/paths/~1?Action=CreateTrafficMirrorFilter&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + traffic_mirror_filter_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTrafficMirrorFilter&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + traffic_mirror_filters_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTrafficMirrorFilters&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/trafficMirrorFilterSet/item + openAPIDocKey: '200' + id: aws.ec2_api.traffic_mirror_filters + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_filters/methods/traffic_mirror_filter_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_filters/methods/traffic_mirror_filter_Create' + select: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_filters/methods/traffic_mirror_filters_Describe' + update: [] + title: traffic_mirror_filters + traffic_mirror_sessions: + name: traffic_mirror_sessions + methods: + traffic_mirror_session_Create: + operation: + $ref: '#/paths/~1?Action=CreateTrafficMirrorSession&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + traffic_mirror_session_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTrafficMirrorSession&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + traffic_mirror_session_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyTrafficMirrorSession&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + traffic_mirror_sessions_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTrafficMirrorSessions&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/trafficMirrorSessionSet/item + openAPIDocKey: '200' + id: aws.ec2_api.traffic_mirror_sessions + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_sessions/methods/traffic_mirror_session_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_sessions/methods/traffic_mirror_session_Create' + select: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_sessions/methods/traffic_mirror_sessions_Describe' + update: [] + title: traffic_mirror_sessions + traffic_mirror_targets: + name: traffic_mirror_targets + methods: + traffic_mirror_target_Create: + operation: + $ref: '#/paths/~1?Action=CreateTrafficMirrorTarget&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + traffic_mirror_target_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTrafficMirrorTarget&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + traffic_mirror_targets_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTrafficMirrorTargets&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/trafficMirrorTargetSet/item + openAPIDocKey: '200' + id: aws.ec2_api.traffic_mirror_targets + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_targets/methods/traffic_mirror_target_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_targets/methods/traffic_mirror_target_Create' + select: + - $ref: '#/components/x-stackQL-resources/traffic_mirror_targets/methods/traffic_mirror_targets_Describe' + update: [] + title: traffic_mirror_targets + transit_gateway_attachment_propagations: + name: transit_gateway_attachment_propagations + methods: + transit_gateway_attachment_propagations_Get: + operation: + $ref: '#/paths/~1?Action=GetTransitGatewayAttachmentPropagations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/transitGatewayAttachmentPropagations/item + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_attachment_propagations + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/transit_gateway_attachment_propagations/methods/transit_gateway_attachment_propagations_Get' + update: [] + title: transit_gateway_attachment_propagations + transit_gateway_attachments: + name: transit_gateway_attachments + methods: + transit_gateway_attachments_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTransitGatewayAttachments&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/transitGatewayAttachments/item + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_attachments + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/transit_gateway_attachments/methods/transit_gateway_attachments_Describe' + update: [] + title: transit_gateway_attachments + transit_gateway_connect_peers: + name: transit_gateway_connect_peers + methods: + transit_gateway_connect_peer_Create: + operation: + $ref: '#/paths/~1?Action=CreateTransitGatewayConnectPeer&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_connect_peer_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTransitGatewayConnectPeer&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_connect_peers_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTransitGatewayConnectPeers&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/transitGatewayConnectPeerSet/item + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_connect_peers + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connect_peers/methods/transit_gateway_connect_peer_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connect_peers/methods/transit_gateway_connect_peer_Create' + select: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connect_peers/methods/transit_gateway_connect_peers_Describe' + update: [] + title: transit_gateway_connect_peers + transit_gateway_connects: + name: transit_gateway_connects + methods: + transit_gateway_connect_Create: + operation: + $ref: '#/paths/~1?Action=CreateTransitGatewayConnect&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_connect_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTransitGatewayConnect&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_connects_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTransitGatewayConnects&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/transitGatewayConnectSet/item + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_connects + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/transit_gateway_connect_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/transit_gateway_connect_Create' + select: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/transit_gateway_connects_Describe' + update: [] + title: transit_gateway_connects + transit_gateway_multicast_domain_associations: + name: transit_gateway_multicast_domain_associations + methods: + transit_gateway_multicast_domain_associations_Accept: + operation: + $ref: '#/paths/~1?Action=AcceptTransitGatewayMulticastDomainAssociations&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_multicast_domain_associations_Get: + operation: + $ref: '#/paths/~1?Action=GetTransitGatewayMulticastDomainAssociations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/multicastDomainAssociations/item + openAPIDocKey: '200' + transit_gateway_multicast_domain_associations_Reject: + operation: + $ref: '#/paths/~1?Action=RejectTransitGatewayMulticastDomainAssociations&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_multicast_domain_associations + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domain_associations/methods/transit_gateway_multicast_domain_associations_Get' + update: [] + title: transit_gateway_multicast_domain_associations + transit_gateway_multicast_domains: + name: transit_gateway_multicast_domains + methods: + transit_gateway_multicast_domain_Associate: + operation: + $ref: '#/paths/~1?Action=AssociateTransitGatewayMulticastDomain&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_multicast_domain_Create: + operation: + $ref: '#/paths/~1?Action=CreateTransitGatewayMulticastDomain&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_multicast_domain_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTransitGatewayMulticastDomain&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_multicast_domain_Disassociate: + operation: + $ref: '#/paths/~1?Action=DisassociateTransitGatewayMulticastDomain&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_multicast_domains_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTransitGatewayMulticastDomains&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/transitGatewayMulticastDomains/item + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_multicast_domains + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/transit_gateway_multicast_domain_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/transit_gateway_multicast_domain_Create' + select: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/transit_gateway_multicast_domains_Describe' + update: [] + title: transit_gateway_multicast_domains + transit_gateway_multicast_group_members: + name: transit_gateway_multicast_group_members + methods: + transit_gateway_multicast_group_members_Deregister: + operation: + $ref: '#/paths/~1?Action=DeregisterTransitGatewayMulticastGroupMembers&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_multicast_group_members_Register: + operation: + $ref: '#/paths/~1?Action=RegisterTransitGatewayMulticastGroupMembers&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_multicast_group_members + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: transit_gateway_multicast_group_members + transit_gateway_multicast_group_sources: + name: transit_gateway_multicast_group_sources + methods: + transit_gateway_multicast_group_sources_Deregister: + operation: + $ref: '#/paths/~1?Action=DeregisterTransitGatewayMulticastGroupSources&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_multicast_group_sources_Register: + operation: + $ref: '#/paths/~1?Action=RegisterTransitGatewayMulticastGroupSources&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_multicast_group_sources + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: transit_gateway_multicast_group_sources + transit_gateway_multicast_groups: + name: transit_gateway_multicast_groups + methods: + transit_gateway_multicast_groups_Search: + operation: + $ref: '#/paths/~1?Action=SearchTransitGatewayMulticastGroups&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_multicast_groups + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: transit_gateway_multicast_groups + transit_gateway_peering_attachments: + name: transit_gateway_peering_attachments + methods: + transit_gateway_peering_attachment_Accept: + operation: + $ref: '#/paths/~1?Action=AcceptTransitGatewayPeeringAttachment&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_peering_attachment_Create: + operation: + $ref: '#/paths/~1?Action=CreateTransitGatewayPeeringAttachment&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_peering_attachment_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTransitGatewayPeeringAttachment&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_peering_attachment_Reject: + operation: + $ref: '#/paths/~1?Action=RejectTransitGatewayPeeringAttachment&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_peering_attachments_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTransitGatewayPeeringAttachments&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/transitGatewayPeeringAttachments/item + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_peering_attachments + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/transit_gateway_peering_attachment_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/transit_gateway_peering_attachment_Create' + select: + - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/transit_gateway_peering_attachments_Describe' + update: [] + title: transit_gateway_peering_attachments + transit_gateway_prefix_list_references: + name: transit_gateway_prefix_list_references + methods: + transit_gateway_prefix_list_reference_Create: + operation: + $ref: '#/paths/~1?Action=CreateTransitGatewayPrefixListReference&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_prefix_list_reference_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTransitGatewayPrefixListReference&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_prefix_list_reference_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyTransitGatewayPrefixListReference&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_prefix_list_references_Get: + operation: + $ref: '#/paths/~1?Action=GetTransitGatewayPrefixListReferences&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/transitGatewayPrefixListReferenceSet/item + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_prefix_list_references + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_prefix_list_references/methods/transit_gateway_prefix_list_reference_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_prefix_list_references/methods/transit_gateway_prefix_list_reference_Create' + select: + - $ref: '#/components/x-stackQL-resources/transit_gateway_prefix_list_references/methods/transit_gateway_prefix_list_references_Get' + update: [] + title: transit_gateway_prefix_list_references + transit_gateway_route_table_associations: + name: transit_gateway_route_table_associations + methods: + transit_gateway_route_table_associations_Get: + operation: + $ref: '#/paths/~1?Action=GetTransitGatewayRouteTableAssociations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/associations/item + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_route_table_associations + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_associations/methods/transit_gateway_route_table_associations_Get' + update: [] + title: transit_gateway_route_table_associations + transit_gateway_route_table_propagations: + name: transit_gateway_route_table_propagations + methods: + transit_gateway_route_table_propagation_Disable: + operation: + $ref: '#/paths/~1?Action=DisableTransitGatewayRouteTablePropagation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_route_table_propagation_Enable: + operation: + $ref: '#/paths/~1?Action=EnableTransitGatewayRouteTablePropagation&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_route_table_propagations_Get: + operation: + $ref: '#/paths/~1?Action=GetTransitGatewayRouteTablePropagations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/transitGatewayRouteTablePropagations/item + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_route_table_propagations + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_propagations/methods/transit_gateway_route_table_propagations_Get' + update: [] + title: transit_gateway_route_table_propagations + transit_gateway_route_tables: + name: transit_gateway_route_tables + methods: + transit_gateway_route_table_Associate: + operation: + $ref: '#/paths/~1?Action=AssociateTransitGatewayRouteTable&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_route_table_Create: + operation: + $ref: '#/paths/~1?Action=CreateTransitGatewayRouteTable&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_route_table_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTransitGatewayRouteTable&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_route_table_Disassociate: + operation: + $ref: '#/paths/~1?Action=DisassociateTransitGatewayRouteTable&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_route_tables_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTransitGatewayRouteTables&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/transitGatewayRouteTables/item + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_route_tables + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/transit_gateway_route_table_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/transit_gateway_route_table_Create' + select: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/transit_gateway_route_tables_Describe' + update: [] + title: transit_gateway_route_tables + transit_gateway_routes: + name: transit_gateway_routes + methods: + transit_gateway_route_Create: + operation: + $ref: '#/paths/~1?Action=CreateTransitGatewayRoute&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_route_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTransitGatewayRoute&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_route_Replace: + operation: + $ref: '#/paths/~1?Action=ReplaceTransitGatewayRoute&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_routes_Export: + operation: + $ref: '#/paths/~1?Action=ExportTransitGatewayRoutes&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_routes_Search: + operation: + $ref: '#/paths/~1?Action=SearchTransitGatewayRoutes&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_routes + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_routes/methods/transit_gateway_route_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_routes/methods/transit_gateway_route_Create' + select: [] + update: [] + title: transit_gateway_routes + transit_gateway_vpc_attachments: + name: transit_gateway_vpc_attachments + methods: + transit_gateway_vpc_attachment_Accept: + operation: + $ref: '#/paths/~1?Action=AcceptTransitGatewayVpcAttachment&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_vpc_attachment_Create: + operation: + $ref: '#/paths/~1?Action=CreateTransitGatewayVpcAttachment&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_vpc_attachment_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTransitGatewayVpcAttachment&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_vpc_attachment_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyTransitGatewayVpcAttachment&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_vpc_attachment_Reject: + operation: + $ref: '#/paths/~1?Action=RejectTransitGatewayVpcAttachment&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_vpc_attachments_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTransitGatewayVpcAttachments&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/transitGatewayVpcAttachments/item + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateway_vpc_attachments + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/transit_gateway_vpc_attachment_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/transit_gateway_vpc_attachment_Create' + select: + - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/transit_gateway_vpc_attachments_Describe' + update: [] + title: transit_gateway_vpc_attachments + transit_gateways: + name: transit_gateways + methods: + transit_gateway_Create: + operation: + $ref: '#/paths/~1?Action=CreateTransitGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteTransitGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateway_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyTransitGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + transit_gateways_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTransitGateways&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/transitGatewaySet/item + openAPIDocKey: '200' + id: aws.ec2_api.transit_gateways + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/transit_gateway_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/transit_gateway_Create' + select: + - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/transit_gateways_Describe' + update: [] + title: transit_gateways + trunk_interface: + name: trunk_interface + methods: + trunk_interface_Associate: + operation: + $ref: '#/paths/~1?Action=AssociateTrunkInterface&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + trunk_interface_Disassociate: + operation: + $ref: '#/paths/~1?Action=DisassociateTrunkInterface&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.trunk_interface + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: trunk_interface + trunk_interface_associations: + name: trunk_interface_associations + methods: + trunk_interface_associations_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeTrunkInterfaceAssociations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/interfaceAssociationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.trunk_interface_associations + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/trunk_interface_associations/methods/trunk_interface_associations_Describe' + update: [] + title: trunk_interface_associations + vgw_route_propagation: + name: vgw_route_propagation + methods: + vgw_route_propagation_Disable: + operation: + $ref: '#/paths/~1?Action=DisableVgwRoutePropagation&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + vgw_route_propagation_Enable: + operation: + $ref: '#/paths/~1?Action=EnableVgwRoutePropagation&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.vgw_route_propagation + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: vgw_route_propagation + volume_attribute: + name: volume_attribute + methods: + volume_attribute_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVolumeAttribute&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + volume_attribute_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVolumeAttribute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.volume_attribute + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/volume_attribute/methods/volume_attribute_Describe' + update: [] + title: volume_attribute + volume_i_o: + name: volume_i_o + methods: + volume_i_o_Enable: + operation: + $ref: '#/paths/~1?Action=EnableVolumeIO&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.volume_i_o + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: volume_i_o + volume_status: + name: volume_status + methods: + volume_status_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVolumeStatus&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/volumeStatusSet/item + openAPIDocKey: '200' + id: aws.ec2_api.volume_status + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/volume_status/methods/volume_status_Describe' + update: [] + title: volume_status + volumes: + name: volumes + methods: + volume_Attach: + operation: + $ref: '#/paths/~1?Action=AttachVolume&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + volume_Create: + operation: + $ref: '#/paths/~1?Action=CreateVolume&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + volume_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteVolume&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + volume_Detach: + operation: + $ref: '#/paths/~1?Action=DetachVolume&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + volume_Import: + operation: + $ref: '#/paths/~1?Action=ImportVolume&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + volume_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVolume&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + volumes_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVolumes&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/volumeSet/item + openAPIDocKey: '200' + id: aws.ec2_api.volumes + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/volumes/methods/volume_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/volumes/methods/volume_Create' + select: + - $ref: '#/components/x-stackQL-resources/volumes/methods/volumes_Describe' + update: + - $ref: '#/components/x-stackQL-resources/volumes/methods/volume_Modify' + title: volumes + volumes_modifications: + name: volumes_modifications + methods: + volumes_modifications_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVolumesModifications&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/volumeModificationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.volumes_modifications + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/volumes_modifications/methods/volumes_modifications_Describe' + update: [] + title: volumes_modifications + vpc_attribute: + name: vpc_attribute + methods: + vpc_attribute_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpcAttribute&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + vpc_attribute_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVpcAttribute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.vpc_attribute + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/vpc_attribute/methods/vpc_attribute_Describe' + update: [] + title: vpc_attribute + vpc_cidr_block: + name: vpc_cidr_block + methods: + vpc_cidr_block_Associate: + operation: + $ref: '#/paths/~1?Action=AssociateVpcCidrBlock&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_cidr_block_Disassociate: + operation: + $ref: '#/paths/~1?Action=DisassociateVpcCidrBlock&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.vpc_cidr_block + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: vpc_cidr_block + vpc_classic_link: + name: vpc_classic_link + methods: + vpc_classic_link_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpcClassicLink&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/vpcSet/item + openAPIDocKey: '200' + vpc_classic_link_Disable: + operation: + $ref: '#/paths/~1?Action=DisableVpcClassicLink&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_classic_link_Enable: + operation: + $ref: '#/paths/~1?Action=EnableVpcClassicLink&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.vpc_classic_link + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/vpc_classic_link/methods/vpc_classic_link_Describe' + update: [] + title: vpc_classic_link + vpc_classic_link_dns_support: + name: vpc_classic_link_dns_support + methods: + vpc_classic_link_dns_support_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpcClassicLinkDnsSupport&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/vpcs/item + openAPIDocKey: '200' + vpc_classic_link_dns_support_Disable: + operation: + $ref: '#/paths/~1?Action=DisableVpcClassicLinkDnsSupport&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_classic_link_dns_support_Enable: + operation: + $ref: '#/paths/~1?Action=EnableVpcClassicLinkDnsSupport&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.vpc_classic_link_dns_support + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/vpc_classic_link_dns_support/methods/vpc_classic_link_dns_support_Describe' + update: [] + title: vpc_classic_link_dns_support + vpc_endpoint_connection_notifications: + name: vpc_endpoint_connection_notifications + methods: + vpc_endpoint_connection_notification_Create: + operation: + $ref: '#/paths/~1?Action=CreateVpcEndpointConnectionNotification&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_endpoint_connection_notification_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVpcEndpointConnectionNotification&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_endpoint_connection_notifications_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteVpcEndpointConnectionNotifications&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_endpoint_connection_notifications_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpcEndpointConnectionNotifications&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/connectionNotificationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.vpc_endpoint_connection_notifications + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/vpc_endpoint_connection_notifications_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/vpc_endpoint_connection_notification_Create' + select: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/vpc_endpoint_connection_notifications_Describe' + update: [] + title: vpc_endpoint_connection_notifications + vpc_endpoint_connections: + name: vpc_endpoint_connections + methods: + vpc_endpoint_connections_Accept: + operation: + $ref: '#/paths/~1?Action=AcceptVpcEndpointConnections&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_endpoint_connections_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpcEndpointConnections&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/vpcEndpointConnectionSet/item + openAPIDocKey: '200' + vpc_endpoint_connections_Reject: + operation: + $ref: '#/paths/~1?Action=RejectVpcEndpointConnections&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.vpc_endpoint_connections + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connections/methods/vpc_endpoint_connections_Describe' + update: [] + title: vpc_endpoint_connections + vpc_endpoint_service_configurations: + name: vpc_endpoint_service_configurations + methods: + vpc_endpoint_service_configuration_Create: + operation: + $ref: '#/paths/~1?Action=CreateVpcEndpointServiceConfiguration&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_endpoint_service_configuration_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVpcEndpointServiceConfiguration&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_endpoint_service_configurations_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteVpcEndpointServiceConfigurations&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_endpoint_service_configurations_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpcEndpointServiceConfigurations&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/serviceConfigurationSet/item + openAPIDocKey: '200' + id: aws.ec2_api.vpc_endpoint_service_configurations + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_configurations/methods/vpc_endpoint_service_configurations_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_configurations/methods/vpc_endpoint_service_configuration_Create' + select: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_configurations/methods/vpc_endpoint_service_configurations_Describe' + update: [] + title: vpc_endpoint_service_configurations + vpc_endpoint_service_payer_responsibility: + name: vpc_endpoint_service_payer_responsibility + methods: + vpc_endpoint_service_payer_responsibility_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVpcEndpointServicePayerResponsibility&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.vpc_endpoint_service_payer_responsibility + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: vpc_endpoint_service_payer_responsibility + vpc_endpoint_service_permissions: + name: vpc_endpoint_service_permissions + methods: + vpc_endpoint_service_permissions_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpcEndpointServicePermissions&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/allowedPrincipals/item + openAPIDocKey: '200' + vpc_endpoint_service_permissions_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVpcEndpointServicePermissions&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.vpc_endpoint_service_permissions + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_permissions/methods/vpc_endpoint_service_permissions_Describe' + update: [] + title: vpc_endpoint_service_permissions + vpc_endpoint_service_private_dns_verification: + name: vpc_endpoint_service_private_dns_verification + methods: + vpc_endpoint_service_private_dns_verification_Start: + operation: + $ref: '#/paths/~1?Action=StartVpcEndpointServicePrivateDnsVerification&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.vpc_endpoint_service_private_dns_verification + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: vpc_endpoint_service_private_dns_verification + vpc_endpoint_services: + name: vpc_endpoint_services + methods: + vpc_endpoint_services_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpcEndpointServices&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/serviceDetailSet/item + openAPIDocKey: '200' + id: aws.ec2_api.vpc_endpoint_services + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_services/methods/vpc_endpoint_services_Describe' + update: [] + title: vpc_endpoint_services + vpc_endpoints: + name: vpc_endpoints + methods: + vpc_endpoint_Create: + operation: + $ref: '#/paths/~1?Action=CreateVpcEndpoint&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_endpoint_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVpcEndpoint&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_endpoints_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteVpcEndpoints&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_endpoints_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpcEndpoints&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/vpcEndpointSet/item + openAPIDocKey: '200' + id: aws.ec2_api.vpc_endpoints + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/vpc_endpoints_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/vpc_endpoint_Create' + select: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/vpc_endpoints_Describe' + update: [] + title: vpc_endpoints + vpc_peering_connection_options: + name: vpc_peering_connection_options + methods: + vpc_peering_connection_options_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVpcPeeringConnectionOptions&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.vpc_peering_connection_options + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: vpc_peering_connection_options + vpc_peering_connections: + name: vpc_peering_connections + methods: + vpc_peering_connection_Accept: + operation: + $ref: '#/paths/~1?Action=AcceptVpcPeeringConnection&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_peering_connection_Create: + operation: + $ref: '#/paths/~1?Action=CreateVpcPeeringConnection&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_peering_connection_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteVpcPeeringConnection&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_peering_connection_Reject: + operation: + $ref: '#/paths/~1?Action=RejectVpcPeeringConnection&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_peering_connections_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpcPeeringConnections&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/vpcPeeringConnectionSet/item + openAPIDocKey: '200' + id: aws.ec2_api.vpc_peering_connections + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/vpc_peering_connection_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/vpc_peering_connection_Create' + select: + - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/vpc_peering_connections_Describe' + update: [] + title: vpc_peering_connections + vpc_tenancy: + name: vpc_tenancy + methods: + vpc_tenancy_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVpcTenancy&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.vpc_tenancy + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: vpc_tenancy + vpcs: + name: vpcs + methods: + vpc_Create: + operation: + $ref: '#/paths/~1?Action=CreateVpc&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpc_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteVpc&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + vpcs_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpcs&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/vpcSet/item + openAPIDocKey: '200' + id: aws.ec2_api.vpcs + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/vpcs/methods/vpc_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/vpcs/methods/vpc_Create' + select: + - $ref: '#/components/x-stackQL-resources/vpcs/methods/vpcs_Describe' + update: [] + title: vpcs + vpn_connection_device_sample_configuration: + name: vpn_connection_device_sample_configuration + methods: + vpn_connection_device_sample_configuration_Get: + operation: + $ref: '#/paths/~1?Action=GetVpnConnectionDeviceSampleConfiguration&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /* + openAPIDocKey: '200' + id: aws.ec2_api.vpn_connection_device_sample_configuration + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/vpn_connection_device_sample_configuration/methods/vpn_connection_device_sample_configuration_Get' + update: [] + title: vpn_connection_device_sample_configuration + vpn_connection_device_types: + name: vpn_connection_device_types + methods: + vpn_connection_device_types_Get: + operation: + $ref: '#/paths/~1?Action=GetVpnConnectionDeviceTypes&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/vpnConnectionDeviceTypeSet/item + openAPIDocKey: '200' + id: aws.ec2_api.vpn_connection_device_types + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/vpn_connection_device_types/methods/vpn_connection_device_types_Get' + update: [] + title: vpn_connection_device_types + vpn_connection_options: + name: vpn_connection_options + methods: + vpn_connection_options_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVpnConnectionOptions&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.vpn_connection_options + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: vpn_connection_options + vpn_connection_route: + name: vpn_connection_route + methods: + vpn_connection_route_Create: + operation: + $ref: '#/paths/~1?Action=CreateVpnConnectionRoute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + vpn_connection_route_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteVpnConnectionRoute&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + id: aws.ec2_api.vpn_connection_route + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/vpn_connection_route/methods/vpn_connection_route_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/vpn_connection_route/methods/vpn_connection_route_Create' + select: [] + update: [] + title: vpn_connection_route + vpn_connections: + name: vpn_connections + methods: + vpn_connection_Create: + operation: + $ref: '#/paths/~1?Action=CreateVpnConnection&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpn_connection_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteVpnConnection&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + vpn_connection_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVpnConnection&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpn_connections_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpnConnections&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/vpnConnectionSet/item + openAPIDocKey: '200' + id: aws.ec2_api.vpn_connections + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/vpn_connection_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/vpn_connection_Create' + select: + - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/vpn_connections_Describe' + update: [] + title: vpn_connections + vpn_gateways: + name: vpn_gateways + methods: + vpn_gateway_Attach: + operation: + $ref: '#/paths/~1?Action=AttachVpnGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpn_gateway_Create: + operation: + $ref: '#/paths/~1?Action=CreateVpnGateway&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + vpn_gateway_Delete: + operation: + $ref: '#/paths/~1?Action=DeleteVpnGateway&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + vpn_gateway_Detach: + operation: + $ref: '#/paths/~1?Action=DetachVpnGateway&Version=2016-11-15/get' + response: + openAPIDocKey: '200' + vpn_gateways_Describe: + operation: + $ref: '#/paths/~1?Action=DescribeVpnGateways&Version=2016-11-15/get' + response: + mediaType: text/xml + objectKey: /*/vpnGatewaySet/item + openAPIDocKey: '200' + id: aws.ec2_api.vpn_gateways + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/vpn_gateway_Delete' + insert: + - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/vpn_gateway_Create' + select: + - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/vpn_gateways_Describe' + update: [] + title: vpn_gateways + vpn_tunnel_certificate: + name: vpn_tunnel_certificate + methods: + vpn_tunnel_certificate_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVpnTunnelCertificate&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.vpn_tunnel_certificate + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: vpn_tunnel_certificate + vpn_tunnel_options: + name: vpn_tunnel_options + methods: + vpn_tunnel_options_Modify: + operation: + $ref: '#/paths/~1?Action=ModifyVpnTunnelOptions&Version=2016-11-15/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + id: aws.ec2_api.vpn_tunnel_options + sqlVerbs: + delete: [] + insert: [] + select: [] + update: [] + title: vpn_tunnel_options + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + 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-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + schemas: + AcceptReservedInstancesExchangeQuoteResult: + type: object + properties: + exchangeId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the successful exchange. + description: The result of the exchange and whether it wassuccessful.
+ ReservationId:
+ type: string
+ TargetConfigurationRequest:
+ type: object
+ required:
+ - OfferingId
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesOfferingId'
+ - description: The Convertible Reserved Instance offering ID.
+ description: Details about the target configuration.
+ AcceptTransitGatewayMulticastDomainAssociationsResult:
+ type: object
+ properties:
+ associations:
+ $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
+ String:
+ type: string
+ AcceptTransitGatewayPeeringAttachmentResult:
+ type: object
+ properties:
+ transitGatewayPeeringAttachment:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
+ - description: The transit gateway peering attachment.
+ AcceptTransitGatewayVpcAttachmentResult:
+ type: object
+ properties:
+ transitGatewayVpcAttachment:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayVpcAttachment'
+ - description: The VPC attachment.
+ AcceptVpcEndpointConnectionsResult:
+ type: object
+ properties:
+ unsuccessful:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulItemSet'
+ - description: 'Information about the interface endpoints that were not accepted, if applicable.'
+ VpcEndpointId:
+ type: string
+ AcceptVpcPeeringConnectionResult:
+ type: object
+ properties:
+ vpcPeeringConnection:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnection'
+ - description: Information about the VPC peering connection.
+ AdvertiseByoipCidrResult:
+ type: object
+ properties:
+ byoipCidr:
+ allOf:
+ - $ref: '#/components/schemas/ByoipCidr'
+ - description: Information about the address range.
+ AllocateAddressResult:
+ type: object
+ example:
+ Domain: standard
+ PublicIp: 198.51.100.0
+ properties:
+ publicIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Elastic IP address.
+ allocationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: '[EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.'
+ publicIpv4Pool:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of an address pool.
+ networkBorderGroup:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.'
+ domain:
+ allOf:
+ - $ref: '#/components/schemas/DomainType'
+ - description: Indicates whether the Elastic IP address is for use with instances in a VPC (vpc) or instances in EC2-Classic (standard).
+ customerOwnedIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The customer-owned IP address.
+ customerOwnedIpv4Pool:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the customer-owned address pool.
+ carrierIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The carrier IP address. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). '
+ TagSpecification:
+ type: object
+ properties:
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/ResourceType'
+ - description: The type of resource to tag on creation.
+ Tag:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags to apply to the resource.
+ description: The tags to apply to a resource when the resource is being created.
+ AllocateHostsResult:
+ type: object
+ properties:
+ hostIdSet:
+ allOf:
+ - $ref: '#/components/schemas/ResponseHostIdList'
+ - description: The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.
+ description: Contains the output of AllocateHosts.
+ AllocateIpamPoolCidrResult:
+ type: object
+ properties:
+ ipamPoolAllocation:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolAllocation'
+ - description: Information about the allocation created.
+ ApplySecurityGroupsToClientVpnTargetNetworkResult:
+ type: object
+ properties:
+ securityGroupIds:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnSecurityGroupIdSet'
+ - description: The IDs of the applied security groups.
+ SecurityGroupId:
+ type: string
+ AssignIpv6AddressesResult:
+ type: object
+ properties:
+ assignedIpv6Addresses:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6AddressList'
+ - description: The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses that were assigned to the network interface before the request are not included.
+ assignedIpv6PrefixSet:
+ allOf:
+ - $ref: '#/components/schemas/IpPrefixList'
+ - description: The IPv6 prefixes that are assigned to the network interface.
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network interface.
+ AssignPrivateIpAddressesResult:
+ type: object
+ properties:
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network interface.
+ assignedPrivateIpAddressesSet:
+ allOf:
+ - $ref: '#/components/schemas/AssignedPrivateIpAddressList'
+ - description: The private IP addresses assigned to the network interface.
+ assignedIpv4PrefixSet:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PrefixesList'
+ - description: The IPv4 prefixes that are assigned to the network interface.
+ AssociateAddressResult:
+ type: object
+ example:
+ AssociationId: eipassoc-2bebb745
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: '[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.'
+ AssociateClientVpnTargetNetworkResult:
+ type: object
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The unique ID of the target network association.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/AssociationStatus'
+ - description: The current state of the target network association.
+ AssociateEnclaveCertificateIamRoleResult:
+ type: object
+ properties:
+ certificateS3BucketName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the Amazon S3 bucket to which the certificate was uploaded.
+ certificateS3ObjectKey:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The object key is formatted as follows: role_arn/certificate_arn.'
+ encryptionKmsKeyId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the KMS key used to encrypt the private key of the certificate.
+ AssociateIamInstanceProfileResult:
+ type: object
+ example:
+ IamInstanceProfileAssociation:
+ AssociationId: iip-assoc-0e7736511a163c209
+ IamInstanceProfile:
+ Arn: 'arn:aws:iam::123456789012:instance-profile/admin-role'
+ Id: AIPAJBLK7RKJKWDXVHIEC
+ InstanceId: i-123456789abcde123
+ State: associating
+ properties:
+ iamInstanceProfileAssociation:
+ allOf:
+ - $ref: '#/components/schemas/IamInstanceProfileAssociation'
+ - description: Information about the IAM instance profile association.
+ AssociateInstanceEventWindowResult:
+ type: object
+ properties:
+ instanceEventWindow:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindow'
+ - description: Information about the event window.
+ InstanceIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - xml:
+ name: item
+ TagList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Tag'
+ - xml:
+ name: item
+ DedicatedHostIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DedicatedHostId'
+ - xml:
+ name: item
+ AssociateRouteTableResult:
+ type: object
+ example:
+ AssociationId: rtbassoc-781d0d1a
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The route table association ID. This ID is required for disassociating the route table.
+ associationState:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableAssociationState'
+ - description: The state of the association.
+ AssociateSubnetCidrBlockResult:
+ type: object
+ properties:
+ ipv6CidrBlockAssociation:
+ allOf:
+ - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation'
+ - description: Information about the IPv6 association.
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the subnet.
+ AssociateTransitGatewayMulticastDomainResult:
+ type: object
+ properties:
+ associations:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
+ - description: Information about the transit gateway multicast domain associations.
+ SubnetId:
+ type: string
+ AssociateTransitGatewayRouteTableResult:
+ type: object
+ properties:
+ association:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAssociation'
+ - description: The ID of the association.
+ AssociateTrunkInterfaceResult:
+ type: object
+ properties:
+ interfaceAssociation:
+ allOf:
+ - $ref: '#/components/schemas/TrunkInterfaceAssociation'
+ - description: Information about the association between the trunk network interface and branch network interface.
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.'
+ AssociateVpcCidrBlockResult:
+ type: object
+ properties:
+ ipv6CidrBlockAssociation:
+ allOf:
+ - $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation'
+ - description: Information about the IPv6 CIDR block association.
+ cidrBlockAssociation:
+ allOf:
+ - $ref: '#/components/schemas/VpcCidrBlockAssociation'
+ - description: Information about the IPv4 CIDR block association.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ AttachClassicLinkVpcResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ AttachNetworkInterfaceResult:
+ type: object
+ example:
+ AttachmentId: eni-attach-66c4350a
+ properties:
+ attachmentId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network interface attachment.
+ networkCardIndex:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The index of the network card.
+ description: Contains the output of AttachNetworkInterface.
+ VolumeAttachment:
+ type: object
+ example:
+ AttachTime: '2014-02-27T19:23:06.000Z'
+ Device: /dev/sdb
+ InstanceId: i-1234567890abcdef0
+ State: detaching
+ VolumeId: vol-049df61146c4d7901
+ properties:
+ attachTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time stamp when the attachment initiated.
+ device:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The device name.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/VolumeAttachmentState'
+ - description: The attachment state of the volume.
+ volumeId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the volume.
+ deleteOnTermination:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the EBS volume is deleted on instance termination.
+ description: Describes volume attachment details.
+ AttachVpnGatewayResult:
+ type: object
+ properties:
+ attachment:
+ allOf:
+ - $ref: '#/components/schemas/VpcAttachment'
+ - description: Information about the attachment.
+ description: Contains the output of AttachVpnGateway.
+ AuthorizeClientVpnIngressResult:
+ type: object
+ properties:
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus'
+ - description: The current state of the authorization rule.
+ AuthorizeSecurityGroupEgressResult:
+ type: object
+ example: {}
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, returns an error.'
+ securityGroupRuleSet:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRuleList'
+ - description: Information about the outbound (egress) security group rules that were added.
+ IpPermission:
+ type: object
+ properties:
+ fromPort:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.'
+ ipProtocol:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
-1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.'
+ groups:
+ allOf:
+ - $ref: '#/components/schemas/UserIdGroupPairList'
+ - description: The security group and Amazon Web Services account ID pairs.
+ description: Describes a set of permissions for a security group rule.
+ AuthorizeSecurityGroupIngressResult:
+ type: object
+ example: {}
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, returns an error.'
+ securityGroupRuleSet:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRuleList'
+ - description: Information about the inbound (ingress) security group rules that were added.
+ BundleInstanceResult:
+ type: object
+ properties:
+ bundleInstanceTask:
+ allOf:
+ - $ref: '#/components/schemas/BundleTask'
+ - description: Information about the bundle task.
+ description: Contains the output of BundleInstance.
+ S3Storage:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing Amazon Web Services Access Keys.'
+ bucket:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.'
+ prefix:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The beginning of the file name of the AMI.
+ uploadPolicy:
+ allOf:
+ - $ref: '#/components/schemas/Blob'
+ - description: An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
+ uploadPolicySignature:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The signature of the JSON document.
+ description: Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed AMI.
+ CancelBundleTaskResult:
+ type: object
+ properties:
+ bundleInstanceTask:
+ allOf:
+ - $ref: '#/components/schemas/BundleTask'
+ - description: Information about the bundle task.
+ description: Contains the output of CancelBundleTask.
+ CancelCapacityReservationResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ CancelCapacityReservationFleetsResult:
+ type: object
+ properties:
+ successfulFleetCancellationSet:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationFleetCancellationStateSet'
+ - description: Information about the Capacity Reservation Fleets that were successfully cancelled.
+ failedFleetCancellationSet:
+ allOf:
+ - $ref: '#/components/schemas/FailedCapacityReservationFleetCancellationResultSet'
+ - description: Information about the Capacity Reservation Fleets that could not be cancelled.
+ CapacityReservationFleetId:
+ type: string
+ CancelImportTaskResult:
+ type: object
+ properties:
+ importTaskId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the task being canceled.
+ previousState:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The current state of the task being canceled.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The current state of the task being canceled.
+ CancelReservedInstancesListingResult:
+ type: object
+ properties:
+ reservedInstancesListingsSet:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesListingList'
+ - description: The Reserved Instance listing.
+ description: Contains the output of CancelReservedInstancesListing.
+ CancelSpotFleetRequestsResponse:
+ type: object
+ example:
+ SuccessfulFleetRequests:
+ - CurrentSpotFleetRequestState: cancelled_terminating
+ PreviousSpotFleetRequestState: active
+ SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
+ properties:
+ successfulFleetRequestSet:
+ allOf:
+ - $ref: '#/components/schemas/CancelSpotFleetRequestsSuccessSet'
+ - description: Information about the Spot Fleet requests that are successfully canceled.
+ unsuccessfulFleetRequestSet:
+ allOf:
+ - $ref: '#/components/schemas/CancelSpotFleetRequestsErrorSet'
+ - description: Information about the Spot Fleet requests that are not successfully canceled.
+ description: Contains the output of CancelSpotFleetRequests.
+ SpotFleetRequestId:
+ type: string
+ CancelSpotInstanceRequestsResult:
+ type: object
+ example:
+ CancelledSpotInstanceRequests:
+ - SpotInstanceRequestId: sir-08b93456
+ State: cancelled
+ properties:
+ spotInstanceRequestSet:
+ allOf:
+ - $ref: '#/components/schemas/CancelledSpotInstanceRequestList'
+ - description: One or more Spot Instance requests.
+ description: Contains the output of CancelSpotInstanceRequests.
+ SpotInstanceRequestId:
+ type: string
+ ConfirmProductInstanceResult:
+ type: object
+ example:
+ OwnerId: '123456789012'
+ properties:
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID of the instance owner. This is only present if the product code is attached to the instance.
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.
+ CopyFpgaImageResult:
+ type: object
+ properties:
+ fpgaImageId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the new AFI.
+ CopyImageResult:
+ type: object
+ example:
+ ImageId: ami-438bea42
+ properties:
+ imageId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the new AMI.
+ description: Contains the output of CopyImage.
+ CopySnapshotResult:
+ type: object
+ example:
+ SnapshotId: snap-066877671789bd71b
+ properties:
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the new snapshot.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags applied to the new snapshot.
+ CreateCapacityReservationResult:
+ type: object
+ properties:
+ capacityReservation:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservation'
+ - description: Information about the Capacity Reservation.
+ CreateCapacityReservationFleetResult:
+ type: object
+ properties:
+ capacityReservationFleetId:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationFleetId'
+ - description: The ID of the Capacity Reservation Fleet.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationFleetState'
+ - description: The status of the Capacity Reservation Fleet.
+ totalTargetCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.
+ totalFulfilledCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: The requested capacity units that have been successfully reserved.
+ instanceMatchCriteria:
+ allOf:
+ - $ref: '#/components/schemas/FleetInstanceMatchCriteria'
+ - description: The instance matching criteria for the Capacity Reservation Fleet.
+ allocationStrategy:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The allocation strategy used by the Capacity Reservation Fleet.
+ createTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The date and time at which the Capacity Reservation Fleet was created.
+ endDate:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The date and time at which the Capacity Reservation Fleet expires.
+ tenancy:
+ allOf:
+ - $ref: '#/components/schemas/FleetCapacityReservationTenancy'
+ - description: Indicates the tenancy of Capacity Reservation Fleet.
+ fleetCapacityReservationSet:
+ allOf:
+ - $ref: '#/components/schemas/FleetCapacityReservationSet'
+ - description: Information about the individual Capacity Reservations in the Capacity Reservation Fleet.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the Capacity Reservation Fleet.
+ ReservationFleetInstanceSpecification:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/IntegerWithConstraints'
+ - description: 'The priority to assign to the instance type. This value is used to determine which of the instance types specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more information, see Instance type priority in the Amazon EC2 User Guide.'
+ description: Information about an instance type to use in a Capacity Reservation Fleet.
+ CreateCarrierGatewayResult:
+ type: object
+ properties:
+ carrierGateway:
+ allOf:
+ - $ref: '#/components/schemas/CarrierGateway'
+ - description: Information about the carrier gateway.
+ CreateClientVpnEndpointResult:
+ type: object
+ properties:
+ clientVpnEndpointId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Client VPN endpoint.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnEndpointStatus'
+ - description: The current state of the Client VPN endpoint.
+ dnsName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The DNS name to be used by clients when establishing their VPN session.
+ ClientVpnAuthenticationRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/FederatedAuthenticationRequest'
+ - description: 'Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.'
+ description: 'Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.'
+ CreateClientVpnRouteResult:
+ type: object
+ properties:
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnRouteStatus'
+ - description: The current state of the route.
+ CreateCustomerGatewayResult:
+ type: object
+ example:
+ CustomerGateway:
+ BgpAsn: '65534'
+ CustomerGatewayId: cgw-0e11f167
+ IpAddress: 12.1.2.3
+ State: available
+ Type: ipsec.1
+ properties:
+ customerGateway:
+ allOf:
+ - $ref: '#/components/schemas/CustomerGateway'
+ - description: Information about the customer gateway.
+ description: Contains the output of CreateCustomerGateway.
+ CreateDefaultSubnetResult:
+ type: object
+ properties:
+ subnet:
+ allOf:
+ - $ref: '#/components/schemas/Subnet'
+ - description: Information about the subnet.
+ CreateDefaultVpcResult:
+ type: object
+ properties:
+ vpc:
+ allOf:
+ - $ref: '#/components/schemas/Vpc'
+ - description: Information about the VPC.
+ CreateDhcpOptionsResult:
+ type: object
+ example:
+ DhcpOptions:
+ DhcpConfigurations:
+ - Key: domain-name-servers
+ Values:
+ - Value: 10.2.5.2
+ - Value: 10.2.5.1
+ DhcpOptionsId: dopt-d9070ebb
+ properties:
+ dhcpOptions:
+ allOf:
+ - $ref: '#/components/schemas/DhcpOptions'
+ - description: A set of DHCP options.
+ NewDhcpConfiguration:
+ type: object
+ properties:
+ key:
+ $ref: '#/components/schemas/String'
+ Value:
+ $ref: '#/components/schemas/ValueStringList'
+ CreateEgressOnlyInternetGatewayResult:
+ type: object
+ properties:
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
+ egressOnlyInternetGateway:
+ allOf:
+ - $ref: '#/components/schemas/EgressOnlyInternetGateway'
+ - description: Information about the egress-only internet gateway.
+ CreateFleetResult:
+ type: object
+ properties:
+ fleetId:
+ allOf:
+ - $ref: '#/components/schemas/FleetId'
+ - description: The ID of the EC2 Fleet.
+ errorSet:
+ allOf:
+ - $ref: '#/components/schemas/CreateFleetErrorsSet'
+ - description: Information about the instances that could not be launched by the fleet. Supported only for fleets of type instant.
+ fleetInstanceSet:
+ allOf:
+ - $ref: '#/components/schemas/CreateFleetInstancesSet'
+ - description: Information about the instances that were launched by the fleet. Supported only for fleets of type instant.
+ FleetLaunchTemplateConfigRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/FleetLaunchTemplateOverridesListRequest'
+ - description: 'Any parameters that you specify override the same parameters in the launch template.
For fleets of type request and maintain, a maximum of 300 items is allowed across all launch templates.
/dev/sdh or xvdh).'
+ virtualName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
' + ebs: + allOf: + - $ref: '#/components/schemas/EbsBlockDevice' + - description: Parameters used to automatically set up EBS volumes when the instance is launched. + noDevice: + allOf: + - $ref: '#/components/schemas/String' + - description: 'To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.' + description: 'Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.' + CreateInstanceEventWindowResult: + type: object + properties: + instanceEventWindow: + allOf: + - $ref: '#/components/schemas/InstanceEventWindow' + - description: Information about the event window. + InstanceEventWindowTimeRangeRequest: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Hour' + - description: The hour when the time range ends. + description: 'The start day and time and the end day and time of the time range, in UTC.' + CreateInstanceExportTaskResult: + type: object + properties: + exportTask: + allOf: + - $ref: '#/components/schemas/ExportTask' + - description: Information about the export instance task. + ContainerFormat: + type: string + enum: + - ova + DiskImageFormat: + type: string + enum: + - VMDK + - RAW + - VHD + CreateInternetGatewayResult: + type: object + example: + InternetGateway: + Attachments: [] + InternetGatewayId: igw-c0a643a9 + Tags: [] + properties: + internetGateway: + allOf: + - $ref: '#/components/schemas/InternetGateway' + - description: Information about the internet gateway. + CreateIpamResult: + type: object + properties: + ipam: + allOf: + - $ref: '#/components/schemas/Ipam' + - description: Information about the IPAM created. + AddIpamOperatingRegion: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The name of the operating Region. + description: 'Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' + CreateIpamPoolResult: + type: object + properties: + ipamPool: + allOf: + - $ref: '#/components/schemas/IpamPool' + - description: Information about the IPAM pool created. + RequestIpamResourceTag: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The value for the tag. + description: A tag on an IPAM resource. + CreateIpamScopeResult: + type: object + properties: + ipamScope: + allOf: + - $ref: '#/components/schemas/IpamScope' + - description: Information about the created scope. + KeyPair: + type: object + properties: + keyFingerprint: + allOf: + - $ref: '#/components/schemas/String' + - description: 'For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.'
+ LaunchTemplateInstanceMaintenanceOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateAutoRecoveryState'
+ - description: 'Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.'
+ description: The maintenance options of your instance.
+ CreateLaunchTemplateVersionResult:
+ type: object
+ example:
+ LaunchTemplateVersion:
+ CreateTime: '2017-12-01T13:35:46.000Z'
+ CreatedBy: 'arn:aws:iam::123456789012:root'
+ DefaultVersion: false
+ LaunchTemplateData:
+ ImageId: ami-c998b6b2
+ InstanceType: t2.micro
+ NetworkInterfaces:
+ - AssociatePublicIpAddress: true
+ DeviceIndex: 0
+ Ipv6Addresses:
+ - Ipv6Address: '2001:db8:1234:1a00::123'
+ SubnetId: subnet-7b16de0c
+ LaunchTemplateId: lt-0abcd290751193123
+ LaunchTemplateName: my-template
+ VersionDescription: WebVersion2
+ VersionNumber: 2
+ properties:
+ launchTemplateVersion:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateVersion'
+ - description: Information about the launch template version.
+ warning:
+ allOf:
+ - $ref: '#/components/schemas/ValidationWarning'
+ - description: 'If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that''s found.'
+ CreateLocalGatewayRouteResult:
+ type: object
+ properties:
+ route:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRoute'
+ - description: Information about the route.
+ CreateLocalGatewayRouteTableVpcAssociationResult:
+ type: object
+ properties:
+ localGatewayRouteTableVpcAssociation:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociation'
+ - description: Information about the association.
+ CreateManagedPrefixListResult:
+ type: object
+ properties:
+ prefixList:
+ allOf:
+ - $ref: '#/components/schemas/ManagedPrefixList'
+ - description: Information about the prefix list.
+ AddPrefixListEntry:
+ type: object
+ required:
+ - Cidr
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A description for the entry.
Constraints: Up to 255 characters in length.
' + description: An entry for a prefix list. + CreateNatGatewayResult: + type: object + example: + NatGateway: + CreateTime: '2015-12-17T12:45:26.732Z' + NatGatewayAddresses: + - AllocationId: eipalloc-37fc1a52 + NatGatewayId: nat-08d48af2a8e83edfd + State: pending + SubnetId: subnet-1a2b3c4d + VpcId: vpc-1122aabb + properties: + clientToken: + allOf: + - $ref: '#/components/schemas/String' + - description: 'Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.' + natGateway: + allOf: + - $ref: '#/components/schemas/NatGateway' + - description: Information about the NAT gateway. + CreateNetworkAclResult: + type: object + example: + NetworkAcl: + Associations: [] + Entries: + - CidrBlock: 0.0.0.0/0 + Egress: true + Protocol: '-1' + RuleAction: deny + RuleNumber: 32767 + - CidrBlock: 0.0.0.0/0 + Egress: false + Protocol: '-1' + RuleAction: deny + RuleNumber: 32767 + IsDefault: false + NetworkAclId: acl-5fb85d36 + Tags: [] + VpcId: vpc-a01106c2 + properties: + networkAcl: + allOf: + - $ref: '#/components/schemas/NetworkAcl' + - description: Information about the network ACL. + Integer: + type: integer + CreateNetworkInsightsAccessScopeResult: + type: object + properties: + networkInsightsAccessScope: + allOf: + - $ref: '#/components/schemas/NetworkInsightsAccessScope' + - description: The Network Access Scope. + networkInsightsAccessScopeContent: + allOf: + - $ref: '#/components/schemas/NetworkInsightsAccessScopeContent' + - description: The Network Access Scope content. + AccessScopePathRequest: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/PathStatementRequest' + - description: The destination. + ThroughResource: + allOf: + - $ref: '#/components/schemas/ThroughResourcesStatementRequestList' + - description: The through resources. + description: Describes a path. + CreateNetworkInsightsPathResult: + type: object + properties: + networkInsightsPath: + allOf: + - $ref: '#/components/schemas/NetworkInsightsPath' + - description: Information about the path. + CreateNetworkInterfaceResult: + type: object + example: + NetworkInterface: + AvailabilityZone: us-east-1d + Description: my network interface + Groups: + - GroupId: sg-903004f8 + GroupName: default + MacAddress: '02:1a:80:41:52:9c' + NetworkInterfaceId: eni-e5aa89a3 + OwnerId: '123456789012' + PrivateIpAddress: 10.0.2.17 + PrivateIpAddresses: + - Primary: true + PrivateIpAddress: 10.0.2.17 + RequesterManaged: false + SourceDestCheck: true + Status: pending + SubnetId: subnet-9d4a7b6c + TagSet: [] + VpcId: vpc-a01106c2 + properties: + networkInterface: + allOf: + - $ref: '#/components/schemas/NetworkInterface' + - description: Information about the network interface. + clientToken: + allOf: + - $ref: '#/components/schemas/String' + - description: The token to use to retrieve the next page of results. This value isnull when there are no more results to return.
+ description: Contains the output of CreateNetworkInterface.
+ InstanceIpv6Address:
+ type: object
+ properties:
+ ipv6Address:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 address.
+ description: Describes an IPv6 address.
+ PrivateIpAddressSpecification:
+ type: object
+ properties:
+ primary:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
+ privateIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The private IPv4 addresses.
+ description: Describes a secondary private IPv4 address for a network interface.
+ Ipv4PrefixSpecificationRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.'
+ description: Describes the IPv4 prefix option for a network interface.
+ Ipv6PrefixSpecificationRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 prefix.
+ description: Describes the IPv4 prefix option for a network interface.
+ CreateNetworkInterfacePermissionResult:
+ type: object
+ properties:
+ interfacePermission:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfacePermission'
+ - description: Information about the permission for the network interface.
+ description: Contains the output of CreateNetworkInterfacePermission.
+ CreatePlacementGroupResult:
+ type: object
+ example: {}
+ properties:
+ placementGroup:
+ $ref: '#/components/schemas/PlacementGroup'
+ CreatePublicIpv4PoolResult:
+ type: object
+ properties:
+ poolId:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PoolEc2Id'
+ - description: The ID of the public IPv4 pool.
+ CreateReplaceRootVolumeTaskResult:
+ type: object
+ properties:
+ replaceRootVolumeTask:
+ allOf:
+ - $ref: '#/components/schemas/ReplaceRootVolumeTask'
+ - description: Information about the root volume replacement task.
+ CreateReservedInstancesListingResult:
+ type: object
+ properties:
+ reservedInstancesListingsSet:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesListingList'
+ - description: Information about the Standard Reserved Instance listing.
+ description: Contains the output of CreateReservedInstancesListing.
+ PriceScheduleSpecification:
+ type: object
+ properties:
+ currencyCode:
+ allOf:
+ - $ref: '#/components/schemas/CurrencyCodeValues'
+ - description: 'The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.'
+ price:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: The fixed price for the term.
+ term:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: 'The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.'
+ description: Describes the price for a Reserved Instance.
+ CreateRestoreImageTaskResult:
+ type: object
+ properties:
+ imageId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The AMI ID.
+ CreateRouteResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ CreateRouteTableResult:
+ type: object
+ example:
+ RouteTable:
+ Associations: []
+ PropagatingVgws: []
+ RouteTableId: rtb-22574640
+ Routes:
+ - DestinationCidrBlock: 10.0.0.0/16
+ GatewayId: local
+ State: active
+ Tags: []
+ VpcId: vpc-a01106c2
+ properties:
+ routeTable:
+ allOf:
+ - $ref: '#/components/schemas/RouteTable'
+ - description: Information about the route table.
+ CreateSecurityGroupResult:
+ type: object
+ example:
+ GroupId: sg-903004f8
+ properties:
+ groupId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the security group.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the security group.
+ Snapshot:
+ type: object
+ example:
+ Description: This is my root volume snapshot.
+ OwnerId: 012345678910
+ SnapshotId: snap-066877671789bd71b
+ StartTime: '2014-02-28T21:06:01.000Z'
+ State: pending
+ Tags: []
+ VolumeId: vol-1234567890abcdef0
+ VolumeSize: 8
+ properties:
+ dataEncryptionKeyId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.'
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description for the snapshot.
+ encrypted:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the snapshot is encrypted.
+ kmsKeyId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the EBS snapshot.
+ progress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The progress of the snapshot, as a percentage.'
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
+ startTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time stamp when the snapshot was initiated.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotState'
+ - description: The snapshot state.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.'
+ volumeId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
+ volumeSize:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The size of the volume, in GiB.'
+ ownerAlias:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.'
+ outpostArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.'
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the snapshot.
+ storageTier:
+ allOf:
+ - $ref: '#/components/schemas/StorageTier'
+ - description: The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
+ restoreExpiryTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
+ description: Describes a snapshot.
+ CreateSnapshotsResult:
+ type: object
+ properties:
+ snapshotSet:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotSet'
+ - description: List of snapshots.
+ CreateSpotDatafeedSubscriptionResult:
+ type: object
+ example:
+ SpotDatafeedSubscription:
+ Bucket: my-s3-bucket
+ OwnerId: '123456789012'
+ Prefix: spotdata
+ State: Active
+ properties:
+ spotDatafeedSubscription:
+ allOf:
+ - $ref: '#/components/schemas/SpotDatafeedSubscription'
+ - description: The Spot Instance data feed subscription.
+ description: Contains the output of CreateSpotDatafeedSubscription.
+ CreateStoreImageTaskResult:
+ type: object
+ properties:
+ objectKey:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the stored AMI object in the S3 bucket.
+ S3ObjectTag:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The value of the tag.
Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in length.
' + description: 'The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. For more information, see Categorizing your storage using tags in the Amazon Simple Storage Service User Guide.' + CreateSubnetResult: + type: object + example: + Subnet: + AvailabilityZone: us-west-2c + AvailableIpAddressCount: 251 + CidrBlock: 10.0.1.0/24 + State: pending + SubnetId: subnet-9d4a7b6c + VpcId: vpc-a01106c2 + properties: + subnet: + allOf: + - $ref: '#/components/schemas/Subnet' + - description: Information about the subnet. + CreateSubnetCidrReservationResult: + type: object + properties: + subnetCidrReservation: + allOf: + - $ref: '#/components/schemas/SubnetCidrReservation' + - description: Information about the created subnet CIDR reservation. + TaggableResourceId: + type: string + Tag: + type: object + properties: + key: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
' + description: Describes a tag. + CreateTrafficMirrorFilterResult: + type: object + properties: + trafficMirrorFilter: + allOf: + - $ref: '#/components/schemas/TrafficMirrorFilter' + - description: Information about the Traffic Mirror filter. + clientToken: + allOf: + - $ref: '#/components/schemas/String' + - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' + CreateTrafficMirrorFilterRuleResult: + type: object + properties: + trafficMirrorFilterRule: + allOf: + - $ref: '#/components/schemas/TrafficMirrorFilterRule' + - description: The Traffic Mirror rule. + clientToken: + allOf: + - $ref: '#/components/schemas/String' + - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' + CreateTrafficMirrorSessionResult: + type: object + properties: + trafficMirrorSession: + allOf: + - $ref: '#/components/schemas/TrafficMirrorSession' + - description: Information about the Traffic Mirror session. + clientToken: + allOf: + - $ref: '#/components/schemas/String' + - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' + CreateTrafficMirrorTargetResult: + type: object + properties: + trafficMirrorTarget: + allOf: + - $ref: '#/components/schemas/TrafficMirrorTarget' + - description: Information about the Traffic Mirror target. + clientToken: + allOf: + - $ref: '#/components/schemas/String' + - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' + CreateTransitGatewayResult: + type: object + properties: + transitGateway: + allOf: + - $ref: '#/components/schemas/TransitGateway' + - description: Information about the transit gateway. + TransitGatewayCidrBlockStringList: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + CreateTransitGatewayConnectResult: + type: object + properties: + transitGatewayConnect: + allOf: + - $ref: '#/components/schemas/TransitGatewayConnect' + - description: Information about the Connect attachment. + ProtocolValue: + type: string + enum: + - gre + CreateTransitGatewayConnectPeerResult: + type: object + properties: + transitGatewayConnectPeer: + allOf: + - $ref: '#/components/schemas/TransitGatewayConnectPeer' + - description: Information about the Connect peer. + Long: + type: integer + CreateTransitGatewayMulticastDomainResult: + type: object + properties: + transitGatewayMulticastDomain: + allOf: + - $ref: '#/components/schemas/TransitGatewayMulticastDomain' + - description: Information about the transit gateway multicast domain. + AutoAcceptSharedAssociationsValue: + type: string + enum: + - enable + - disable + CreateTransitGatewayPeeringAttachmentResult: + type: object + properties: + transitGatewayPeeringAttachment: + allOf: + - $ref: '#/components/schemas/TransitGatewayPeeringAttachment' + - description: The transit gateway peering attachment. + CreateTransitGatewayPrefixListReferenceResult: + type: object + properties: + transitGatewayPrefixListReference: + allOf: + - $ref: '#/components/schemas/TransitGatewayPrefixListReference' + - description: Information about the prefix list reference. + CreateTransitGatewayRouteResult: + type: object + properties: + route: + allOf: + - $ref: '#/components/schemas/TransitGatewayRoute' + - description: Information about the route. + CreateTransitGatewayRouteTableResult: + type: object + properties: + transitGatewayRouteTable: + allOf: + - $ref: '#/components/schemas/TransitGatewayRouteTable' + - description: Information about the transit gateway route table. + CreateTransitGatewayVpcAttachmentResult: + type: object + properties: + transitGatewayVpcAttachment: + allOf: + - $ref: '#/components/schemas/TransitGatewayVpcAttachment' + - description: Information about the VPC attachment. + ApplianceModeSupportValue: + type: string + enum: + - enable + - disable + Volume: + type: object + example: + Attachments: [] + AvailabilityZone: us-east-1a + CreateTime: '2016-08-29T18:52:32.724Z' + Iops: 1000 + Size: 500 + SnapshotId: snap-066877671789bd71b + State: creating + Tags: [] + VolumeId: vol-1234567890abcdef0 + VolumeType: io1 + properties: + attachmentSet: + allOf: + - $ref: '#/components/schemas/VolumeAttachmentList' + - description: Information about the volume attachments. + AvailabilityZone: + allOf: + - $ref: '#/components/schemas/String' + - description: The Availability Zone for the volume. + - xml: + name: 'availabilityZone' + createTime: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: The time stamp when volume creation was initiated. + encrypted: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Indicates whether the volume is encrypted. + kmsKeyId: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume. + outpostArn: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Resource Name (ARN) of the Outpost. + size: + type: integer + description: 'The size of the volume, in GiBs.' + snapshotId: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The snapshot from which the volume was created, if applicable.' + status: + allOf: + - $ref: '#/components/schemas/VolumeState' + - description: The volume state. + volumeId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the volume. + iops: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The number of I/O operations per second (IOPS). Forgp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.'
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the volume.
+ volumeType:
+ allOf:
+ - $ref: '#/components/schemas/VolumeType'
+ - description: The volume type.
+ fastRestored:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the volume was created using fast snapshot restore.
+ multiAttachEnabled:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether Amazon EBS Multi-Attach is enabled.
+ throughput:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The throughput that the volume supports, in MiB/s.'
+ description: Describes a volume.
+ CreateVpcResult:
+ type: object
+ example:
+ Vpc:
+ CidrBlock: 10.0.0.0/16
+ DhcpOptionsId: dopt-7a8b9c2d
+ InstanceTenancy: default
+ State: pending
+ VpcId: vpc-a01106c2
+ properties:
+ vpc:
+ allOf:
+ - $ref: '#/components/schemas/Vpc'
+ - description: Information about the VPC.
+ CreateVpcEndpointResult:
+ type: object
+ properties:
+ vpcEndpoint:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpoint'
+ - description: Information about the endpoint.
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
+ description: Contains the output of CreateVpcEndpoint.
+ RouteTableId:
+ type: string
+ DnsRecordIpType:
+ type: string
+ enum:
+ - ipv4
+ - dualstack
+ - ipv6
+ - service-defined
+ CreateVpcEndpointConnectionNotificationResult:
+ type: object
+ properties:
+ connectionNotification:
+ allOf:
+ - $ref: '#/components/schemas/ConnectionNotification'
+ - description: Information about the notification.
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
+ CreateVpcEndpointServiceConfigurationResult:
+ type: object
+ properties:
+ serviceConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/ServiceConfiguration'
+ - description: Information about the service configuration.
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
+ CreateVpcPeeringConnectionResult:
+ type: object
+ properties:
+ vpcPeeringConnection:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnection'
+ - description: Information about the VPC peering connection.
+ CreateVpnConnectionResult:
+ type: object
+ properties:
+ vpnConnection:
+ allOf:
+ - $ref: '#/components/schemas/VpnConnection'
+ - description: Information about the VPN connection.
+ description: Contains the output of CreateVpnConnection.
+ CreateVpnGatewayResult:
+ type: object
+ properties:
+ vpnGateway:
+ allOf:
+ - $ref: '#/components/schemas/VpnGateway'
+ - description: Information about the virtual private gateway.
+ description: Contains the output of CreateVpnGateway.
+ DeleteCarrierGatewayResult:
+ type: object
+ properties:
+ carrierGateway:
+ allOf:
+ - $ref: '#/components/schemas/CarrierGateway'
+ - description: Information about the carrier gateway.
+ DeleteClientVpnEndpointResult:
+ type: object
+ properties:
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnEndpointStatus'
+ - description: The current state of the Client VPN endpoint.
+ DeleteClientVpnRouteResult:
+ type: object
+ properties:
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnRouteStatus'
+ - description: The current state of the route.
+ DeleteEgressOnlyInternetGatewayResult:
+ type: object
+ properties:
+ returnCode:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ DeleteFleetsResult:
+ type: object
+ properties:
+ successfulFleetDeletionSet:
+ allOf:
+ - $ref: '#/components/schemas/DeleteFleetSuccessSet'
+ - description: Information about the EC2 Fleets that are successfully deleted.
+ unsuccessfulFleetDeletionSet:
+ allOf:
+ - $ref: '#/components/schemas/DeleteFleetErrorSet'
+ - description: Information about the EC2 Fleets that are not successfully deleted.
+ FleetId:
+ type: string
+ DeleteFlowLogsResult:
+ type: object
+ properties:
+ unsuccessful:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulItemSet'
+ - description: Information about the flow logs that could not be deleted successfully.
+ VpcFlowLogId:
+ type: string
+ DeleteFpgaImageResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Is true if the request succeeds, and an error otherwise.'
+ DeleteInstanceEventWindowResult:
+ type: object
+ properties:
+ instanceEventWindowState:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowStateChange'
+ - description: The state of the event window.
+ DeleteIpamResult:
+ type: object
+ properties:
+ ipam:
+ allOf:
+ - $ref: '#/components/schemas/Ipam'
+ - description: Information about the results of the deletion.
+ DeleteIpamPoolResult:
+ type: object
+ properties:
+ ipamPool:
+ allOf:
+ - $ref: '#/components/schemas/IpamPool'
+ - description: Information about the results of the deletion.
+ DeleteIpamScopeResult:
+ type: object
+ properties:
+ ipamScope:
+ allOf:
+ - $ref: '#/components/schemas/IpamScope'
+ - description: Information about the results of the deletion.
+ DeleteLaunchTemplateResult:
+ type: object
+ example:
+ LaunchTemplate:
+ CreateTime: '2017-11-23T16:46:25.000Z'
+ CreatedBy: 'arn:aws:iam::123456789012:root'
+ DefaultVersionNumber: 2
+ LatestVersionNumber: 2
+ LaunchTemplateId: lt-0abcd290751193123
+ LaunchTemplateName: my-template
+ properties:
+ launchTemplate:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplate'
+ - description: Information about the launch template.
+ DeleteLaunchTemplateVersionsResult:
+ type: object
+ example:
+ SuccessfullyDeletedLaunchTemplateVersions:
+ - LaunchTemplateId: lt-0abcd290751193123
+ LaunchTemplateName: my-template
+ VersionNumber: 1
+ UnsuccessfullyDeletedLaunchTemplateVersions: []
+ properties:
+ successfullyDeletedLaunchTemplateVersionSet:
+ allOf:
+ - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseSuccessSet'
+ - description: Information about the launch template versions that were successfully deleted.
+ unsuccessfullyDeletedLaunchTemplateVersionSet:
+ allOf:
+ - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseErrorSet'
+ - description: Information about the launch template versions that could not be deleted.
+ DeleteLocalGatewayRouteResult:
+ type: object
+ properties:
+ route:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRoute'
+ - description: Information about the route.
+ DeleteLocalGatewayRouteTableVpcAssociationResult:
+ type: object
+ properties:
+ localGatewayRouteTableVpcAssociation:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociation'
+ - description: Information about the association.
+ DeleteManagedPrefixListResult:
+ type: object
+ properties:
+ prefixList:
+ allOf:
+ - $ref: '#/components/schemas/ManagedPrefixList'
+ - description: Information about the prefix list.
+ DeleteNatGatewayResult:
+ type: object
+ example:
+ NatGatewayId: nat-04ae55e711cec5680
+ properties:
+ natGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the NAT gateway.
+ DeleteNetworkInsightsAccessScopeResult:
+ type: object
+ properties:
+ networkInsightsAccessScopeId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
+ - description: The ID of the Network Access Scope.
+ DeleteNetworkInsightsAccessScopeAnalysisResult:
+ type: object
+ properties:
+ networkInsightsAccessScopeAnalysisId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
+ - description: The ID of the Network Access Scope analysis.
+ DeleteNetworkInsightsAnalysisResult:
+ type: object
+ properties:
+ networkInsightsAnalysisId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAnalysisId'
+ - description: The ID of the network insights analysis.
+ DeleteNetworkInsightsPathResult:
+ type: object
+ properties:
+ networkInsightsPathId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsPathId'
+ - description: The ID of the path.
+ DeleteNetworkInterfacePermissionResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds, otherwise returns an error.'
+ description: Contains the output for DeleteNetworkInterfacePermission.
+ DeletePublicIpv4PoolResult:
+ type: object
+ properties:
+ returnValue:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Information about the result of deleting the public IPv4 pool.
+ DeleteQueuedReservedInstancesResult:
+ type: object
+ properties:
+ successfulQueuedPurchaseDeletionSet:
+ allOf:
+ - $ref: '#/components/schemas/SuccessfulQueuedPurchaseDeletionSet'
+ - description: Information about the queued purchases that were successfully deleted.
+ failedQueuedPurchaseDeletionSet:
+ allOf:
+ - $ref: '#/components/schemas/FailedQueuedPurchaseDeletionSet'
+ - description: Information about the queued purchases that could not be deleted.
+ DeleteSubnetCidrReservationResult:
+ type: object
+ properties:
+ deletedSubnetCidrReservation:
+ allOf:
+ - $ref: '#/components/schemas/SubnetCidrReservation'
+ - description: Information about the deleted subnet CIDR reservation.
+ DeleteTrafficMirrorFilterResult:
+ type: object
+ properties:
+ trafficMirrorFilterId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Traffic Mirror filter.
+ DeleteTrafficMirrorFilterRuleResult:
+ type: object
+ properties:
+ trafficMirrorFilterRuleId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the deleted Traffic Mirror rule.
+ DeleteTrafficMirrorSessionResult:
+ type: object
+ properties:
+ trafficMirrorSessionId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the deleted Traffic Mirror session.
+ DeleteTrafficMirrorTargetResult:
+ type: object
+ properties:
+ trafficMirrorTargetId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the deleted Traffic Mirror target.
+ DeleteTransitGatewayResult:
+ type: object
+ properties:
+ transitGateway:
+ allOf:
+ - $ref: '#/components/schemas/TransitGateway'
+ - description: Information about the deleted transit gateway.
+ DeleteTransitGatewayConnectResult:
+ type: object
+ properties:
+ transitGatewayConnect:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnect'
+ - description: Information about the deleted Connect attachment.
+ DeleteTransitGatewayConnectPeerResult:
+ type: object
+ properties:
+ transitGatewayConnectPeer:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnectPeer'
+ - description: Information about the deleted Connect peer.
+ DeleteTransitGatewayMulticastDomainResult:
+ type: object
+ properties:
+ transitGatewayMulticastDomain:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomain'
+ - description: Information about the deleted transit gateway multicast domain.
+ DeleteTransitGatewayPeeringAttachmentResult:
+ type: object
+ properties:
+ transitGatewayPeeringAttachment:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
+ - description: The transit gateway peering attachment.
+ DeleteTransitGatewayPrefixListReferenceResult:
+ type: object
+ properties:
+ transitGatewayPrefixListReference:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPrefixListReference'
+ - description: Information about the deleted prefix list reference.
+ DeleteTransitGatewayRouteResult:
+ type: object
+ properties:
+ route:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRoute'
+ - description: Information about the route.
+ DeleteTransitGatewayRouteTableResult:
+ type: object
+ properties:
+ transitGatewayRouteTable:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTable'
+ - description: Information about the deleted transit gateway route table.
+ DeleteTransitGatewayVpcAttachmentResult:
+ type: object
+ properties:
+ transitGatewayVpcAttachment:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayVpcAttachment'
+ - description: Information about the deleted VPC attachment.
+ DeleteVpcEndpointConnectionNotificationsResult:
+ type: object
+ properties:
+ unsuccessful:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulItemSet'
+ - description: Information about the notifications that could not be deleted successfully.
+ ConnectionNotificationId:
+ type: string
+ DeleteVpcEndpointServiceConfigurationsResult:
+ type: object
+ properties:
+ unsuccessful:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulItemSet'
+ - description: 'Information about the service configurations that were not deleted, if applicable.'
+ VpcEndpointServiceId:
+ type: string
+ DeleteVpcEndpointsResult:
+ type: object
+ properties:
+ unsuccessful:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulItemSet'
+ - description: Information about the VPC endpoints that were not successfully deleted.
+ description: Contains the output of DeleteVpcEndpoints.
+ DeleteVpcPeeringConnectionResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ DeprovisionByoipCidrResult:
+ type: object
+ properties:
+ byoipCidr:
+ allOf:
+ - $ref: '#/components/schemas/ByoipCidr'
+ - description: Information about the address range.
+ DeprovisionIpamPoolCidrResult:
+ type: object
+ properties:
+ ipamPoolCidr:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolCidr'
+ - description: The deprovisioned pool CIDR.
+ DeprovisionPublicIpv4PoolCidrResult:
+ type: object
+ properties:
+ poolId:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PoolEc2Id'
+ - description: The ID of the pool that you deprovisioned the CIDR from.
+ deprovisionedAddressSet:
+ allOf:
+ - $ref: '#/components/schemas/DeprovisionedAddressSet'
+ - description: The deprovisioned CIDRs.
+ DeregisterInstanceEventNotificationAttributesResult:
+ type: object
+ properties:
+ instanceTagAttribute:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTagNotificationAttribute'
+ - description: The resulting set of tag keys.
+ InstanceTagKeySet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ DeregisterTransitGatewayMulticastGroupMembersResult:
+ type: object
+ properties:
+ deregisteredMulticastGroupMembers:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDeregisteredGroupMembers'
+ - description: Information about the deregistered members.
+ NetworkInterfaceId:
+ type: string
+ DeregisterTransitGatewayMulticastGroupSourcesResult:
+ type: object
+ properties:
+ deregisteredMulticastGroupSources:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDeregisteredGroupSources'
+ - description: Information about the deregistered group sources.
+ DescribeAccountAttributesResult:
+ type: object
+ example:
+ AccountAttributes:
+ - AttributeName: supported-platforms
+ AttributeValues:
+ - AttributeValue: EC2
+ - AttributeValue: VPC
+ - AttributeName: vpc-max-security-groups-per-interface
+ AttributeValues:
+ - AttributeValue: '5'
+ - AttributeName: max-elastic-ips
+ AttributeValues:
+ - AttributeValue: '5'
+ - AttributeName: max-instances
+ AttributeValues:
+ - AttributeValue: '20'
+ - AttributeName: vpc-max-elastic-ips
+ AttributeValues:
+ - AttributeValue: '5'
+ - AttributeName: default-vpc
+ AttributeValues:
+ - AttributeValue: none
+ properties:
+ accountAttributeSet:
+ allOf:
+ - $ref: '#/components/schemas/AccountAttributeList'
+ - description: Information about the account attributes.
+ AccountAttributeName:
+ type: string
+ enum:
+ - supported-platforms
+ - default-vpc
+ DescribeAddressesResult:
+ type: object
+ example:
+ Addresses:
+ - Domain: standard
+ InstanceId: i-1234567890abcdef0
+ PublicIp: 198.51.100.0
+ properties:
+ addressesSet:
+ allOf:
+ - $ref: '#/components/schemas/AddressList'
+ - description: Information about the Elastic IP addresses.
+ Filter:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the filter. Filter names are case-sensitive.
+ Value:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: 'The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.'
+ description: 'A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
null when there are no more results to return.
+ DescribeAggregateIdFormatResult:
+ type: object
+ properties:
+ useLongIdsAggregated:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether all resource types in the Region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the Region.
+ statusSet:
+ allOf:
+ - $ref: '#/components/schemas/IdFormatList'
+ - description: Information about each resource's ID format.
+ DescribeAvailabilityZonesResult:
+ type: object
+ example:
+ AvailabilityZones:
+ - Messages: []
+ RegionName: us-east-1
+ State: available
+ ZoneName: us-east-1b
+ - Messages: []
+ RegionName: us-east-1
+ State: available
+ ZoneName: us-east-1c
+ - Messages: []
+ RegionName: us-east-1
+ State: available
+ ZoneName: us-east-1d
+ - Messages: []
+ RegionName: us-east-1
+ State: available
+ ZoneName: us-east-1e
+ properties:
+ availabilityZoneInfo:
+ allOf:
+ - $ref: '#/components/schemas/AvailabilityZoneList'
+ - description: 'Information about the Availability Zones, Local Zones, and Wavelength Zones.'
+ DescribeBundleTasksResult:
+ type: object
+ properties:
+ bundleInstanceTasksSet:
+ allOf:
+ - $ref: '#/components/schemas/BundleTaskList'
+ - description: Information about the bundle tasks.
+ BundleId:
+ type: string
+ DescribeByoipCidrsResult:
+ type: object
+ properties:
+ byoipCidrSet:
+ allOf:
+ - $ref: '#/components/schemas/ByoipCidrSet'
+ - description: Information about your address ranges.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeCapacityReservationFleetsResult:
+ type: object
+ properties:
+ capacityReservationFleetSet:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationFleetSet'
+ - description: Information about the Capacity Reservation Fleets.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeCapacityReservationsResult:
+ type: object
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ capacityReservationSet:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationSet'
+ - description: Information about the Capacity Reservations.
+ CapacityReservationId:
+ type: string
+ DescribeCarrierGatewaysResult:
+ type: object
+ properties:
+ carrierGatewaySet:
+ allOf:
+ - $ref: '#/components/schemas/CarrierGatewaySet'
+ - description: Information about the carrier gateway.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ CarrierGatewayId:
+ type: string
+ DescribeClassicLinkInstancesResult:
+ type: object
+ properties:
+ instancesSet:
+ allOf:
+ - $ref: '#/components/schemas/ClassicLinkInstanceList'
+ - description: Information about one or more linked EC2-Classic instances.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ InstanceId:
+ type: string
+ DescribeClientVpnAuthorizationRulesResult:
+ type: object
+ properties:
+ authorizationRule:
+ allOf:
+ - $ref: '#/components/schemas/AuthorizationRuleSet'
+ - description: Information about the authorization rules.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeClientVpnConnectionsResult:
+ type: object
+ properties:
+ connections:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnConnectionSet'
+ - description: Information about the active and terminated client connections.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeClientVpnEndpointsResult:
+ type: object
+ properties:
+ clientVpnEndpoint:
+ allOf:
+ - $ref: '#/components/schemas/EndpointSet'
+ - description: Information about the Client VPN endpoints.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ ClientVpnEndpointId:
+ type: string
+ DescribeClientVpnRoutesResult:
+ type: object
+ properties:
+ routes:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnRouteSet'
+ - description: Information about the Client VPN endpoint routes.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeClientVpnTargetNetworksResult:
+ type: object
+ properties:
+ clientVpnTargetNetworks:
+ allOf:
+ - $ref: '#/components/schemas/TargetNetworkSet'
+ - description: Information about the associated target networks.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeCoipPoolsResult:
+ type: object
+ properties:
+ coipPoolSet:
+ allOf:
+ - $ref: '#/components/schemas/CoipPoolSet'
+ - description: Information about the address pools.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ Ipv4PoolCoipId:
+ type: string
+ DescribeConversionTasksResult:
+ type: object
+ properties:
+ conversionTasks:
+ allOf:
+ - $ref: '#/components/schemas/DescribeConversionTaskList'
+ - description: Information about the conversion tasks.
+ ConversionTaskId:
+ type: string
+ DescribeCustomerGatewaysResult:
+ type: object
+ example:
+ CustomerGateways:
+ - BgpAsn: '65534'
+ CustomerGatewayId: cgw-0e11f167
+ IpAddress: 12.1.2.3
+ State: available
+ Type: ipsec.1
+ properties:
+ customerGatewaySet:
+ allOf:
+ - $ref: '#/components/schemas/CustomerGatewayList'
+ - description: Information about one or more customer gateways.
+ description: Contains the output of DescribeCustomerGateways.
+ CustomerGatewayId:
+ type: string
+ DescribeDhcpOptionsResult:
+ type: object
+ example:
+ DhcpOptions:
+ - DhcpConfigurations:
+ - Key: domain-name-servers
+ Values:
+ - Value: 10.2.5.2
+ - Value: 10.2.5.1
+ DhcpOptionsId: dopt-d9070ebb
+ properties:
+ dhcpOptionsSet:
+ allOf:
+ - $ref: '#/components/schemas/DhcpOptionsList'
+ - description: Information about one or more DHCP options sets.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DhcpOptionsId:
+ type: string
+ DescribeEgressOnlyInternetGatewaysResult:
+ type: object
+ properties:
+ egressOnlyInternetGatewaySet:
+ allOf:
+ - $ref: '#/components/schemas/EgressOnlyInternetGatewayList'
+ - description: Information about the egress-only internet gateways.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ EgressOnlyInternetGatewayId:
+ type: string
+ DescribeElasticGpusResult:
+ type: object
+ properties:
+ elasticGpuSet:
+ allOf:
+ - $ref: '#/components/schemas/ElasticGpuSet'
+ - description: Information about the Elastic Graphics accelerators.
+ maxResults:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ ElasticGpuId:
+ type: string
+ DescribeExportImageTasksResult:
+ type: object
+ properties:
+ exportImageTaskSet:
+ allOf:
+ - $ref: '#/components/schemas/ExportImageTaskList'
+ - description: Information about the export image tasks.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to get the next page of results. This value is null when there are no more results to return.
+ ExportImageTaskId:
+ type: string
+ DescribeExportTasksResult:
+ type: object
+ properties:
+ exportTaskSet:
+ allOf:
+ - $ref: '#/components/schemas/ExportTaskList'
+ - description: Information about the export tasks.
+ ExportTaskId:
+ type: string
+ DescribeFastLaunchImagesResult:
+ type: object
+ properties:
+ fastLaunchImageSet:
+ allOf:
+ - $ref: '#/components/schemas/DescribeFastLaunchImagesSuccessSet'
+ - description: A collection of details about the fast-launch enabled Windows images that meet the requested criteria.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use for the next set of results. This value is null when there are no more results to return.
+ ImageId:
+ type: string
+ DescribeFastSnapshotRestoresResult:
+ type: object
+ properties:
+ fastSnapshotRestoreSet:
+ allOf:
+ - $ref: '#/components/schemas/DescribeFastSnapshotRestoreSuccessSet'
+ - description: Information about the state of fast snapshot restores.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeFleetHistoryResult:
+ type: object
+ properties:
+ historyRecordSet:
+ allOf:
+ - $ref: '#/components/schemas/HistoryRecordSet'
+ - description: Information about the events in the history of the EC2 Fleet.
+ lastEvaluatedTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more results, this value is not present.
null when there are no more results to return.
+ DescribeFpgaImageAttributeResult:
+ type: object
+ properties:
+ fpgaImageAttribute:
+ allOf:
+ - $ref: '#/components/schemas/FpgaImageAttribute'
+ - description: Information about the attribute.
+ DescribeFpgaImagesResult:
+ type: object
+ properties:
+ fpgaImageSet:
+ allOf:
+ - $ref: '#/components/schemas/FpgaImageList'
+ - description: Information about the FPGA images.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ FpgaImageId:
+ type: string
+ DescribeHostReservationOfferingsResult:
+ type: object
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ offeringSet:
+ allOf:
+ - $ref: '#/components/schemas/HostOfferingSet'
+ - description: Information about the offerings.
+ DescribeHostReservationsResult:
+ type: object
+ properties:
+ hostReservationSet:
+ allOf:
+ - $ref: '#/components/schemas/HostReservationSet'
+ - description: Details about the reservation's configuration.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ HostReservationId:
+ type: string
+ DescribeHostsResult:
+ type: object
+ properties:
+ hostSet:
+ allOf:
+ - $ref: '#/components/schemas/HostList'
+ - description: Information about the Dedicated Hosts.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DedicatedHostId:
+ type: string
+ DescribeIamInstanceProfileAssociationsResult:
+ type: object
+ example:
+ IamInstanceProfileAssociations:
+ - AssociationId: iip-assoc-0db249b1f25fa24b8
+ IamInstanceProfile:
+ Arn: 'arn:aws:iam::123456789012:instance-profile/admin-role'
+ Id: AIPAJVQN4F5WVLGCJDRGM
+ InstanceId: i-09eb09efa73ec1dee
+ State: associated
+ properties:
+ iamInstanceProfileAssociationSet:
+ allOf:
+ - $ref: '#/components/schemas/IamInstanceProfileAssociationSet'
+ - description: Information about the IAM instance profile associations.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ IamInstanceProfileAssociationId:
+ type: string
+ DescribeIdFormatResult:
+ type: object
+ properties:
+ statusSet:
+ allOf:
+ - $ref: '#/components/schemas/IdFormatList'
+ - description: Information about the ID format for the resource.
+ DescribeIdentityIdFormatResult:
+ type: object
+ properties:
+ statusSet:
+ allOf:
+ - $ref: '#/components/schemas/IdFormatList'
+ - description: Information about the ID format for the resources.
+ ImageAttribute:
+ type: object
+ example:
+ ImageId: ami-5731123e
+ LaunchPermissions:
+ - UserId: '123456789012'
+ properties:
+ blockDeviceMapping:
+ allOf:
+ - $ref: '#/components/schemas/BlockDeviceMappingList'
+ - description: The block device mapping entries.
+ imageId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the AMI.
+ launchPermission:
+ allOf:
+ - $ref: '#/components/schemas/LaunchPermissionList'
+ - description: The launch permissions.
+ productCodes:
+ allOf:
+ - $ref: '#/components/schemas/ProductCodeList'
+ - description: The product codes.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: A description for the AMI.
+ kernel:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: The kernel ID.
+ ramdisk:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: The RAM disk ID.
+ sriovNetSupport:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
+ bootMode:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: The boot mode.
+ tpmSupport:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: 'If the image is configured for NitroTPM support, the value is v2.0.'
+ uefiData:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: 'Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.'
+ lastLaunchedTime:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: 'The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used, there is a 24-hour delay before that usage is reported.
lastLaunchedTime data is available starting April 2017.
null when there are no more results to return.
+ ImportImageTaskId:
+ type: string
+ DescribeImportSnapshotTasksResult:
+ type: object
+ properties:
+ importSnapshotTaskSet:
+ allOf:
+ - $ref: '#/components/schemas/ImportSnapshotTaskList'
+ - description: A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to get the next page of results. This value is null when there are no more results to return.
+ ImportSnapshotTaskId:
+ type: string
+ InstanceAttribute:
+ type: object
+ example:
+ BlockDeviceMappings:
+ - DeviceName: /dev/sda1
+ Ebs:
+ AttachTime: '2013-05-17T22:42:34.000Z'
+ DeleteOnTermination: true
+ Status: attached
+ VolumeId: vol-049df61146c4d7901
+ - DeviceName: /dev/sdf
+ Ebs:
+ AttachTime: '2013-09-10T23:07:00.000Z'
+ DeleteOnTermination: false
+ Status: attached
+ VolumeId: vol-049df61146c4d7901
+ InstanceId: i-1234567890abcdef0
+ properties:
+ groupSet:
+ allOf:
+ - $ref: '#/components/schemas/GroupIdentifierList'
+ - description: The security groups associated with the instance.
+ blockDeviceMapping:
+ allOf:
+ - $ref: '#/components/schemas/InstanceBlockDeviceMappingList'
+ - description: The block device mapping of the instance.
+ disableApiTermination:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: 'If the value is true, you can''t terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.'
+ enaSupport:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: Indicates whether enhanced networking with ENA is enabled.
+ enclaveOptions:
+ allOf:
+ - $ref: '#/components/schemas/EnclaveOptions'
+ - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.'
+ ebsOptimized:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: Indicates whether the instance is optimized for Amazon EBS I/O.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance.
+ instanceInitiatedShutdownBehavior:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: The instance type.
+ kernel:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: The kernel ID.
+ productCodes:
+ allOf:
+ - $ref: '#/components/schemas/ProductCodeList'
+ - description: A list of product codes.
+ ramdisk:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: The RAM disk ID.
+ rootDeviceName:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: 'The device name of the root device volume (for example, /dev/sda1).'
+ sourceDestCheck:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
+ sriovNetSupport:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
+ userData:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: The user data.
+ description: Describes an instance attribute.
+ DescribeInstanceCreditSpecificationsResult:
+ type: object
+ properties:
+ instanceCreditSpecificationSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceCreditSpecificationList'
+ - description: Information about the credit option for CPU usage of an instance.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeInstanceEventNotificationAttributesResult:
+ type: object
+ properties:
+ instanceTagAttribute:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTagNotificationAttribute'
+ - description: Information about the registered tag keys.
+ DescribeInstanceEventWindowsResult:
+ type: object
+ properties:
+ instanceEventWindowSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowSet'
+ - description: Information about the event windows.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
+ InstanceEventWindowId:
+ type: string
+ DescribeInstanceStatusResult:
+ type: object
+ example:
+ InstanceStatuses:
+ - AvailabilityZone: us-east-1d
+ InstanceId: i-1234567890abcdef0
+ InstanceState:
+ Code: 16
+ Name: running
+ InstanceStatus:
+ Details:
+ - Name: reachability
+ Status: passed
+ Status: ok
+ SystemStatus:
+ Details:
+ - Name: reachability
+ Status: passed
+ Status: ok
+ properties:
+ instanceStatusSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceStatusList'
+ - description: Information about the status of the instances.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeInstanceTypeOfferingsResult:
+ type: object
+ properties:
+ instanceTypeOfferingSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTypeOfferingsList'
+ - description: The instance types offered.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeInstanceTypesResult:
+ type: object
+ properties:
+ instanceTypeSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTypeInfoList'
+ - description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ InstanceType:
+ type: string
+ enum:
+ - a1.medium
+ - a1.large
+ - a1.xlarge
+ - a1.2xlarge
+ - a1.4xlarge
+ - a1.metal
+ - c1.medium
+ - c1.xlarge
+ - c3.large
+ - c3.xlarge
+ - c3.2xlarge
+ - c3.4xlarge
+ - c3.8xlarge
+ - c4.large
+ - c4.xlarge
+ - c4.2xlarge
+ - c4.4xlarge
+ - c4.8xlarge
+ - c5.large
+ - c5.xlarge
+ - c5.2xlarge
+ - c5.4xlarge
+ - c5.9xlarge
+ - c5.12xlarge
+ - c5.18xlarge
+ - c5.24xlarge
+ - c5.metal
+ - c5a.large
+ - c5a.xlarge
+ - c5a.2xlarge
+ - c5a.4xlarge
+ - c5a.8xlarge
+ - c5a.12xlarge
+ - c5a.16xlarge
+ - c5a.24xlarge
+ - c5ad.large
+ - c5ad.xlarge
+ - c5ad.2xlarge
+ - c5ad.4xlarge
+ - c5ad.8xlarge
+ - c5ad.12xlarge
+ - c5ad.16xlarge
+ - c5ad.24xlarge
+ - c5d.large
+ - c5d.xlarge
+ - c5d.2xlarge
+ - c5d.4xlarge
+ - c5d.9xlarge
+ - c5d.12xlarge
+ - c5d.18xlarge
+ - c5d.24xlarge
+ - c5d.metal
+ - c5n.large
+ - c5n.xlarge
+ - c5n.2xlarge
+ - c5n.4xlarge
+ - c5n.9xlarge
+ - c5n.18xlarge
+ - c5n.metal
+ - c6g.medium
+ - c6g.large
+ - c6g.xlarge
+ - c6g.2xlarge
+ - c6g.4xlarge
+ - c6g.8xlarge
+ - c6g.12xlarge
+ - c6g.16xlarge
+ - c6g.metal
+ - c6gd.medium
+ - c6gd.large
+ - c6gd.xlarge
+ - c6gd.2xlarge
+ - c6gd.4xlarge
+ - c6gd.8xlarge
+ - c6gd.12xlarge
+ - c6gd.16xlarge
+ - c6gd.metal
+ - c6gn.medium
+ - c6gn.large
+ - c6gn.xlarge
+ - c6gn.2xlarge
+ - c6gn.4xlarge
+ - c6gn.8xlarge
+ - c6gn.12xlarge
+ - c6gn.16xlarge
+ - c6i.large
+ - c6i.xlarge
+ - c6i.2xlarge
+ - c6i.4xlarge
+ - c6i.8xlarge
+ - c6i.12xlarge
+ - c6i.16xlarge
+ - c6i.24xlarge
+ - c6i.32xlarge
+ - c6i.metal
+ - cc1.4xlarge
+ - cc2.8xlarge
+ - cg1.4xlarge
+ - cr1.8xlarge
+ - d2.xlarge
+ - d2.2xlarge
+ - d2.4xlarge
+ - d2.8xlarge
+ - d3.xlarge
+ - d3.2xlarge
+ - d3.4xlarge
+ - d3.8xlarge
+ - d3en.xlarge
+ - d3en.2xlarge
+ - d3en.4xlarge
+ - d3en.6xlarge
+ - d3en.8xlarge
+ - d3en.12xlarge
+ - dl1.24xlarge
+ - f1.2xlarge
+ - f1.4xlarge
+ - f1.16xlarge
+ - g2.2xlarge
+ - g2.8xlarge
+ - g3.4xlarge
+ - g3.8xlarge
+ - g3.16xlarge
+ - g3s.xlarge
+ - g4ad.xlarge
+ - g4ad.2xlarge
+ - g4ad.4xlarge
+ - g4ad.8xlarge
+ - g4ad.16xlarge
+ - g4dn.xlarge
+ - g4dn.2xlarge
+ - g4dn.4xlarge
+ - g4dn.8xlarge
+ - g4dn.12xlarge
+ - g4dn.16xlarge
+ - g4dn.metal
+ - g5.xlarge
+ - g5.2xlarge
+ - g5.4xlarge
+ - g5.8xlarge
+ - g5.12xlarge
+ - g5.16xlarge
+ - g5.24xlarge
+ - g5.48xlarge
+ - g5g.xlarge
+ - g5g.2xlarge
+ - g5g.4xlarge
+ - g5g.8xlarge
+ - g5g.16xlarge
+ - g5g.metal
+ - hi1.4xlarge
+ - hpc6a.48xlarge
+ - hs1.8xlarge
+ - h1.2xlarge
+ - h1.4xlarge
+ - h1.8xlarge
+ - h1.16xlarge
+ - i2.xlarge
+ - i2.2xlarge
+ - i2.4xlarge
+ - i2.8xlarge
+ - i3.large
+ - i3.xlarge
+ - i3.2xlarge
+ - i3.4xlarge
+ - i3.8xlarge
+ - i3.16xlarge
+ - i3.metal
+ - i3en.large
+ - i3en.xlarge
+ - i3en.2xlarge
+ - i3en.3xlarge
+ - i3en.6xlarge
+ - i3en.12xlarge
+ - i3en.24xlarge
+ - i3en.metal
+ - im4gn.large
+ - im4gn.xlarge
+ - im4gn.2xlarge
+ - im4gn.4xlarge
+ - im4gn.8xlarge
+ - im4gn.16xlarge
+ - inf1.xlarge
+ - inf1.2xlarge
+ - inf1.6xlarge
+ - inf1.24xlarge
+ - is4gen.medium
+ - is4gen.large
+ - is4gen.xlarge
+ - is4gen.2xlarge
+ - is4gen.4xlarge
+ - is4gen.8xlarge
+ - m1.small
+ - m1.medium
+ - m1.large
+ - m1.xlarge
+ - m2.xlarge
+ - m2.2xlarge
+ - m2.4xlarge
+ - m3.medium
+ - m3.large
+ - m3.xlarge
+ - m3.2xlarge
+ - m4.large
+ - m4.xlarge
+ - m4.2xlarge
+ - m4.4xlarge
+ - m4.10xlarge
+ - m4.16xlarge
+ - m5.large
+ - m5.xlarge
+ - m5.2xlarge
+ - m5.4xlarge
+ - m5.8xlarge
+ - m5.12xlarge
+ - m5.16xlarge
+ - m5.24xlarge
+ - m5.metal
+ - m5a.large
+ - m5a.xlarge
+ - m5a.2xlarge
+ - m5a.4xlarge
+ - m5a.8xlarge
+ - m5a.12xlarge
+ - m5a.16xlarge
+ - m5a.24xlarge
+ - m5ad.large
+ - m5ad.xlarge
+ - m5ad.2xlarge
+ - m5ad.4xlarge
+ - m5ad.8xlarge
+ - m5ad.12xlarge
+ - m5ad.16xlarge
+ - m5ad.24xlarge
+ - m5d.large
+ - m5d.xlarge
+ - m5d.2xlarge
+ - m5d.4xlarge
+ - m5d.8xlarge
+ - m5d.12xlarge
+ - m5d.16xlarge
+ - m5d.24xlarge
+ - m5d.metal
+ - m5dn.large
+ - m5dn.xlarge
+ - m5dn.2xlarge
+ - m5dn.4xlarge
+ - m5dn.8xlarge
+ - m5dn.12xlarge
+ - m5dn.16xlarge
+ - m5dn.24xlarge
+ - m5dn.metal
+ - m5n.large
+ - m5n.xlarge
+ - m5n.2xlarge
+ - m5n.4xlarge
+ - m5n.8xlarge
+ - m5n.12xlarge
+ - m5n.16xlarge
+ - m5n.24xlarge
+ - m5n.metal
+ - m5zn.large
+ - m5zn.xlarge
+ - m5zn.2xlarge
+ - m5zn.3xlarge
+ - m5zn.6xlarge
+ - m5zn.12xlarge
+ - m5zn.metal
+ - m6a.large
+ - m6a.xlarge
+ - m6a.2xlarge
+ - m6a.4xlarge
+ - m6a.8xlarge
+ - m6a.12xlarge
+ - m6a.16xlarge
+ - m6a.24xlarge
+ - m6a.32xlarge
+ - m6a.48xlarge
+ - m6g.metal
+ - m6g.medium
+ - m6g.large
+ - m6g.xlarge
+ - m6g.2xlarge
+ - m6g.4xlarge
+ - m6g.8xlarge
+ - m6g.12xlarge
+ - m6g.16xlarge
+ - m6gd.metal
+ - m6gd.medium
+ - m6gd.large
+ - m6gd.xlarge
+ - m6gd.2xlarge
+ - m6gd.4xlarge
+ - m6gd.8xlarge
+ - m6gd.12xlarge
+ - m6gd.16xlarge
+ - m6i.large
+ - m6i.xlarge
+ - m6i.2xlarge
+ - m6i.4xlarge
+ - m6i.8xlarge
+ - m6i.12xlarge
+ - m6i.16xlarge
+ - m6i.24xlarge
+ - m6i.32xlarge
+ - m6i.metal
+ - mac1.metal
+ - p2.xlarge
+ - p2.8xlarge
+ - p2.16xlarge
+ - p3.2xlarge
+ - p3.8xlarge
+ - p3.16xlarge
+ - p3dn.24xlarge
+ - p4d.24xlarge
+ - r3.large
+ - r3.xlarge
+ - r3.2xlarge
+ - r3.4xlarge
+ - r3.8xlarge
+ - r4.large
+ - r4.xlarge
+ - r4.2xlarge
+ - r4.4xlarge
+ - r4.8xlarge
+ - r4.16xlarge
+ - r5.large
+ - r5.xlarge
+ - r5.2xlarge
+ - r5.4xlarge
+ - r5.8xlarge
+ - r5.12xlarge
+ - r5.16xlarge
+ - r5.24xlarge
+ - r5.metal
+ - r5a.large
+ - r5a.xlarge
+ - r5a.2xlarge
+ - r5a.4xlarge
+ - r5a.8xlarge
+ - r5a.12xlarge
+ - r5a.16xlarge
+ - r5a.24xlarge
+ - r5ad.large
+ - r5ad.xlarge
+ - r5ad.2xlarge
+ - r5ad.4xlarge
+ - r5ad.8xlarge
+ - r5ad.12xlarge
+ - r5ad.16xlarge
+ - r5ad.24xlarge
+ - r5b.large
+ - r5b.xlarge
+ - r5b.2xlarge
+ - r5b.4xlarge
+ - r5b.8xlarge
+ - r5b.12xlarge
+ - r5b.16xlarge
+ - r5b.24xlarge
+ - r5b.metal
+ - r5d.large
+ - r5d.xlarge
+ - r5d.2xlarge
+ - r5d.4xlarge
+ - r5d.8xlarge
+ - r5d.12xlarge
+ - r5d.16xlarge
+ - r5d.24xlarge
+ - r5d.metal
+ - r5dn.large
+ - r5dn.xlarge
+ - r5dn.2xlarge
+ - r5dn.4xlarge
+ - r5dn.8xlarge
+ - r5dn.12xlarge
+ - r5dn.16xlarge
+ - r5dn.24xlarge
+ - r5dn.metal
+ - r5n.large
+ - r5n.xlarge
+ - r5n.2xlarge
+ - r5n.4xlarge
+ - r5n.8xlarge
+ - r5n.12xlarge
+ - r5n.16xlarge
+ - r5n.24xlarge
+ - r5n.metal
+ - r6g.medium
+ - r6g.large
+ - r6g.xlarge
+ - r6g.2xlarge
+ - r6g.4xlarge
+ - r6g.8xlarge
+ - r6g.12xlarge
+ - r6g.16xlarge
+ - r6g.metal
+ - r6gd.medium
+ - r6gd.large
+ - r6gd.xlarge
+ - r6gd.2xlarge
+ - r6gd.4xlarge
+ - r6gd.8xlarge
+ - r6gd.12xlarge
+ - r6gd.16xlarge
+ - r6gd.metal
+ - r6i.large
+ - r6i.xlarge
+ - r6i.2xlarge
+ - r6i.4xlarge
+ - r6i.8xlarge
+ - r6i.12xlarge
+ - r6i.16xlarge
+ - r6i.24xlarge
+ - r6i.32xlarge
+ - r6i.metal
+ - t1.micro
+ - t2.nano
+ - t2.micro
+ - t2.small
+ - t2.medium
+ - t2.large
+ - t2.xlarge
+ - t2.2xlarge
+ - t3.nano
+ - t3.micro
+ - t3.small
+ - t3.medium
+ - t3.large
+ - t3.xlarge
+ - t3.2xlarge
+ - t3a.nano
+ - t3a.micro
+ - t3a.small
+ - t3a.medium
+ - t3a.large
+ - t3a.xlarge
+ - t3a.2xlarge
+ - t4g.nano
+ - t4g.micro
+ - t4g.small
+ - t4g.medium
+ - t4g.large
+ - t4g.xlarge
+ - t4g.2xlarge
+ - u-6tb1.56xlarge
+ - u-6tb1.112xlarge
+ - u-9tb1.112xlarge
+ - u-12tb1.112xlarge
+ - u-6tb1.metal
+ - u-9tb1.metal
+ - u-12tb1.metal
+ - u-18tb1.metal
+ - u-24tb1.metal
+ - vt1.3xlarge
+ - vt1.6xlarge
+ - vt1.24xlarge
+ - x1.16xlarge
+ - x1.32xlarge
+ - x1e.xlarge
+ - x1e.2xlarge
+ - x1e.4xlarge
+ - x1e.8xlarge
+ - x1e.16xlarge
+ - x1e.32xlarge
+ - x2iezn.2xlarge
+ - x2iezn.4xlarge
+ - x2iezn.6xlarge
+ - x2iezn.8xlarge
+ - x2iezn.12xlarge
+ - x2iezn.metal
+ - x2gd.medium
+ - x2gd.large
+ - x2gd.xlarge
+ - x2gd.2xlarge
+ - x2gd.4xlarge
+ - x2gd.8xlarge
+ - x2gd.12xlarge
+ - x2gd.16xlarge
+ - x2gd.metal
+ - z1d.large
+ - z1d.xlarge
+ - z1d.2xlarge
+ - z1d.3xlarge
+ - z1d.6xlarge
+ - z1d.12xlarge
+ - z1d.metal
+ - x2idn.16xlarge
+ - x2idn.24xlarge
+ - x2idn.32xlarge
+ - x2iedn.xlarge
+ - x2iedn.2xlarge
+ - x2iedn.4xlarge
+ - x2iedn.8xlarge
+ - x2iedn.16xlarge
+ - x2iedn.24xlarge
+ - x2iedn.32xlarge
+ - c6a.large
+ - c6a.xlarge
+ - c6a.2xlarge
+ - c6a.4xlarge
+ - c6a.8xlarge
+ - c6a.12xlarge
+ - c6a.16xlarge
+ - c6a.24xlarge
+ - c6a.32xlarge
+ - c6a.48xlarge
+ - c6a.metal
+ - m6a.metal
+ - i4i.large
+ - i4i.xlarge
+ - i4i.2xlarge
+ - i4i.4xlarge
+ - i4i.8xlarge
+ - i4i.16xlarge
+ - i4i.32xlarge
+ DescribeInstancesResult:
+ type: object
+ example: {}
+ properties:
+ reservationSet:
+ allOf:
+ - $ref: '#/components/schemas/ReservationList'
+ - description: Information about the reservations.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeInternetGatewaysResult:
+ type: object
+ example:
+ InternetGateways:
+ - Attachments:
+ - State: available
+ VpcId: vpc-a01106c2
+ InternetGatewayId: igw-c0a643a9
+ Tags: []
+ properties:
+ internetGatewaySet:
+ allOf:
+ - $ref: '#/components/schemas/InternetGatewayList'
+ - description: Information about one or more internet gateways.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ InternetGatewayId:
+ type: string
+ DescribeIpamPoolsResult:
+ type: object
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ ipamPoolSet:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolSet'
+ - description: Information about the IPAM pools.
+ DescribeIpamScopesResult:
+ type: object
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ ipamScopeSet:
+ allOf:
+ - $ref: '#/components/schemas/IpamScopeSet'
+ - description: The scopes you want information on.
+ DescribeIpamsResult:
+ type: object
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ ipamSet:
+ allOf:
+ - $ref: '#/components/schemas/IpamSet'
+ - description: Information about the IPAMs.
+ DescribeIpv6PoolsResult:
+ type: object
+ properties:
+ ipv6PoolSet:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6PoolSet'
+ - description: Information about the IPv6 address pools.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ Ipv6PoolEc2Id:
+ type: string
+ DescribeKeyPairsResult:
+ type: object
+ example:
+ KeyPairs:
+ - KeyFingerprint: '1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f'
+ KeyName: my-key-pair
+ properties:
+ keySet:
+ allOf:
+ - $ref: '#/components/schemas/KeyPairList'
+ - description: Information about the key pairs.
+ KeyPairName:
+ type: string
+ KeyPairId:
+ type: string
+ DescribeLaunchTemplateVersionsResult:
+ type: object
+ example:
+ LaunchTemplateVersions:
+ - CreateTime: '2017-11-20T13:12:32.000Z'
+ CreatedBy: 'arn:aws:iam::123456789102:root'
+ DefaultVersion: false
+ LaunchTemplateData:
+ ImageId: ami-6057e21a
+ InstanceType: t2.medium
+ KeyName: kp-us-east
+ NetworkInterfaces:
+ - DeviceIndex: 0
+ Groups:
+ - sg-7c227019
+ SubnetId: subnet-1a2b3c4d
+ LaunchTemplateId: lt-068f72b72934aff71
+ LaunchTemplateName: Webservers
+ VersionNumber: 2
+ - CreateTime: '2017-11-20T12:52:33.000Z'
+ CreatedBy: 'arn:aws:iam::123456789102:root'
+ DefaultVersion: true
+ LaunchTemplateData:
+ ImageId: ami-aabbcc11
+ InstanceType: t2.medium
+ KeyName: kp-us-east
+ NetworkInterfaces:
+ - AssociatePublicIpAddress: true
+ DeleteOnTermination: false
+ DeviceIndex: 0
+ Groups:
+ - sg-7c227019
+ SubnetId: subnet-7b16de0c
+ UserData: ''
+ LaunchTemplateId: lt-068f72b72934aff71
+ LaunchTemplateName: Webservers
+ VersionNumber: 1
+ properties:
+ launchTemplateVersionSet:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateVersionSet'
+ - description: Information about the launch template versions.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeLaunchTemplatesResult:
+ type: object
+ example:
+ LaunchTemplates:
+ - CreateTime: '2018-01-16T04:32:57.000Z'
+ CreatedBy: 'arn:aws:iam::123456789012:root'
+ DefaultVersionNumber: 1
+ LatestVersionNumber: 1
+ LaunchTemplateId: lt-01238c059e3466abc
+ LaunchTemplateName: my-template
+ properties:
+ launchTemplates:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateSet'
+ - description: Information about the launch templates.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ LaunchTemplateId:
+ type: string
+ LaunchTemplateName:
+ type: string
+ pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
+ minLength: 3
+ maxLength: 128
+ DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult:
+ type: object
+ properties:
+ localGatewayRouteTableVirtualInterfaceGroupAssociationSet:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet'
+ - description: Information about the associations.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ LocalGatewayRouteTableVirtualInterfaceGroupAssociationId:
+ type: string
+ DescribeLocalGatewayRouteTableVpcAssociationsResult:
+ type: object
+ properties:
+ localGatewayRouteTableVpcAssociationSet:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationSet'
+ - description: Information about the associations.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ LocalGatewayRouteTableVpcAssociationId:
+ type: string
+ DescribeLocalGatewayRouteTablesResult:
+ type: object
+ properties:
+ localGatewayRouteTableSet:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableSet'
+ - description: Information about the local gateway route tables.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ LocalGatewayRoutetableId:
+ type: string
+ DescribeLocalGatewayVirtualInterfaceGroupsResult:
+ type: object
+ properties:
+ localGatewayVirtualInterfaceGroupSet:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupSet'
+ - description: The virtual interface groups.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ LocalGatewayVirtualInterfaceGroupId:
+ type: string
+ DescribeLocalGatewayVirtualInterfacesResult:
+ type: object
+ properties:
+ localGatewayVirtualInterfaceSet:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceSet'
+ - description: Information about the virtual interfaces.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ LocalGatewayVirtualInterfaceId:
+ type: string
+ DescribeLocalGatewaysResult:
+ type: object
+ properties:
+ localGatewaySet:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewaySet'
+ - description: Information about the local gateways.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ LocalGatewayId:
+ type: string
+ DescribeManagedPrefixListsResult:
+ type: object
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ prefixListSet:
+ allOf:
+ - $ref: '#/components/schemas/ManagedPrefixListSet'
+ - description: Information about the prefix lists.
+ DescribeMovingAddressesResult:
+ type: object
+ example:
+ MovingAddressStatuses:
+ - MoveStatus: MovingToVpc
+ PublicIp: 198.51.100.0
+ properties:
+ movingAddressStatusSet:
+ allOf:
+ - $ref: '#/components/schemas/MovingAddressStatusSet'
+ - description: The status for each Elastic IP address.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeNatGatewaysResult:
+ type: object
+ example:
+ NatGateways:
+ - CreateTime: '2015-12-01T12:26:55.983Z'
+ NatGatewayAddresses:
+ - AllocationId: eipalloc-89c620ec
+ NetworkInterfaceId: eni-9dec76cd
+ PrivateIp: 10.0.0.149
+ PublicIp: 198.11.222.333
+ NatGatewayId: nat-05dba92075d71c408
+ State: available
+ SubnetId: subnet-847e4dc2
+ VpcId: vpc-1a2b3c4d
+ properties:
+ natGatewaySet:
+ allOf:
+ - $ref: '#/components/schemas/NatGatewayList'
+ - description: Information about the NAT gateways.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ NatGatewayId:
+ type: string
+ DescribeNetworkAclsResult:
+ type: object
+ example:
+ NetworkAcls:
+ - Associations:
+ - NetworkAclAssociationId: aclassoc-66ea5f0b
+ NetworkAclId: acl-9aeb5ef7
+ SubnetId: subnet-65ea5f08
+ Entries:
+ - CidrBlock: 0.0.0.0/0
+ Egress: true
+ Protocol: '-1'
+ RuleAction: deny
+ RuleNumber: 32767
+ - CidrBlock: 0.0.0.0/0
+ Egress: false
+ Protocol: '-1'
+ RuleAction: deny
+ RuleNumber: 32767
+ IsDefault: false
+ NetworkAclId: acl-5fb85d36
+ Tags: []
+ VpcId: vpc-a01106c2
+ properties:
+ networkAclSet:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAclList'
+ - description: Information about one or more network ACLs.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ NetworkAclId:
+ type: string
+ DescribeNetworkInsightsAccessScopeAnalysesResult:
+ type: object
+ properties:
+ networkInsightsAccessScopeAnalysisSet:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisList'
+ - description: The Network Access Scope analyses.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ NetworkInsightsAccessScopeAnalysisId:
+ type: string
+ DescribeNetworkInsightsAccessScopesResult:
+ type: object
+ properties:
+ networkInsightsAccessScopeSet:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeList'
+ - description: The Network Access Scopes.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ NetworkInsightsAccessScopeId:
+ type: string
+ DescribeNetworkInsightsAnalysesResult:
+ type: object
+ properties:
+ networkInsightsAnalysisSet:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAnalysisList'
+ - description: Information about the network insights analyses.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ NetworkInsightsAnalysisId:
+ type: string
+ DescribeNetworkInsightsPathsResult:
+ type: object
+ properties:
+ networkInsightsPathSet:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsPathList'
+ - description: Information about the paths.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ NetworkInsightsPathId:
+ type: string
+ DescribeNetworkInterfaceAttributeResult:
+ type: object
+ example:
+ NetworkInterfaceId: eni-686ea200
+ SourceDestCheck:
+ Value: true
+ properties:
+ attachment:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceAttachment'
+ - description: The attachment (if any) of the network interface.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: The description of the network interface.
+ groupSet:
+ allOf:
+ - $ref: '#/components/schemas/GroupIdentifierList'
+ - description: The security groups associated with the network interface.
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network interface.
+ sourceDestCheck:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: Indicates whether source/destination checking is enabled.
+ description: Contains the output of DescribeNetworkInterfaceAttribute.
+ DescribeNetworkInterfacePermissionsResult:
+ type: object
+ properties:
+ networkInterfacePermissions:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfacePermissionList'
+ - description: The network interface permissions.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results.
+ description: Contains the output for DescribeNetworkInterfacePermissions.
+ NetworkInterfacePermissionId:
+ type: string
+ DescribeNetworkInterfacesResult:
+ type: object
+ example:
+ NetworkInterfaces:
+ - Association:
+ AssociationId: eipassoc-0fbb766a
+ IpOwnerId: '123456789012'
+ PublicDnsName: ec2-203-0-113-12.compute-1.amazonaws.com
+ PublicIp: 203.0.113.12
+ Attachment:
+ AttachTime: '2013-11-30T23:36:42.000Z'
+ AttachmentId: eni-attach-66c4350a
+ DeleteOnTermination: false
+ DeviceIndex: 1
+ InstanceId: i-1234567890abcdef0
+ InstanceOwnerId: '123456789012'
+ Status: attached
+ AvailabilityZone: us-east-1d
+ Description: my network interface
+ Groups:
+ - GroupId: sg-8637d3e3
+ GroupName: default
+ MacAddress: '02:2f:8f:b0:cf:75'
+ NetworkInterfaceId: eni-e5aa89a3
+ OwnerId: '123456789012'
+ PrivateDnsName: ip-10-0-1-17.ec2.internal
+ PrivateIpAddress: 10.0.1.17
+ PrivateIpAddresses:
+ - Association:
+ AssociationId: eipassoc-0fbb766a
+ IpOwnerId: '123456789012'
+ PublicDnsName: ec2-203-0-113-12.compute-1.amazonaws.com
+ PublicIp: 203.0.113.12
+ Primary: true
+ PrivateDnsName: ip-10-0-1-17.ec2.internal
+ PrivateIpAddress: 10.0.1.17
+ RequesterManaged: false
+ SourceDestCheck: true
+ Status: in-use
+ SubnetId: subnet-b61f49f0
+ TagSet: []
+ VpcId: vpc-a01106c2
+ properties:
+ networkInterfaceSet:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceList'
+ - description: Information about one or more network interfaces.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ description: Contains the output of DescribeNetworkInterfaces.
+ DescribePlacementGroupsResult:
+ type: object
+ properties:
+ placementGroupSet:
+ allOf:
+ - $ref: '#/components/schemas/PlacementGroupList'
+ - description: Information about the placement groups.
+ PlacementGroupName:
+ type: string
+ PlacementGroupId:
+ type: string
+ DescribePrefixListsResult:
+ type: object
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ prefixListSet:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListSet'
+ - description: All available prefix lists.
+ PrefixListResourceId:
+ type: string
+ DescribePrincipalIdFormatResult:
+ type: object
+ properties:
+ principalSet:
+ allOf:
+ - $ref: '#/components/schemas/PrincipalIdFormatList'
+ - description: Information about the ID format settings for the ARN.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribePublicIpv4PoolsResult:
+ type: object
+ properties:
+ publicIpv4PoolSet:
+ allOf:
+ - $ref: '#/components/schemas/PublicIpv4PoolSet'
+ - description: Information about the address pools.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ Ipv4PoolEc2Id:
+ type: string
+ DescribeRegionsResult:
+ type: object
+ example:
+ Regions:
+ - Endpoint: ec2.ap-south-1.amazonaws.com
+ RegionName: ap-south-1
+ - Endpoint: ec2.eu-west-1.amazonaws.com
+ RegionName: eu-west-1
+ - Endpoint: ec2.ap-southeast-1.amazonaws.com
+ RegionName: ap-southeast-1
+ - Endpoint: ec2.ap-southeast-2.amazonaws.com
+ RegionName: ap-southeast-2
+ - Endpoint: ec2.eu-central-1.amazonaws.com
+ RegionName: eu-central-1
+ - Endpoint: ec2.ap-northeast-2.amazonaws.com
+ RegionName: ap-northeast-2
+ - Endpoint: ec2.ap-northeast-1.amazonaws.com
+ RegionName: ap-northeast-1
+ - Endpoint: ec2.us-east-1.amazonaws.com
+ RegionName: us-east-1
+ - Endpoint: ec2.sa-east-1.amazonaws.com
+ RegionName: sa-east-1
+ - Endpoint: ec2.us-west-1.amazonaws.com
+ RegionName: us-west-1
+ - Endpoint: ec2.us-west-2.amazonaws.com
+ RegionName: us-west-2
+ properties:
+ regionInfo:
+ allOf:
+ - $ref: '#/components/schemas/RegionList'
+ - description: Information about the Regions.
+ DescribeReplaceRootVolumeTasksResult:
+ type: object
+ properties:
+ replaceRootVolumeTaskSet:
+ allOf:
+ - $ref: '#/components/schemas/ReplaceRootVolumeTasks'
+ - description: Information about the root volume replacement task.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ ReplaceRootVolumeTaskId:
+ type: string
+ DescribeReservedInstancesResult:
+ type: object
+ properties:
+ reservedInstancesSet:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesList'
+ - description: A list of Reserved Instances.
+ description: Contains the output for DescribeReservedInstances.
+ DescribeReservedInstancesListingsResult:
+ type: object
+ properties:
+ reservedInstancesListingsSet:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesListingList'
+ - description: Information about the Reserved Instance listing.
+ description: Contains the output of DescribeReservedInstancesListings.
+ DescribeReservedInstancesModificationsResult:
+ type: object
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ reservedInstancesModificationsSet:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesModificationList'
+ - description: The Reserved Instance modification information.
+ description: Contains the output of DescribeReservedInstancesModifications.
+ ReservedInstancesModificationId:
+ type: string
+ DescribeReservedInstancesOfferingsResult:
+ type: object
+ properties:
+ reservedInstancesOfferingsSet:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesOfferingList'
+ - description: A list of Reserved Instances offerings.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ description: Contains the output of DescribeReservedInstancesOfferings.
+ ReservedInstancesOfferingId:
+ type: string
+ DescribeRouteTablesResult:
+ type: object
+ example:
+ RouteTables:
+ - Associations:
+ - Main: true
+ RouteTableAssociationId: rtbassoc-d8ccddba
+ RouteTableId: rtb-1f382e7d
+ PropagatingVgws: []
+ RouteTableId: rtb-1f382e7d
+ Routes:
+ - DestinationCidrBlock: 10.0.0.0/16
+ GatewayId: local
+ State: active
+ Tags: []
+ VpcId: vpc-a01106c2
+ properties:
+ routeTableSet:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableList'
+ - description: Information about one or more route tables.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ description: Contains the output of DescribeRouteTables.
+ DescribeScheduledInstanceAvailabilityResult:
+ type: object
+ example:
+ ScheduledInstanceAvailabilitySet:
+ - AvailabilityZone: us-west-2b
+ AvailableInstanceCount: 20
+ FirstSlotStartTime: '2016-01-31T00:00:00Z'
+ HourlyPrice: '0.095'
+ InstanceType: c4.large
+ MaxTermDurationInDays: 366
+ MinTermDurationInDays: 366
+ NetworkPlatform: EC2-VPC
+ Platform: Linux/UNIX
+ PurchaseToken: eyJ2IjoiMSIsInMiOjEsImMiOi...
+ Recurrence:
+ Frequency: Weekly
+ Interval: 1
+ OccurrenceDaySet:
+ - 1
+ OccurrenceRelativeToEnd: false
+ SlotDurationInHours: 23
+ TotalScheduledInstanceHours: 1219
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token required to retrieve the next set of results. This value is null when there are no more results to return.
+ scheduledInstanceAvailabilitySet:
+ allOf:
+ - $ref: '#/components/schemas/ScheduledInstanceAvailabilitySet'
+ - description: Information about the available Scheduled Instances.
+ description: Contains the output of DescribeScheduledInstanceAvailability.
+ DateTime:
+ type: string
+ format: date-time
+ DescribeScheduledInstancesResult:
+ type: object
+ example:
+ ScheduledInstanceSet:
+ - AvailabilityZone: us-west-2b
+ CreateDate: '2016-01-25T21:43:38.612Z'
+ HourlyPrice: '0.095'
+ InstanceCount: 1
+ InstanceType: c4.large
+ NetworkPlatform: EC2-VPC
+ NextSlotStartTime: '2016-01-31T09:00:00Z'
+ Platform: Linux/UNIX
+ Recurrence:
+ Frequency: Weekly
+ Interval: 1
+ OccurrenceDaySet:
+ - 1
+ OccurrenceRelativeToEnd: false
+ OccurrenceUnit: ''
+ ScheduledInstanceId: sci-1234-1234-1234-1234-123456789012
+ SlotDurationInHours: 32
+ TermEndDate: '2017-01-31T09:00:00Z'
+ TermStartDate: '2016-01-31T09:00:00Z'
+ TotalScheduledInstanceHours: 1696
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token required to retrieve the next set of results. This value is null when there are no more results to return.
+ scheduledInstanceSet:
+ allOf:
+ - $ref: '#/components/schemas/ScheduledInstanceSet'
+ - description: Information about the Scheduled Instances.
+ description: Contains the output of DescribeScheduledInstances.
+ ScheduledInstanceId:
+ type: string
+ DescribeSecurityGroupReferencesResult:
+ type: object
+ example:
+ SecurityGroupReferenceSet:
+ - GroupId: sg-903004f8
+ ReferencingVpcId: vpc-1a2b3c4d
+ VpcPeeringConnectionId: pcx-b04deed9
+ properties:
+ securityGroupReferenceSet:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupReferences'
+ - description: Information about the VPCs with the referencing security groups.
+ DescribeSecurityGroupRulesResult:
+ type: object
+ properties:
+ securityGroupRuleSet:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRuleList'
+ - description: Information about security group rules.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
+ DescribeSecurityGroupsResult:
+ type: object
+ example: {}
+ properties:
+ securityGroupInfo:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupList'
+ - description: Information about the security groups.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ SecurityGroupName:
+ type: string
+ DescribeSnapshotAttributeResult:
+ type: object
+ example:
+ CreateVolumePermissions: []
+ SnapshotId: snap-066877671789bd71b
+ properties:
+ createVolumePermission:
+ allOf:
+ - $ref: '#/components/schemas/CreateVolumePermissionList'
+ - description: The users and groups that have the permissions for creating volumes from the snapshot.
+ productCodes:
+ allOf:
+ - $ref: '#/components/schemas/ProductCodeList'
+ - description: The product codes.
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the EBS snapshot.
+ DescribeSnapshotTierStatusResult:
+ type: object
+ properties:
+ snapshotTierStatusSet:
+ allOf:
+ - $ref: '#/components/schemas/snapshotTierStatusSet'
+ - description: Information about the snapshot's storage tier.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeSnapshotsResult:
+ type: object
+ example:
+ NextToken: ''
+ Snapshots:
+ - Description: This is my copied snapshot.
+ OwnerId: 012345678910
+ Progress: 87%
+ SnapshotId: snap-066877671789bd71b
+ StartTime: '2014-02-28T21:37:27.000Z'
+ State: pending
+ VolumeId: vol-1234567890abcdef0
+ VolumeSize: 8
+ properties:
+ snapshotSet:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotList'
+ - description: Information about the snapshots.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.'
+ SnapshotId:
+ type: string
+ DescribeSpotDatafeedSubscriptionResult:
+ type: object
+ example:
+ SpotDatafeedSubscription:
+ Bucket: my-s3-bucket
+ OwnerId: '123456789012'
+ Prefix: spotdata
+ State: Active
+ properties:
+ spotDatafeedSubscription:
+ allOf:
+ - $ref: '#/components/schemas/SpotDatafeedSubscription'
+ - description: The Spot Instance data feed subscription.
+ description: Contains the output of DescribeSpotDatafeedSubscription.
+ DescribeSpotFleetInstancesResponse:
+ type: object
+ example:
+ ActiveInstances:
+ - InstanceId: i-1234567890abcdef0
+ InstanceType: m3.medium
+ SpotInstanceRequestId: sir-08b93456
+ SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
+ properties:
+ activeInstanceSet:
+ allOf:
+ - $ref: '#/components/schemas/ActiveInstanceSet'
+ - description: The running instances. This list is refreshed periodically and might be out of date.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token required to retrieve the next set of results. This value is null when there are no more results to return.
+ spotFleetRequestId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Spot Fleet request.
+ description: Contains the output of DescribeSpotFleetInstances.
+ DescribeSpotFleetRequestHistoryResponse:
+ type: object
+ example:
+ HistoryRecords:
+ - EventInformation:
+ EventSubType: submitted
+ EventType: fleetRequestChange
+ Timestamp: '2015-05-26T23:17:20.697Z'
+ - EventInformation:
+ EventSubType: active
+ EventType: fleetRequestChange
+ Timestamp: '2015-05-26T23:17:20.873Z'
+ - EventInformation:
+ EventSubType: launched
+ InstanceId: i-1234567890abcdef0
+ EventType: instanceChange
+ Timestamp: '2015-05-26T23:21:21.712Z'
+ - EventInformation:
+ EventSubType: launched
+ InstanceId: i-1234567890abcdef1
+ EventType: instanceChange
+ Timestamp: '2015-05-26T23:21:21.816Z'
+ NextToken: CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=
+ SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
+ StartTime: '2015-05-26T00:00:00Z'
+ properties:
+ historyRecordSet:
+ allOf:
+ - $ref: '#/components/schemas/HistoryRecords'
+ - description: Information about the events in the history of the Spot Fleet request.
+ lastEvaluatedTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more results, this value is not present.
null when there are no more results to return.
+ spotFleetRequestId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Spot Fleet request.
+ startTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ description: Contains the output of DescribeSpotFleetRequestHistory.
+ DescribeSpotFleetRequestsResponse:
+ type: object
+ example:
+ SpotFleetRequestConfigs:
+ - SpotFleetRequestConfig:
+ IamFleetRole: 'arn:aws:iam::123456789012:role/my-spot-fleet-role'
+ LaunchSpecifications:
+ - EbsOptimized: false
+ ImageId: ami-1a2b3c4d
+ InstanceType: cc2.8xlarge
+ NetworkInterfaces:
+ - AssociatePublicIpAddress: true
+ DeleteOnTermination: false
+ DeviceIndex: 0
+ SecondaryPrivateIpAddressCount: 0
+ SubnetId: subnet-a61dafcf
+ - EbsOptimized: false
+ ImageId: ami-1a2b3c4d
+ InstanceType: r3.8xlarge
+ NetworkInterfaces:
+ - AssociatePublicIpAddress: true
+ DeleteOnTermination: false
+ DeviceIndex: 0
+ SecondaryPrivateIpAddressCount: 0
+ SubnetId: subnet-a61dafcf
+ SpotPrice: '0.05'
+ TargetCapacity: 20
+ SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
+ SpotFleetRequestState: active
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token required to retrieve the next set of results. This value is null when there are no more results to return.
+ spotFleetRequestConfigSet:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetRequestConfigSet'
+ - description: Information about the configuration of your Spot Fleet.
+ description: Contains the output of DescribeSpotFleetRequests.
+ DescribeSpotInstanceRequestsResult:
+ type: object
+ example:
+ SpotInstanceRequests:
+ - CreateTime: '2014-04-30T18:14:55.000Z'
+ InstanceId: i-1234567890abcdef0
+ LaunchSpecification:
+ BlockDeviceMappings:
+ - DeviceName: /dev/sda1
+ Ebs:
+ DeleteOnTermination: true
+ VolumeSize: 8
+ VolumeType: standard
+ EbsOptimized: false
+ ImageId: ami-7aba833f
+ InstanceType: m1.small
+ KeyName: my-key-pair
+ SecurityGroups:
+ - GroupId: sg-e38f24a7
+ GroupName: my-security-group
+ LaunchedAvailabilityZone: us-west-1b
+ ProductDescription: Linux/UNIX
+ SpotInstanceRequestId: sir-08b93456
+ SpotPrice: '0.010000'
+ State: active
+ Status:
+ Code: fulfilled
+ Message: Your Spot request is fulfilled.
+ UpdateTime: '2014-04-30T18:16:21.000Z'
+ Type: one-time
+ properties:
+ spotInstanceRequestSet:
+ allOf:
+ - $ref: '#/components/schemas/SpotInstanceRequestList'
+ - description: One or more Spot Instance requests.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next set of results. This value is null when there are no more results to return.
+ description: Contains the output of DescribeSpotInstanceRequests.
+ DescribeSpotPriceHistoryResult:
+ type: object
+ example:
+ SpotPriceHistory:
+ - AvailabilityZone: us-west-1a
+ InstanceType: m1.xlarge
+ ProductDescription: Linux/UNIX (Amazon VPC)
+ SpotPrice: '0.080000'
+ Timestamp: '2014-01-06T04:32:53.000Z'
+ - AvailabilityZone: us-west-1c
+ InstanceType: m1.xlarge
+ ProductDescription: Linux/UNIX (Amazon VPC)
+ SpotPrice: '0.080000'
+ Timestamp: '2014-01-05T11:28:26.000Z'
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return.
+ spotPriceHistorySet:
+ allOf:
+ - $ref: '#/components/schemas/SpotPriceHistoryList'
+ - description: The historical Spot prices.
+ description: Contains the output of DescribeSpotPriceHistory.
+ DescribeStaleSecurityGroupsResult:
+ type: object
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.'
+ staleSecurityGroupSet:
+ allOf:
+ - $ref: '#/components/schemas/StaleSecurityGroupSet'
+ - description: Information about the stale security groups.
+ DescribeStoreImageTasksResult:
+ type: object
+ properties:
+ storeImageTaskResultSet:
+ allOf:
+ - $ref: '#/components/schemas/StoreImageTaskResultSet'
+ - description: The information about the AMI store tasks.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeSubnetsResult:
+ type: object
+ example:
+ Subnets:
+ - AvailabilityZone: us-east-1c
+ AvailableIpAddressCount: 251
+ CidrBlock: 10.0.1.0/24
+ DefaultForAz: false
+ MapPublicIpOnLaunch: false
+ State: available
+ SubnetId: subnet-9d4a7b6c
+ VpcId: vpc-a01106c2
+ properties:
+ subnetSet:
+ allOf:
+ - $ref: '#/components/schemas/SubnetList'
+ - description: Information about one or more subnets.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeTagsResult:
+ type: object
+ example:
+ Tags:
+ - Key: Stack
+ ResourceId: i-1234567890abcdef8
+ ResourceType: instance
+ Value: test
+ - Key: Name
+ ResourceId: i-1234567890abcdef8
+ ResourceType: instance
+ Value: Beta Server
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagDescriptionList'
+ - description: The tags.
+ DescribeTrafficMirrorFiltersResult:
+ type: object
+ properties:
+ trafficMirrorFilterSet:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorFilterSet'
+ - description: Information about one or more Traffic Mirror filters.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. The value is null when there are no more results to return.
+ TrafficMirrorFilterId:
+ type: string
+ DescribeTrafficMirrorSessionsResult:
+ type: object
+ properties:
+ trafficMirrorSessionSet:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorSessionSet'
+ - description: 'Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. The value is null when there are no more results to return.
+ TrafficMirrorSessionId:
+ type: string
+ DescribeTrafficMirrorTargetsResult:
+ type: object
+ properties:
+ trafficMirrorTargetSet:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorTargetSet'
+ - description: Information about one or more Traffic Mirror targets.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. The value is null when there are no more results to return.
+ TrafficMirrorTargetId:
+ type: string
+ DescribeTransitGatewayAttachmentsResult:
+ type: object
+ properties:
+ transitGatewayAttachments:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentList'
+ - description: Information about the attachments.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ TransitGatewayAttachmentId:
+ type: string
+ DescribeTransitGatewayConnectPeersResult:
+ type: object
+ properties:
+ transitGatewayConnectPeerSet:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnectPeerList'
+ - description: Information about the Connect peers.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ TransitGatewayConnectPeerId:
+ type: string
+ DescribeTransitGatewayConnectsResult:
+ type: object
+ properties:
+ transitGatewayConnectSet:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnectList'
+ - description: Information about the Connect attachments.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeTransitGatewayMulticastDomainsResult:
+ type: object
+ properties:
+ transitGatewayMulticastDomains:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomainList'
+ - description: Information about the transit gateway multicast domains.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ TransitGatewayMulticastDomainId:
+ type: string
+ DescribeTransitGatewayPeeringAttachmentsResult:
+ type: object
+ properties:
+ transitGatewayPeeringAttachments:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPeeringAttachmentList'
+ - description: The transit gateway peering attachments.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeTransitGatewayRouteTablesResult:
+ type: object
+ properties:
+ transitGatewayRouteTables:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableList'
+ - description: Information about the transit gateway route tables.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ TransitGatewayRouteTableId:
+ type: string
+ DescribeTransitGatewayVpcAttachmentsResult:
+ type: object
+ properties:
+ transitGatewayVpcAttachments:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayVpcAttachmentList'
+ - description: Information about the VPC attachments.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeTransitGatewaysResult:
+ type: object
+ properties:
+ transitGatewaySet:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayList'
+ - description: Information about the transit gateways.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ TransitGatewayId:
+ type: string
+ DescribeTrunkInterfaceAssociationsResult:
+ type: object
+ properties:
+ interfaceAssociationSet:
+ allOf:
+ - $ref: '#/components/schemas/TrunkInterfaceAssociationList'
+ - description: Information about the trunk associations.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ TrunkInterfaceAssociationId:
+ type: string
+ DescribeVolumeAttributeResult:
+ type: object
+ example:
+ AutoEnableIO:
+ Value: false
+ VolumeId: vol-049df61146c4d7901
+ properties:
+ autoEnableIO:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: The state of autoEnableIO attribute.
+ productCodes:
+ allOf:
+ - $ref: '#/components/schemas/ProductCodeList'
+ - description: A list of product codes.
+ volumeId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the volume.
+ DescribeVolumeStatusResult:
+ type: object
+ example:
+ VolumeStatuses: []
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ volumeStatusSet:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusList'
+ - description: Information about the status of the volumes.
+ VolumeId:
+ type: string
+ DescribeVolumesResult:
+ type: object
+ example:
+ Volumes:
+ - Attachments:
+ - AttachTime: '2013-12-18T22:35:00.000Z'
+ DeleteOnTermination: true
+ Device: /dev/sda1
+ InstanceId: i-1234567890abcdef0
+ State: attached
+ VolumeId: vol-049df61146c4d7901
+ AvailabilityZone: us-east-1a
+ CreateTime: '2013-12-18T22:35:00.084Z'
+ Size: 8
+ SnapshotId: snap-1234567890abcdef0
+ State: in-use
+ VolumeId: vol-049df61146c4d7901
+ VolumeType: standard
+ properties:
+ volumeSet:
+ allOf:
+ - $ref: '#/components/schemas/VolumeList'
+ - description: Information about the volumes.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.'
+ DescribeVolumesModificationsResult:
+ type: object
+ properties:
+ volumeModificationSet:
+ allOf:
+ - $ref: '#/components/schemas/VolumeModificationList'
+ - description: Information about the volume modifications.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Token for pagination, null if there are no more results '
+ DescribeVpcAttributeResult:
+ type: object
+ example:
+ EnableDnsHostnames:
+ Value: true
+ VpcId: vpc-a01106c2
+ properties:
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ enableDnsHostnames:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: 'Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.'
+ enableDnsSupport:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: 'Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.'
+ DescribeVpcClassicLinkResult:
+ type: object
+ properties:
+ vpcSet:
+ allOf:
+ - $ref: '#/components/schemas/VpcClassicLinkList'
+ - description: The ClassicLink status of one or more VPCs.
+ VpcId:
+ type: string
+ DescribeVpcClassicLinkDnsSupportResult:
+ type: object
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportNextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ vpcs:
+ allOf:
+ - $ref: '#/components/schemas/ClassicLinkDnsSupportList'
+ - description: Information about the ClassicLink DNS support status of the VPCs.
+ DescribeVpcEndpointConnectionNotificationsResult:
+ type: object
+ properties:
+ connectionNotificationSet:
+ allOf:
+ - $ref: '#/components/schemas/ConnectionNotificationSet'
+ - description: One or more notifications.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeVpcEndpointConnectionsResult:
+ type: object
+ properties:
+ vpcEndpointConnectionSet:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointConnectionSet'
+ - description: Information about one or more VPC endpoint connections.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeVpcEndpointServiceConfigurationsResult:
+ type: object
+ properties:
+ serviceConfigurationSet:
+ allOf:
+ - $ref: '#/components/schemas/ServiceConfigurationSet'
+ - description: Information about one or more services.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeVpcEndpointServicePermissionsResult:
+ type: object
+ properties:
+ allowedPrincipals:
+ allOf:
+ - $ref: '#/components/schemas/AllowedPrincipalSet'
+ - description: Information about one or more allowed principals.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeVpcEndpointServicesResult:
+ type: object
+ properties:
+ serviceNameSet:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: A list of supported services.
+ serviceDetailSet:
+ allOf:
+ - $ref: '#/components/schemas/ServiceDetailSet'
+ - description: Information about the service.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.'
+ description: Contains the output of DescribeVpcEndpointServices.
+ DescribeVpcEndpointsResult:
+ type: object
+ properties:
+ vpcEndpointSet:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointSet'
+ - description: Information about the endpoints.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.'
+ description: Contains the output of DescribeVpcEndpoints.
+ DescribeVpcPeeringConnectionsResult:
+ type: object
+ properties:
+ vpcPeeringConnectionSet:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnectionList'
+ - description: Information about the VPC peering connections.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ VpcPeeringConnectionId:
+ type: string
+ DescribeVpcsResult:
+ type: object
+ example:
+ Vpcs:
+ - CidrBlock: 10.0.0.0/16
+ DhcpOptionsId: dopt-7a8b9c2d
+ InstanceTenancy: default
+ IsDefault: false
+ State: available
+ Tags:
+ - Key: Name
+ Value: MyVPC
+ VpcId: vpc-a01106c2
+ properties:
+ vpcSet:
+ allOf:
+ - $ref: '#/components/schemas/VpcList'
+ - description: Information about one or more VPCs.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ DescribeVpnConnectionsResult:
+ type: object
+ properties:
+ vpnConnectionSet:
+ allOf:
+ - $ref: '#/components/schemas/VpnConnectionList'
+ - description: Information about one or more VPN connections.
+ description: Contains the output of DescribeVpnConnections.
+ VpnConnectionId:
+ type: string
+ DescribeVpnGatewaysResult:
+ type: object
+ properties:
+ vpnGatewaySet:
+ allOf:
+ - $ref: '#/components/schemas/VpnGatewayList'
+ - description: Information about one or more virtual private gateways.
+ description: Contains the output of DescribeVpnGateways.
+ VpnGatewayId:
+ type: string
+ DetachClassicLinkVpcResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ DisableEbsEncryptionByDefaultResult:
+ type: object
+ properties:
+ ebsEncryptionByDefault:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The updated status of encryption by default.
+ DisableFastLaunchResult:
+ type: object
+ properties:
+ imageId:
+ allOf:
+ - $ref: '#/components/schemas/ImageId'
+ - description: The ID of the image for which faster-launching has been turned off.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchResourceType'
+ - description: 'The pre-provisioning resource type that must be cleaned after turning off faster launching for the Windows AMI. Supported values include: snapshot.'
+ snapshotConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchSnapshotConfigurationResponse'
+ - description: Parameters that were used for faster launching for the Windows AMI before faster launching was turned off. This informs the clean-up process.
+ launchTemplate:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationResponse'
+ - description: The launch template that was used to launch Windows instances from pre-provisioned snapshots.
+ maxParallelLaunches:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The maximum number of parallel instances to launch for creating resources.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The owner of the Windows AMI for which faster launching was turned off.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchStateCode'
+ - description: The current state of faster launching for the specified Windows AMI.
+ stateTransitionReason:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The reason that the state changed for faster launching for the Windows AMI.
+ stateTransitionTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time that the state changed for faster launching for the Windows AMI.
+ DisableFastSnapshotRestoresResult:
+ type: object
+ properties:
+ successful:
+ allOf:
+ - $ref: '#/components/schemas/DisableFastSnapshotRestoreSuccessSet'
+ - description: Information about the snapshots for which fast snapshot restores were successfully disabled.
+ unsuccessful:
+ allOf:
+ - $ref: '#/components/schemas/DisableFastSnapshotRestoreErrorSet'
+ - description: Information about the snapshots for which fast snapshot restores could not be disabled.
+ DisableImageDeprecationResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ DisableIpamOrganizationAdminAccountResult:
+ type: object
+ properties:
+ success:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The result of disabling the IPAM account.
+ DisableSerialConsoleAccessResult:
+ type: object
+ properties:
+ serialConsoleAccessEnabled:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.'
+ DisableTransitGatewayRouteTablePropagationResult:
+ type: object
+ properties:
+ propagation:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPropagation'
+ - description: Information about route propagation.
+ DisableVpcClassicLinkResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ DisableVpcClassicLinkDnsSupportResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ DisassociateClientVpnTargetNetworkResult:
+ type: object
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the target network association.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/AssociationStatus'
+ - description: The current state of the target network association.
+ DisassociateEnclaveCertificateIamRoleResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ DisassociateIamInstanceProfileResult:
+ type: object
+ example:
+ IamInstanceProfileAssociation:
+ AssociationId: iip-assoc-05020b59952902f5f
+ IamInstanceProfile:
+ Arn: 'arn:aws:iam::123456789012:instance-profile/admin-role'
+ Id: AIPAI5IVIHMFFYY2DKV5Y
+ InstanceId: i-123456789abcde123
+ State: disassociating
+ properties:
+ iamInstanceProfileAssociation:
+ allOf:
+ - $ref: '#/components/schemas/IamInstanceProfileAssociation'
+ - description: Information about the IAM instance profile association.
+ DisassociateInstanceEventWindowResult:
+ type: object
+ properties:
+ instanceEventWindow:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindow'
+ - description: Information about the event window.
+ DisassociateSubnetCidrBlockResult:
+ type: object
+ properties:
+ ipv6CidrBlockAssociation:
+ allOf:
+ - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation'
+ - description: Information about the IPv6 CIDR block association.
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the subnet.
+ DisassociateTransitGatewayMulticastDomainResult:
+ type: object
+ properties:
+ associations:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
+ - description: Information about the association.
+ DisassociateTransitGatewayRouteTableResult:
+ type: object
+ properties:
+ association:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAssociation'
+ - description: Information about the association.
+ DisassociateTrunkInterfaceResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.'
+ DisassociateVpcCidrBlockResult:
+ type: object
+ properties:
+ ipv6CidrBlockAssociation:
+ allOf:
+ - $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation'
+ - description: Information about the IPv6 CIDR block association.
+ cidrBlockAssociation:
+ allOf:
+ - $ref: '#/components/schemas/VpcCidrBlockAssociation'
+ - description: Information about the IPv4 CIDR block association.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ EnableEbsEncryptionByDefaultResult:
+ type: object
+ properties:
+ ebsEncryptionByDefault:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The updated status of encryption by default.
+ EnableFastLaunchResult:
+ type: object
+ properties:
+ imageId:
+ allOf:
+ - $ref: '#/components/schemas/ImageId'
+ - description: The image ID that identifies the Windows AMI for which faster launching was enabled.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchResourceType'
+ - description: The type of resource that was defined for pre-provisioning the Windows AMI for faster launching.
+ snapshotConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchSnapshotConfigurationResponse'
+ - description: The configuration settings that were defined for creating and managing the pre-provisioned snapshots for faster launching of the Windows AMI. This property is returned when the associated resourceType is snapshot.
+ launchTemplate:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationResponse'
+ - description: The launch template that is used when launching Windows instances from pre-provisioned snapshots.
+ maxParallelLaunches:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The maximum number of parallel instances to launch for creating resources.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The owner ID for the Windows AMI for which faster launching was enabled.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchStateCode'
+ - description: The current state of faster launching for the specified Windows AMI.
+ stateTransitionReason:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The reason that the state changed for faster launching for the Windows AMI.
+ stateTransitionTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time that the state changed for faster launching for the Windows AMI.
+ EnableFastSnapshotRestoresResult:
+ type: object
+ properties:
+ successful:
+ allOf:
+ - $ref: '#/components/schemas/EnableFastSnapshotRestoreSuccessSet'
+ - description: Information about the snapshots for which fast snapshot restores were successfully enabled.
+ unsuccessful:
+ allOf:
+ - $ref: '#/components/schemas/EnableFastSnapshotRestoreErrorSet'
+ - description: Information about the snapshots for which fast snapshot restores could not be enabled.
+ EnableImageDeprecationResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ EnableIpamOrganizationAdminAccountResult:
+ type: object
+ properties:
+ success:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The result of enabling the IPAM account.
+ EnableSerialConsoleAccessResult:
+ type: object
+ properties:
+ serialConsoleAccessEnabled:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.'
+ EnableTransitGatewayRouteTablePropagationResult:
+ type: object
+ properties:
+ propagation:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPropagation'
+ - description: Information about route propagation.
+ EnableVpcClassicLinkResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ EnableVpcClassicLinkDnsSupportResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ ExportClientVpnClientCertificateRevocationListResult:
+ type: object
+ properties:
+ certificateRevocationList:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Information about the client certificate revocation list.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ClientCertificateRevocationListStatus'
+ - description: The current state of the client certificate revocation list.
+ ExportClientVpnClientConfigurationResult:
+ type: object
+ properties:
+ clientConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The contents of the Client VPN endpoint configuration file.
+ ExportImageResult:
+ type: object
+ properties:
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the image being exported.
+ diskImageFormat:
+ allOf:
+ - $ref: '#/components/schemas/DiskImageFormat'
+ - description: The disk image format for the exported image.
+ exportImageTaskId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the export image task.
+ imageId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the image.
+ roleName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
+ progress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The percent complete of the export image task.
+ s3ExportLocation:
+ allOf:
+ - $ref: '#/components/schemas/ExportTaskS3Location'
+ - description: Information about the destination Amazon S3 bucket.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The status of the export image task. The possible values are active, completed, deleting, and deleted.'
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The status message for the export image task.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the export image task.
+ ExportTransitGatewayRoutesResult:
+ type: object
+ properties:
+ s3Location:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.'
+ GetAssociatedEnclaveCertificateIamRolesResult:
+ type: object
+ properties:
+ associatedRoleSet:
+ allOf:
+ - $ref: '#/components/schemas/AssociatedRolesList'
+ - description: Information about the associated IAM roles.
+ GetAssociatedIpv6PoolCidrsResult:
+ type: object
+ properties:
+ ipv6CidrAssociationSet:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6CidrAssociationSet'
+ - description: Information about the IPv6 CIDR block associations.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ GetCapacityReservationUsageResult:
+ type: object
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ capacityReservationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Capacity Reservation.
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The type of instance for which the Capacity Reservation reserves capacity.
+ totalInstanceCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of instances for which the Capacity Reservation reserves capacity.
+ availableInstanceCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationState'
+ - description: 'The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active - The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
null when there are no more results to return.
+ capacityReservationGroupSet:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationGroupSet'
+ - description: Information about the resource groups to which the Capacity Reservation has been added.
+ GetHostReservationPurchasePreviewResult:
+ type: object
+ properties:
+ currencyCode:
+ allOf:
+ - $ref: '#/components/schemas/CurrencyCodeValues'
+ - description: 'The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.'
+ purchase:
+ allOf:
+ - $ref: '#/components/schemas/PurchaseSet'
+ - description: The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
+ totalHourlyPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The potential total hourly price of the reservation per hour.
+ totalUpfrontPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The potential total upfront price. This is billed immediately.
+ GetInstanceTypesFromInstanceRequirementsResult:
+ type: object
+ properties:
+ instanceTypeSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTypeInfoFromInstanceRequirementsSet'
+ - description: The instance types with the specified instance attributes.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next set of results.
+ ArchitectureType:
+ type: string
+ enum:
+ - i386
+ - x86_64
+ - arm64
+ - x86_64_mac
+ VirtualizationType:
+ type: string
+ enum:
+ - hvm
+ - paravirtual
+ MemoryMiBRequest:
+ type: object
+ required:
+ - Min
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.'
+ description: 'The minimum and maximum amount of memory, in MiB.'
+ MemoryGiBPerVCpuRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: 'The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.'
+ description: 'The minimum and maximum amount of memory per vCPU, in GiB.'
+ ExcludedInstanceTypeSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ExcludedInstanceType'
+ - xml:
+ name: item
+ minItems: 0
+ maxItems: 400
+ LocalStorage:
+ type: string
+ enum:
+ - included
+ - required
+ - excluded
+ BaselineEbsBandwidthMbpsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.'
+ description: 'The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.'
+ AcceleratorCountRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0.'
+ description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set Max to 0.'
+ AcceleratorManufacturerSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AcceleratorManufacturer'
+ - xml:
+ name: item
+ AcceleratorTotalMemoryMiBRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.'
+ description: 'The minimum and maximum amount of total accelerator memory, in MiB.'
+ GetInstanceUefiDataResult:
+ type: object
+ properties:
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of the instance from which to retrieve the UEFI data.
+ uefiData:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Base64 representation of the non-volatile UEFI variable store.
+ GetIpamAddressHistoryResult:
+ type: object
+ properties:
+ historyRecordSet:
+ allOf:
+ - $ref: '#/components/schemas/IpamAddressHistoryRecordSet'
+ - description: 'A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ GetIpamPoolAllocationsResult:
+ type: object
+ properties:
+ ipamPoolAllocationSet:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolAllocationSet'
+ - description: The IPAM pool allocations you want information on.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ GetIpamPoolCidrsResult:
+ type: object
+ properties:
+ ipamPoolCidrSet:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolCidrSet'
+ - description: Information about the CIDRs provisioned to an IPAM pool.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ GetIpamResourceCidrsResult:
+ type: object
+ properties:
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ ipamResourceCidrSet:
+ allOf:
+ - $ref: '#/components/schemas/IpamResourceCidrSet'
+ - description: The resource CIDRs.
+ GetLaunchTemplateDataResult:
+ type: object
+ example:
+ LaunchTemplateData:
+ BlockDeviceMappings:
+ - DeviceName: /dev/xvda
+ Ebs:
+ DeleteOnTermination: true
+ Encrypted: false
+ Iops: 100
+ SnapshotId: snap-02594938353ef77d3
+ VolumeSize: 8
+ VolumeType: gp2
+ EbsOptimized: false
+ ImageId: ami-32cf7b4a
+ InstanceType: t2.medium
+ KeyName: my-key-pair
+ Monitoring:
+ Enabled: false
+ NetworkInterfaces:
+ - AssociatePublicIpAddress: false
+ DeleteOnTermination: true
+ Description: ''
+ DeviceIndex: 0
+ Groups:
+ - sg-d14e1bb4
+ Ipv6Addresses: []
+ NetworkInterfaceId: eni-4338b5a9
+ PrivateIpAddress: 10.0.3.233
+ PrivateIpAddresses:
+ - Primary: true
+ PrivateIpAddress: 10.0.3.233
+ SubnetId: subnet-5264e837
+ Placement:
+ AvailabilityZone: us-east-2b
+ GroupName: ''
+ Tenancy: default
+ properties:
+ launchTemplateData:
+ allOf:
+ - $ref: '#/components/schemas/ResponseLaunchTemplateData'
+ - description: The instance data.
+ GetManagedPrefixListAssociationsResult:
+ type: object
+ properties:
+ prefixListAssociationSet:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListAssociationSet'
+ - description: Information about the associations.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ GetManagedPrefixListEntriesResult:
+ type: object
+ properties:
+ entrySet:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListEntrySet'
+ - description: Information about the prefix list entries.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ GetNetworkInsightsAccessScopeAnalysisFindingsResult:
+ type: object
+ properties:
+ networkInsightsAccessScopeAnalysisId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
+ - description: The ID of the Network Access Scope analysis.
+ analysisStatus:
+ allOf:
+ - $ref: '#/components/schemas/AnalysisStatus'
+ - description: The status of Network Access Scope Analysis.
+ analysisFindingSet:
+ allOf:
+ - $ref: '#/components/schemas/AccessScopeAnalysisFindingList'
+ - description: The findings associated with Network Access Scope Analysis.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ GetNetworkInsightsAccessScopeContentResult:
+ type: object
+ properties:
+ networkInsightsAccessScopeContent:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeContent'
+ - description: The Network Access Scope content.
+ GetPasswordDataResult:
+ type: object
+ properties:
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Windows instance.
+ passwordData:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The password of the instance. Returns an empty string if the password is not available.
+ timestamp:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time the data was last updated.
+ GetReservedInstancesExchangeQuoteResult:
+ type: object
+ properties:
+ currencyCode:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The currency of the transaction.
+ isValidExchange:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If true, the exchange is valid. If false, the exchange cannot be completed.'
+ outputReservedInstancesWillExpireAt:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The new end date of the reservation term.
+ paymentDue:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The total true upfront charge for the exchange.
+ reservedInstanceValueRollup:
+ allOf:
+ - $ref: '#/components/schemas/ReservationValue'
+ - description: The cost associated with the Reserved Instance.
+ reservedInstanceValueSet:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstanceReservationValueSet'
+ - description: The configuration of your Convertible Reserved Instances.
+ targetConfigurationValueRollup:
+ allOf:
+ - $ref: '#/components/schemas/ReservationValue'
+ - description: The cost associated with the Reserved Instance.
+ targetConfigurationValueSet:
+ allOf:
+ - $ref: '#/components/schemas/TargetReservationValueSet'
+ - description: The values of the target Convertible Reserved Instances.
+ validationFailureReason:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Describes the reason why the exchange cannot be completed.
+ description: Contains the output of GetReservedInstancesExchangeQuote.
+ GetSerialConsoleAccessStatusResult:
+ type: object
+ properties:
+ serialConsoleAccessEnabled:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.'
+ GetSpotPlacementScoresResult:
+ type: object
+ properties:
+ spotPlacementScoreSet:
+ allOf:
+ - $ref: '#/components/schemas/SpotPlacementScores'
+ - description: 'The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale from 1 to 10. Each score
reflects how likely it is that each Region or Availability Zone will succeed at fulfilling the specified target capacity
at the time of the Spot placement score request. A score of 10 means that your Spot capacity request is highly likely to succeed in that Region or Availability Zone.
If you request a Spot placement score for Regions, a high score assumes that your fleet request will be configured to use all Availability Zones and the capacity-optimized allocation strategy. If you request a Spot placement score for Availability Zones, a high score assumes that your fleet request will be configured to use a single Availability Zone and the capacity-optimized allocation strategy.
Different Regions or Availability Zones might return the same score.
The Spot placement score serves as a recommendation only. No score guarantees that your Spot request will be fully or partially fulfilled.
The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
' + ExcludedInstanceType: + allOf: + - $ref: '#/components/schemas/ExcludedInstanceTypeSet' + - description: 'The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
Default: No excluded instance types
' + InstanceGeneration: + allOf: + - $ref: '#/components/schemas/LocalStorage' + - description: 'Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
To include instance types with instance store volumes, specify included.
To require only instance types with instance store volumes, specify required.
To exclude instance types with instance store volumes, specify excluded.
Default: included
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
' + AcceleratorType: + allOf: + - $ref: '#/components/schemas/AcceleratorCountRequest' + - description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
' + AcceleratorManufacturer: + allOf: + - $ref: '#/components/schemas/AcceleratorManufacturerSet' + - description: 'Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
' + AcceleratorName: + allOf: + - $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest' + - description: 'The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
' + description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
You must specify VCpuCount and MemoryMiB. All other parameters are optional. Any unspecified optional parameter is set to its default.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
' + GetSubnetCidrReservationsResult: + type: object + properties: + subnetIpv4CidrReservationSet: + allOf: + - $ref: '#/components/schemas/SubnetCidrReservationList' + - description: Information about the IPv4 subnet CIDR reservations. + subnetIpv6CidrReservationSet: + allOf: + - $ref: '#/components/schemas/SubnetCidrReservationList' + - description: Information about the IPv6 subnet CIDR reservations. + nextToken: + allOf: + - $ref: '#/components/schemas/String' + - description: The token to use to retrieve the next page of results. This value isnull when there are no more results to return.
+ GetTransitGatewayAttachmentPropagationsResult:
+ type: object
+ properties:
+ transitGatewayAttachmentPropagations:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentPropagationList'
+ - description: Information about the propagation route tables.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ GetTransitGatewayMulticastDomainAssociationsResult:
+ type: object
+ properties:
+ multicastDomainAssociations:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociationList'
+ - description: Information about the multicast domain associations.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ GetTransitGatewayPrefixListReferencesResult:
+ type: object
+ properties:
+ transitGatewayPrefixListReferenceSet:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPrefixListReferenceSet'
+ - description: Information about the prefix list references.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ GetTransitGatewayRouteTableAssociationsResult:
+ type: object
+ properties:
+ associations:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableAssociationList'
+ - description: Information about the associations.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ GetTransitGatewayRouteTablePropagationsResult:
+ type: object
+ properties:
+ transitGatewayRouteTablePropagations:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTablePropagationList'
+ - description: Information about the route table propagations.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ GetVpnConnectionDeviceSampleConfigurationResult:
+ type: object
+ properties:
+ vpnConnectionDeviceSampleConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/VpnConnectionDeviceSampleConfiguration'
+ - description: Sample configuration file for the specified customer gateway device.
+ GetVpnConnectionDeviceTypesResult:
+ type: object
+ properties:
+ vpnConnectionDeviceTypeSet:
+ allOf:
+ - $ref: '#/components/schemas/VpnConnectionDeviceTypeList'
+ - description: List of customer gateway devices that have a sample configuration file available for use.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: 'The NextToken value to include in a future GetVpnConnectionDeviceTypes request. When the results of a GetVpnConnectionDeviceTypes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.'
+ ImportClientVpnClientCertificateRevocationListResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ ImportImageResult:
+ type: object
+ properties:
+ architecture:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The architecture of the virtual machine.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the import task.
+ encrypted:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the AMI is encrypted.
+ hypervisor:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The target hypervisor of the import task.
+ imageId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Machine Image (AMI) created by the import task.
+ importTaskId:
+ allOf:
+ - $ref: '#/components/schemas/ImportImageTaskId'
+ - description: The task ID of the import image task.
+ kmsKeyId:
+ allOf:
+ - $ref: '#/components/schemas/KmsKeyId'
+ - description: The identifier for the symmetric KMS key that was used to create the encrypted AMI.
+ licenseType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The license type of the virtual machine.
+ platform:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The operating system of the virtual machine.
+ progress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The progress of the task.
+ snapshotDetailSet:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotDetailList'
+ - description: Information about the snapshots.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A brief status of the task.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A detailed status message of the import task.
+ licenseSpecifications:
+ allOf:
+ - $ref: '#/components/schemas/ImportImageLicenseSpecificationListResponse'
+ - description: The ARNs of the license configurations.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the import image task.
+ usageOperation:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The usage operation value.
+ ImageDiskContainer:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/UserBucket'
+ - description: The S3 bucket for the disk image.
+ description: Describes the disk container object for an import image task.
+ ImportImageLicenseConfigurationRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ARN of a license configuration.
+ description: The request information of license configurations.
+ ImportInstanceResult:
+ type: object
+ properties:
+ conversionTask:
+ allOf:
+ - $ref: '#/components/schemas/ConversionTask'
+ - description: Information about the conversion task.
+ DiskImage:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VolumeDetail'
+ - description: Information about the volume.
+ description: Describes a disk image.
+ ArchitectureValues:
+ type: string
+ enum:
+ - i386
+ - x86_64
+ - arm64
+ - x86_64_mac
+ SecurityGroupStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupName'
+ - xml:
+ name: SecurityGroup
+ ShutdownBehavior:
+ type: string
+ enum:
+ - stop
+ - terminate
+ Placement:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported by CreateFleet.
' + affinity: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
' + groupName: + allOf: + - $ref: '#/components/schemas/PlacementGroupName' + - description: The name of the placement group the instance is in. + partitionNumber: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.
This parameter is not supported by CreateFleet.
' + hostId: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
' + tenancy: + allOf: + - $ref: '#/components/schemas/Tenancy' + - description: 'The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
T3 instances that use the unlimited CPU credit option do not support host tenancy.
Reserved for future use.
This parameter is not supported by CreateFleet.
' + hostResourceGroupArn: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.
This parameter is not supported by CreateFleet.
' + description: Describes the placement of an instance. + UserData: + type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The user data. If you are using an Amazon Web Services SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.' + description: Describes the user data for an instance. + ImportKeyPairResult: + type: object + properties: + keyFingerprint: + allOf: + - $ref: '#/components/schemas/String' + - description: 'For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
null when there are no more results to return.
+ ListSnapshotsInRecycleBinResult:
+ type: object
+ properties:
+ snapshotSet:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotRecycleBinInfoList'
+ - description: Information about the snapshots.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ ModifyAddressAttributeResult:
+ type: object
+ properties:
+ address:
+ allOf:
+ - $ref: '#/components/schemas/AddressAttribute'
+ - description: Information about the Elastic IP address.
+ ModifyAvailabilityZoneGroupResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Is true if the request succeeds, and an error otherwise.'
+ ModifyCapacityReservationResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ ModifyCapacityReservationFleetResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ ModifyClientVpnEndpointResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ ModifyDefaultCreditSpecificationResult:
+ type: object
+ properties:
+ instanceFamilyCreditSpecification:
+ allOf:
+ - $ref: '#/components/schemas/InstanceFamilyCreditSpecification'
+ - description: The default credit option for CPU usage of the instance family.
+ ModifyEbsDefaultKmsKeyIdResult:
+ type: object
+ properties:
+ kmsKeyId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
+ ModifyFleetResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.'
+ ModifyFpgaImageAttributeResult:
+ type: object
+ properties:
+ fpgaImageAttribute:
+ allOf:
+ - $ref: '#/components/schemas/FpgaImageAttribute'
+ - description: Information about the attribute.
+ LoadPermissionListRequest:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LoadPermissionRequest'
+ - xml:
+ name: item
+ ModifyHostsResult:
+ type: object
+ properties:
+ successful:
+ allOf:
+ - $ref: '#/components/schemas/ResponseHostIdList'
+ - description: The IDs of the Dedicated Hosts that were successfully modified.
+ unsuccessful:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulItemList'
+ - description: The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.
+ LaunchPermissionList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LaunchPermission'
+ - xml:
+ name: item
+ InstanceBlockDeviceMappingSpecification:
+ type: object
+ properties:
+ deviceName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The device name (for example, /dev/sdh or xvdh).'
+ ebs:
+ allOf:
+ - $ref: '#/components/schemas/EbsInstanceBlockDeviceSpecification'
+ - description: Parameters used to automatically set up EBS volumes when the instance is launched.
+ noDevice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: suppress the specified device included in the block device mapping.
+ virtualName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The virtual device name.
+ description: Describes a block device mapping entry.
+ Blob:
+ type: string
+ ModifyInstanceCapacityReservationAttributesResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ CapacityReservationTarget:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ARN of the Capacity Reservation resource group in which to run the instance.
+ description: Describes a target Capacity Reservation or Capacity Reservation group.
+ ModifyInstanceCreditSpecificationResult:
+ type: object
+ properties:
+ successfulInstanceCreditSpecificationSet:
+ allOf:
+ - $ref: '#/components/schemas/SuccessfulInstanceCreditSpecificationSet'
+ - description: Information about the instances whose credit option for CPU usage was successfully modified.
+ unsuccessfulInstanceCreditSpecificationSet:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationSet'
+ - description: Information about the instances whose credit option for CPU usage was not modified.
+ InstanceCreditSpecificationRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The credit option for CPU usage of the instance. Valid values are standard and unlimited.
T3 instances with host tenancy do not support the unlimited CPU credit option.
true if the request succeeds, and an error otherwise.'
+ ModifyIpamResult:
+ type: object
+ properties:
+ ipam:
+ allOf:
+ - $ref: '#/components/schemas/Ipam'
+ - description: The results of the modification.
+ RemoveIpamOperatingRegion:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the operating Region you want to remove.
+ description: 'Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide
' + ModifyIpamPoolResult: + type: object + properties: + ipamPool: + allOf: + - $ref: '#/components/schemas/IpamPool' + - description: The results of the modification. + ModifyIpamResourceCidrResult: + type: object + properties: + ipamResourceCidr: + $ref: '#/components/schemas/IpamResourceCidr' + ModifyIpamScopeResult: + type: object + properties: + ipamScope: + allOf: + - $ref: '#/components/schemas/IpamScope' + - description: The results of the modification. + ModifyLaunchTemplateResult: + type: object + example: + LaunchTemplate: + CreateTime: '2017-12-01T13:35:46.000Z' + CreatedBy: 'arn:aws:iam::123456789012:root' + DefaultVersionNumber: 2 + LatestVersionNumber: 2 + LaunchTemplateId: lt-0abcd290751193123 + LaunchTemplateName: WebServers + properties: + launchTemplate: + allOf: + - $ref: '#/components/schemas/LaunchTemplate' + - description: Information about the launch template. + ModifyManagedPrefixListResult: + type: object + properties: + prefixList: + allOf: + - $ref: '#/components/schemas/ManagedPrefixList' + - description: Information about the prefix list. + RemovePrefixListEntry: + type: object + required: + - Cidr + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The CIDR block. + description: An entry for a prefix list. + NetworkInterfaceAttachmentId: + type: string + ModifyPrivateDnsNameOptionsResult: + type: object + properties: + return: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Returnstrue if the request succeeds; otherwise, it returns an error.'
+ ModifyReservedInstancesResult:
+ type: object
+ properties:
+ reservedInstancesModificationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID for the modification.
+ description: Contains the output of ModifyReservedInstances.
+ ReservedInstancesConfiguration:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone for the modified Reserved Instances.
+ instanceCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of modified Reserved Instances.
This is a required field for a request.
true if the request succeeds; otherwise, returns an error.'
+ SecurityGroupRuleUpdate:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRuleRequest'
+ - description: Information about the security group rule.
+ description: Describes an update to a security group rule.
+ CreateVolumePermissionList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CreateVolumePermission'
+ - xml:
+ name: item
+ ModifySnapshotTierResult:
+ type: object
+ properties:
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the snapshot.
+ tieringStartTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The date and time when the archive process was started.
+ ModifySpotFleetRequestResponse:
+ type: object
+ example:
+ Return: true
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.'
+ description: Contains the output of ModifySpotFleetRequest.
+ LaunchTemplateConfig:
+ type: object
+ properties:
+ launchTemplateSpecification:
+ allOf:
+ - $ref: '#/components/schemas/FleetLaunchTemplateSpecification'
+ - description: The launch template.
+ overrides:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateOverridesList'
+ - description: Any parameters that you specify override the same parameters in the launch template.
+ description: Describes a launch template and overrides.
+ ModifyTrafficMirrorFilterNetworkServicesResult:
+ type: object
+ properties:
+ trafficMirrorFilter:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorFilter'
+ - description: The Traffic Mirror filter that the network service is associated with.
+ TrafficMirrorNetworkService:
+ type: string
+ enum:
+ - amazon-dns
+ ModifyTrafficMirrorFilterRuleResult:
+ type: object
+ properties:
+ trafficMirrorFilterRule:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorFilterRule'
+ - description: Modifies a Traffic Mirror rule.
+ TrafficMirrorFilterRuleField:
+ type: string
+ enum:
+ - destination-port-range
+ - source-port-range
+ - protocol
+ - description
+ ModifyTrafficMirrorSessionResult:
+ type: object
+ properties:
+ trafficMirrorSession:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorSession'
+ - description: Information about the Traffic Mirror session.
+ TrafficMirrorSessionField:
+ type: string
+ enum:
+ - packet-length
+ - description
+ - virtual-network-id
+ ModifyTransitGatewayResult:
+ type: object
+ properties:
+ transitGateway:
+ $ref: '#/components/schemas/TransitGateway'
+ ModifyTransitGatewayPrefixListReferenceResult:
+ type: object
+ properties:
+ transitGatewayPrefixListReference:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPrefixListReference'
+ - description: Information about the prefix list reference.
+ ModifyTransitGatewayVpcAttachmentResult:
+ type: object
+ properties:
+ transitGatewayVpcAttachment:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayVpcAttachment'
+ - description: Information about the modified attachment.
+ ModifyVolumeResult:
+ type: object
+ properties:
+ volumeModification:
+ allOf:
+ - $ref: '#/components/schemas/VolumeModification'
+ - description: Information about the volume modification.
+ ModifyVpcEndpointResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ ModifyVpcEndpointConnectionNotificationResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ ModifyVpcEndpointServiceConfigurationResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ ModifyVpcEndpointServicePayerResponsibilityResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ ModifyVpcEndpointServicePermissionsResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ ModifyVpcPeeringConnectionOptionsResult:
+ type: object
+ properties:
+ accepterPeeringConnectionOptions:
+ allOf:
+ - $ref: '#/components/schemas/PeeringConnectionOptions'
+ - description: Information about the VPC peering connection options for the accepter VPC.
+ requesterPeeringConnectionOptions:
+ allOf:
+ - $ref: '#/components/schemas/PeeringConnectionOptions'
+ - description: Information about the VPC peering connection options for the requester VPC.
+ ModifyVpcTenancyResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, returns an error.'
+ ModifyVpnConnectionResult:
+ type: object
+ properties:
+ vpnConnection:
+ $ref: '#/components/schemas/VpnConnection'
+ ModifyVpnConnectionOptionsResult:
+ type: object
+ properties:
+ vpnConnection:
+ $ref: '#/components/schemas/VpnConnection'
+ ModifyVpnTunnelCertificateResult:
+ type: object
+ properties:
+ vpnConnection:
+ $ref: '#/components/schemas/VpnConnection'
+ ModifyVpnTunnelOptionsResult:
+ type: object
+ properties:
+ vpnConnection:
+ $ref: '#/components/schemas/VpnConnection'
+ Phase1EncryptionAlgorithmsRequestList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsRequestListValue'
+ - xml:
+ name: item
+ Phase2EncryptionAlgorithmsRequestList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsRequestListValue'
+ - xml:
+ name: item
+ Phase1IntegrityAlgorithmsRequestList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsRequestListValue'
+ - xml:
+ name: item
+ Phase2IntegrityAlgorithmsRequestList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsRequestListValue'
+ - xml:
+ name: item
+ Phase1DHGroupNumbersRequestList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Phase1DHGroupNumbersRequestListValue'
+ - xml:
+ name: item
+ Phase2DHGroupNumbersRequestList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Phase2DHGroupNumbersRequestListValue'
+ - xml:
+ name: item
+ MonitorInstancesResult:
+ type: object
+ properties:
+ instancesSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceMonitoringList'
+ - description: The monitoring information.
+ MoveAddressToVpcResult:
+ type: object
+ example:
+ Status: MoveInProgress
+ properties:
+ allocationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The allocation ID for the Elastic IP address.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Status'
+ - description: The status of the move of the IP address.
+ MoveByoipCidrToIpamResult:
+ type: object
+ properties:
+ byoipCidr:
+ $ref: '#/components/schemas/ByoipCidr'
+ ProvisionByoipCidrResult:
+ type: object
+ properties:
+ byoipCidr:
+ allOf:
+ - $ref: '#/components/schemas/ByoipCidr'
+ - description: Information about the address range.
+ ProvisionIpamPoolCidrResult:
+ type: object
+ properties:
+ ipamPoolCidr:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolCidr'
+ - description: Information about the provisioned CIDR.
+ ProvisionPublicIpv4PoolCidrResult:
+ type: object
+ properties:
+ poolId:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PoolEc2Id'
+ - description: The ID of the pool that you want to provision the CIDR to.
+ poolAddressRange:
+ $ref: '#/components/schemas/PublicIpv4PoolRange'
+ PurchaseHostReservationResult:
+ type: object
+ properties:
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
+ currencyCode:
+ allOf:
+ - $ref: '#/components/schemas/CurrencyCodeValues'
+ - description: 'The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.'
+ purchase:
+ allOf:
+ - $ref: '#/components/schemas/PurchaseSet'
+ - description: Describes the details of the purchase.
+ totalHourlyPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The total hourly price of the reservation calculated per hour.
+ totalUpfrontPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The total amount charged to your account when you purchase the reservation.
+ PurchaseReservedInstancesOfferingResult:
+ type: object
+ properties:
+ reservedInstancesId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing pricing tiers in the Amazon Elastic Compute Cloud User Guide.'
+ description: Contains the output of PurchaseReservedInstancesOffering.
+ Double:
+ type: number
+ format: double
+ CurrencyCodeValues:
+ type: string
+ enum:
+ - USD
+ PurchaseScheduledInstancesResult:
+ type: object
+ example:
+ ScheduledInstanceSet:
+ - AvailabilityZone: us-west-2b
+ CreateDate: '2016-01-25T21:43:38.612Z'
+ HourlyPrice: '0.095'
+ InstanceCount: 1
+ InstanceType: c4.large
+ NetworkPlatform: EC2-VPC
+ NextSlotStartTime: '2016-01-31T09:00:00Z'
+ Platform: Linux/UNIX
+ Recurrence:
+ Frequency: Weekly
+ Interval: 1
+ OccurrenceDaySet:
+ - 1
+ OccurrenceRelativeToEnd: false
+ OccurrenceUnit: ''
+ ScheduledInstanceId: sci-1234-1234-1234-1234-123456789012
+ SlotDurationInHours: 32
+ TermEndDate: '2017-01-31T09:00:00Z'
+ TermStartDate: '2016-01-31T09:00:00Z'
+ TotalScheduledInstanceHours: 1696
+ properties:
+ scheduledInstanceSet:
+ allOf:
+ - $ref: '#/components/schemas/PurchasedScheduledInstanceSet'
+ - description: Information about the Scheduled Instances.
+ description: Contains the output of PurchaseScheduledInstances.
+ PurchaseRequest:
+ type: object
+ required:
+ - InstanceCount
+ - PurchaseToken
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The purchase token.
+ description: Describes a request to purchase Scheduled Instances.
+ RegisterImageResult:
+ type: object
+ properties:
+ imageId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the newly registered AMI.
+ description: Contains the output of RegisterImage.
+ RegisterInstanceEventNotificationAttributesResult:
+ type: object
+ properties:
+ instanceTagAttribute:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTagNotificationAttribute'
+ - description: The resulting set of tag keys.
+ RegisterTransitGatewayMulticastGroupMembersResult:
+ type: object
+ properties:
+ registeredMulticastGroupMembers:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastRegisteredGroupMembers'
+ - description: Information about the registered transit gateway multicast group members.
+ RegisterTransitGatewayMulticastGroupSourcesResult:
+ type: object
+ properties:
+ registeredMulticastGroupSources:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastRegisteredGroupSources'
+ - description: Information about the transit gateway multicast group sources.
+ RejectTransitGatewayMulticastDomainAssociationsResult:
+ type: object
+ properties:
+ associations:
+ $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
+ RejectTransitGatewayPeeringAttachmentResult:
+ type: object
+ properties:
+ transitGatewayPeeringAttachment:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
+ - description: The transit gateway peering attachment.
+ RejectTransitGatewayVpcAttachmentResult:
+ type: object
+ properties:
+ transitGatewayVpcAttachment:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayVpcAttachment'
+ - description: Information about the attachment.
+ RejectVpcEndpointConnectionsResult:
+ type: object
+ properties:
+ unsuccessful:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulItemSet'
+ - description: 'Information about the endpoints that were not rejected, if applicable.'
+ RejectVpcPeeringConnectionResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ ReleaseHostsResult:
+ type: object
+ properties:
+ successful:
+ allOf:
+ - $ref: '#/components/schemas/ResponseHostIdList'
+ - description: The IDs of the Dedicated Hosts that were successfully released.
+ unsuccessful:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulItemList'
+ - description: 'The IDs of the Dedicated Hosts that could not be released, including an error message.'
+ ReleaseIpamPoolAllocationResult:
+ type: object
+ properties:
+ success:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates if the release was successful.
+ ReplaceIamInstanceProfileAssociationResult:
+ type: object
+ properties:
+ iamInstanceProfileAssociation:
+ allOf:
+ - $ref: '#/components/schemas/IamInstanceProfileAssociation'
+ - description: Information about the IAM instance profile association.
+ ReplaceNetworkAclAssociationResult:
+ type: object
+ example:
+ NewAssociationId: aclassoc-3999875b
+ properties:
+ newAssociationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the new association.
+ ReplaceRouteTableAssociationResult:
+ type: object
+ example:
+ NewAssociationId: rtbassoc-3a1f0f58
+ properties:
+ newAssociationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the new association.
+ associationState:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableAssociationState'
+ - description: The state of the association.
+ ReplaceTransitGatewayRouteResult:
+ type: object
+ properties:
+ route:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRoute'
+ - description: Information about the modified route.
+ ReportInstanceReasonCodes:
+ type: string
+ enum:
+ - instance-stuck-in-state
+ - unresponsive
+ - not-accepting-credentials
+ - password-not-available
+ - performance-network
+ - performance-instance-store
+ - performance-ebs-volume
+ - performance-other
+ - other
+ RequestSpotFleetResponse:
+ type: object
+ example:
+ SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
+ properties:
+ spotFleetRequestId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Spot Fleet request.
+ description: Contains the output of RequestSpotFleet.
+ AllocationStrategy:
+ type: string
+ enum:
+ - lowestPrice
+ - diversified
+ - capacityOptimized
+ - capacityOptimizedPrioritized
+ OnDemandAllocationStrategy:
+ type: string
+ enum:
+ - lowestPrice
+ - prioritized
+ SpotMaintenanceStrategies:
+ type: object
+ properties:
+ capacityRebalance:
+ allOf:
+ - $ref: '#/components/schemas/SpotCapacityRebalance'
+ - description: 'The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.'
+ description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
+ ExcessCapacityTerminationPolicy:
+ type: string
+ enum:
+ - noTermination
+ - default
+ LaunchSpecsList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetLaunchSpecification'
+ - xml:
+ name: item
+ LaunchTemplateConfigList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateConfig'
+ - xml:
+ name: item
+ FleetType:
+ type: string
+ enum:
+ - request
+ - maintain
+ - instant
+ InstanceInterruptionBehavior:
+ type: string
+ enum:
+ - hibernate
+ - stop
+ - terminate
+ LoadBalancersConfig:
+ type: object
+ properties:
+ classicLoadBalancersConfig:
+ allOf:
+ - $ref: '#/components/schemas/ClassicLoadBalancersConfig'
+ - description: The Classic Load Balancers.
+ targetGroupsConfig:
+ allOf:
+ - $ref: '#/components/schemas/TargetGroupsConfig'
+ - description: The target groups.
+ description: Describes the Classic Load Balancers and target groups to attach to a Spot Fleet request.
+ TagSpecificationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecification'
+ - xml:
+ name: item
+ RequestSpotInstancesResult:
+ type: object
+ properties:
+ spotInstanceRequestSet:
+ allOf:
+ - $ref: '#/components/schemas/SpotInstanceRequestList'
+ - description: One or more Spot Instance requests.
+ description: Contains the output of RequestSpotInstances.
+ RequestSpotLaunchSpecificationSecurityGroupIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: item
+ RequestSpotLaunchSpecificationSecurityGroupList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ BlockDeviceMappingList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/BlockDeviceMapping'
+ - xml:
+ name: item
+ IamInstanceProfileSpecification:
+ type: object
+ properties:
+ arn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the instance profile.
+ name:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the instance profile.
+ description: Describes an IAM instance profile.
+ KernelId:
+ type: string
+ RunInstancesMonitoringEnabled:
+ type: object
+ required:
+ - Enabled
+ properties:
+ enabled:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.'
+ description: Describes the monitoring of an instance.
+ InstanceNetworkInterfaceSpecificationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecification'
+ - xml:
+ name: item
+ SpotPlacement:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
' + groupName: + allOf: + - $ref: '#/components/schemas/PlacementGroupName' + - description: The name of the placement group. + tenancy: + allOf: + - $ref: '#/components/schemas/Tenancy' + - description: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy ofdedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
+ description: Describes Spot Instance placement.
+ RamdiskId:
+ type: string
+ ResetAddressAttributeResult:
+ type: object
+ properties:
+ address:
+ allOf:
+ - $ref: '#/components/schemas/AddressAttribute'
+ - description: Information about the IP address.
+ ResetEbsDefaultKmsKeyIdResult:
+ type: object
+ properties:
+ kmsKeyId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the default KMS key for EBS encryption by default.
+ ResetFpgaImageAttributeResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Is true if the request succeeds, and an error otherwise.'
+ RestoreAddressToClassicResult:
+ type: object
+ example:
+ PublicIp: 198.51.100.0
+ Status: MoveInProgress
+ properties:
+ publicIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Elastic IP address.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/Status'
+ - description: The move status for the IP address.
+ RestoreImageFromRecycleBinResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ RestoreManagedPrefixListVersionResult:
+ type: object
+ properties:
+ prefixList:
+ allOf:
+ - $ref: '#/components/schemas/ManagedPrefixList'
+ - description: Information about the prefix list.
+ RestoreSnapshotFromRecycleBinResult:
+ type: object
+ properties:
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the snapshot.
+ outpostArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.'
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description for the snapshot.
+ encrypted:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the snapshot is encrypted.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the EBS snapshot.
+ progress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The progress of the snapshot, as a percentage.'
+ startTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time stamp when the snapshot was initiated.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotState'
+ - description: The state of the snapshot.
+ volumeId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the volume that was used to create the snapshot.
+ volumeSize:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The size of the volume, in GiB.'
+ RestoreSnapshotTierResult:
+ type: object
+ properties:
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the snapshot.
+ restoreStartTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The date and time when the snapshot restore process started.
+ restoreDuration:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: For temporary restores only. The number of days for which the archived snapshot is temporarily restored.
+ isPermanentRestore:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the snapshot is permanently restored. true indicates a permanent restore. false indicates a temporary restore.
+ RevokeClientVpnIngressResult:
+ type: object
+ properties:
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus'
+ - description: The current state of the authorization rule.
+ RevokeSecurityGroupEgressResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, returns an error.'
+ unknownIpPermissionSet:
+ allOf:
+ - $ref: '#/components/schemas/IpPermissionList'
+ - description: 'The outbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter. '
+ RevokeSecurityGroupIngressResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, returns an error.'
+ unknownIpPermissionSet:
+ allOf:
+ - $ref: '#/components/schemas/IpPermissionList'
+ - description: 'The inbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter. '
+ Reservation:
+ type: object
+ example: {}
+ properties:
+ groupSet:
+ allOf:
+ - $ref: '#/components/schemas/GroupIdentifierList'
+ - description: '[EC2-Classic only] The security groups.'
+ instancesSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceList'
+ - description: The instances.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the reservation.
+ requesterId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).'
+ reservationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the reservation.
+ description: 'Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.'
+ Tenancy:
+ type: string
+ enum:
+ - default
+ - dedicated
+ - host
+ InstanceNetworkInterfaceSpecification:
+ type: object
+ properties:
+ associatePublicIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.'
+ deleteOnTermination:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.'
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the network interface. Applies only if creating a network interface when launching an instance.
+ deviceIndex:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
' + SecurityGroupId: + allOf: + - $ref: '#/components/schemas/SecurityGroupIdStringList' + - description: The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. + ipv6AddressCount: + allOf: + - $ref: '#/components/schemas/Integer' + - description: A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch. + ipv6AddressesSet: + allOf: + - $ref: '#/components/schemas/InstanceIpv6AddressList' + - description: One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch. + networkInterfaceId: + allOf: + - $ref: '#/components/schemas/NetworkInterfaceId' + - description: 'The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
' + privateIpAddress: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you''re launching more than one instance in a RunInstances request.' + privateIpAddressesSet: + allOf: + - $ref: '#/components/schemas/PrivateIpAddressSpecificationList' + - description: 'One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you''re launching more than one instance in a RunInstances request.' + secondaryPrivateIpAddressCount: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The number of secondary private IPv4 addresses. You can''t specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you''re launching more than one instance in a RunInstances request.' + subnetId: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances.
' + Ipv4Prefix: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use theIpv4Prefix option.
+ Ipv6Prefix:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
+ description: Describes a network interface.
+ ElasticGpuSpecification:
+ type: object
+ required:
+ - Type
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The type of Elastic Graphics accelerator. For more information about the values to specify for Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances.'
+ description: A specification for an Elastic Graphics accelerator.
+ ElasticInferenceAccelerator:
+ type: object
+ required:
+ - Type
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ElasticInferenceAcceleratorCount'
+ - description: 'The number of elastic inference accelerators to attach to the instance.
Default: 1
' + description: ' Describes an elastic inference accelerator. ' + SpotMarketOptions: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/InstanceInterruptionBehavior' + - description: The behavior when a Spot Instance is interrupted. The default isterminate.
+ description: The options for Spot Instances.
+ LicenseConfigurationRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the license configuration.
+ description: Describes a license configuration.
+ InstanceMetadataTagsState:
+ type: string
+ enum:
+ - disabled
+ - enabled
+ InstanceAutoRecoveryState:
+ type: string
+ enum:
+ - disabled
+ - default
+ RunScheduledInstancesResult:
+ type: object
+ example:
+ InstanceIdSet:
+ - i-1234567890abcdef0
+ properties:
+ instanceIdSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdSet'
+ - description: The IDs of the newly launched instances.
+ description: Contains the output of RunScheduledInstances.
+ ScheduledInstancesMonitoring:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether monitoring is enabled.
+ description: Describes whether monitoring is enabled for a Scheduled Instance.
+ SearchLocalGatewayRoutesResult:
+ type: object
+ properties:
+ routeSet:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteList'
+ - description: Information about the routes.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ SearchTransitGatewayMulticastGroupsResult:
+ type: object
+ properties:
+ multicastGroups:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastGroupList'
+ - description: Information about the transit gateway multicast group.
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ SearchTransitGatewayRoutesResult:
+ type: object
+ properties:
+ routeSet:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteList'
+ - description: Information about the routes.
+ additionalRoutesAvailable:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether there are additional routes available.
+ StartInstancesResult:
+ type: object
+ example:
+ StartingInstances:
+ - CurrentState:
+ Code: 0
+ Name: pending
+ InstanceId: i-1234567890abcdef0
+ PreviousState:
+ Code: 80
+ Name: stopped
+ properties:
+ instancesSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceStateChangeList'
+ - description: Information about the started instances.
+ StartNetworkInsightsAccessScopeAnalysisResult:
+ type: object
+ properties:
+ networkInsightsAccessScopeAnalysis:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysis'
+ - description: The Network Access Scope analysis.
+ StartNetworkInsightsAnalysisResult:
+ type: object
+ properties:
+ networkInsightsAnalysis:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAnalysis'
+ - description: Information about the network insights analysis.
+ ResourceArn:
+ type: string
+ minLength: 1
+ maxLength: 1283
+ StartVpcEndpointServicePrivateDnsVerificationResult:
+ type: object
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, it returns an error.'
+ StopInstancesResult:
+ type: object
+ example:
+ StoppingInstances:
+ - CurrentState:
+ Code: 64
+ Name: stopping
+ InstanceId: i-1234567890abcdef0
+ PreviousState:
+ Code: 16
+ Name: running
+ properties:
+ instancesSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceStateChangeList'
+ - description: Information about the stopped instances.
+ TerminateClientVpnConnectionsResult:
+ type: object
+ properties:
+ clientVpnEndpointId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Client VPN endpoint.
+ username:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The user who established the terminated client connections.
+ connectionStatuses:
+ allOf:
+ - $ref: '#/components/schemas/TerminateConnectionStatusSet'
+ - description: The current state of the client connections.
+ TerminateInstancesResult:
+ type: object
+ example:
+ TerminatingInstances:
+ - CurrentState:
+ Code: 32
+ Name: shutting-down
+ InstanceId: i-1234567890abcdef0
+ PreviousState:
+ Code: 16
+ Name: running
+ properties:
+ instancesSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceStateChangeList'
+ - description: Information about the terminated instances.
+ UnassignIpv6AddressesResult:
+ type: object
+ properties:
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network interface.
+ unassignedIpv6Addresses:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6AddressList'
+ - description: The IPv6 addresses that have been unassigned from the network interface.
+ unassignedIpv6PrefixSet:
+ allOf:
+ - $ref: '#/components/schemas/IpPrefixList'
+ - description: The IPv4 prefixes that have been unassigned from the network interface.
+ UnmonitorInstancesResult:
+ type: object
+ properties:
+ instancesSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceMonitoringList'
+ - description: The monitoring information.
+ UpdateSecurityGroupRuleDescriptionsEgressResult:
+ type: object
+ example: {}
+ properties:
+ return:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Returns true if the request succeeds; otherwise, returns an error.'
+ SecurityGroupRuleDescription:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the security group rule.
+ description: Describes the description of a security group rule.
You can use this when you want to update the security group rule description for either an inbound or outbound rule.
+ UpdateSecurityGroupRuleDescriptionsIngressResult: + type: object + example: {} + properties: + return: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Returnstrue if the request succeeds; otherwise, returns an error.'
+ WithdrawByoipCidrResult:
+ type: object
+ properties:
+ byoipCidr:
+ allOf:
+ - $ref: '#/components/schemas/ByoipCidr'
+ - description: Information about the address pool.
+ AcceleratorCount:
+ type: object
+ properties:
+ min:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.'
+ max:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.'
+ description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.'
+ AcceleratorManufacturer:
+ type: string
+ enum:
+ - nvidia
+ - amd
+ - amazon-web-services
+ - xilinx
+ AcceleratorName:
+ type: string
+ enum:
+ - a100
+ - v100
+ - k80
+ - t4
+ - m60
+ - radeon-pro-v520
+ - vu9p
+ AcceleratorNameSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AcceleratorName'
+ - xml:
+ name: item
+ AcceleratorTotalMemoryMiB:
+ type: object
+ properties:
+ min:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.'
+ max:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.'
+ description: 'The minimum and maximum amount of total accelerator memory, in MiB.'
+ AcceleratorType:
+ type: string
+ enum:
+ - gpu
+ - fpga
+ - inference
+ AcceleratorTypeSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AcceleratorType'
+ - xml:
+ name: item
+ ReservedInstanceIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservationId'
+ - xml:
+ name: ReservedInstanceId
+ TargetConfigurationRequestSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TargetConfigurationRequest'
+ - xml:
+ name: TargetConfigurationRequest
+ AcceptReservedInstancesExchangeQuoteRequest:
+ type: object
+ required:
+ - ReservedInstanceIds
+ title: AcceptReservedInstancesExchangeQuoteRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ReservedInstanceId:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstanceIdSet'
+ - description: The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
+ TargetConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/TargetConfigurationRequestSet'
+ - description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
+ description: Contains the parameters for accepting the quote.
+ AcceptTransitGatewayMulticastDomainAssociationsRequest:
+ type: object
+ title: AcceptTransitGatewayMulticastDomainAssociationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayMulticastDomainAssociations:
+ type: object
+ properties:
+ transitGatewayMulticastDomainId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway multicast domain.
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway attachment.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
+ - description: 'The type of resource, for example a VPC attachment.'
+ resourceOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: ' The ID of the Amazon Web Services account that owns the resource.'
+ subnets:
+ allOf:
+ - $ref: '#/components/schemas/SubnetAssociationList'
+ - description: The subnets associated with the multicast domain.
+ description: Describes the multicast domain associations.
+ AcceptTransitGatewayPeeringAttachmentRequest:
+ type: object
+ required:
+ - TransitGatewayAttachmentId
+ title: AcceptTransitGatewayPeeringAttachmentRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayPeeringAttachment:
+ type: object
+ properties:
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway peering attachment.
+ requesterTgwInfo:
+ allOf:
+ - $ref: '#/components/schemas/PeeringTgwInfo'
+ - description: Information about the requester transit gateway.
+ accepterTgwInfo:
+ allOf:
+ - $ref: '#/components/schemas/PeeringTgwInfo'
+ - description: Information about the accepter transit gateway.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/PeeringAttachmentStatus'
+ - description: The status of the transit gateway peering attachment.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentState'
+ - description: The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
+ creationTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time the transit gateway peering attachment was created.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for the transit gateway peering attachment.
+ description: Describes the transit gateway peering attachment.
+ AcceptTransitGatewayVpcAttachmentRequest:
+ type: object
+ required:
+ - TransitGatewayAttachmentId
+ title: AcceptTransitGatewayVpcAttachmentRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayVpcAttachment:
+ type: object
+ properties:
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the attachment.
+ transitGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ vpcOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the VPC.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentState'
+ - description: The state of the VPC attachment. Note that the initiating state has been deprecated.
+ subnetIds:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The IDs of the subnets.
+ creationTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The creation time.
+ options:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayVpcAttachmentOptions'
+ - description: The VPC attachment options.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for the VPC attachment.
+ description: Describes a VPC attachment.
+ VpcEndpointIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointId'
+ - xml:
+ name: item
+ AcceptVpcEndpointConnectionsRequest:
+ type: object
+ required:
+ - ServiceId
+ - VpcEndpointIds
+ title: AcceptVpcEndpointConnectionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointServiceId'
+ - description: The ID of the VPC endpoint service.
+ VpcEndpointId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointIdList'
+ - description: The IDs of one or more interface VPC endpoints.
+ UnsuccessfulItemSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulItem'
+ - xml:
+ name: item
+ AcceptVpcPeeringConnectionRequest:
+ type: object
+ title: AcceptVpcPeeringConnectionRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ vpcPeeringConnectionId:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnectionId'
+ - description: The ID of the VPC peering connection. You must specify this parameter in the request.
+ VpcPeeringConnection:
+ type: object
+ properties:
+ accepterVpcInfo:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnectionVpcInfo'
+ - description: Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
+ expirationTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time that an unaccepted VPC peering connection will expire.
+ requesterVpcInfo:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnectionVpcInfo'
+ - description: Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnectionStateReason'
+ - description: The status of the VPC peering connection.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the resource.
+ vpcPeeringConnectionId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC peering connection.
+ description: Describes a VPC peering connection.
+ PathComponentList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PathComponent'
+ - xml:
+ name: item
+ AccessScopeAnalysisFinding:
+ type: object
+ properties:
+ networkInsightsAccessScopeAnalysisId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
+ - description: The ID of the Network Access Scope analysis.
+ networkInsightsAccessScopeId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
+ - description: The ID of the Network Access Scope.
+ findingId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the finding.
+ findingComponentSet:
+ allOf:
+ - $ref: '#/components/schemas/PathComponentList'
+ - description: The finding components.
+ description: Describes a finding for a Network Access Scope.
+ AccessScopeAnalysisFindingList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AccessScopeAnalysisFinding'
+ - xml:
+ name: item
+ PathStatement:
+ type: object
+ properties:
+ packetHeaderStatement:
+ allOf:
+ - $ref: '#/components/schemas/PacketHeaderStatement'
+ - description: The packet header statement.
+ resourceStatement:
+ allOf:
+ - $ref: '#/components/schemas/ResourceStatement'
+ - description: The resource statement.
+ description: Describes a path statement.
+ ThroughResourcesStatementList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ThroughResourcesStatement'
+ - xml:
+ name: item
+ AccessScopePath:
+ type: object
+ properties:
+ source:
+ allOf:
+ - $ref: '#/components/schemas/PathStatement'
+ - description: The source.
+ destination:
+ allOf:
+ - $ref: '#/components/schemas/PathStatement'
+ - description: The destination.
+ throughResourceSet:
+ allOf:
+ - $ref: '#/components/schemas/ThroughResourcesStatementList'
+ - description: The through resources.
+ description: Describes a path.
+ AccessScopePathList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AccessScopePath'
+ - xml:
+ name: item
+ AccessScopePathListRequest:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AccessScopePathRequest'
+ - xml:
+ name: item
+ PathStatementRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ResourceStatementRequest'
+ - description: The resource statement.
+ description: Describes a path statement.
+ ThroughResourcesStatementRequestList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ThroughResourcesStatementRequest'
+ - xml:
+ name: item
+ AccountAttributeValueList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AccountAttributeValue'
+ - xml:
+ name: item
+ AccountAttribute:
+ type: object
+ properties:
+ attributeName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the account attribute.
+ attributeValueSet:
+ allOf:
+ - $ref: '#/components/schemas/AccountAttributeValueList'
+ - description: The values for the account attribute.
+ description: Describes an account attribute.
+ AccountAttributeList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AccountAttribute'
+ - xml:
+ name: item
+ AccountAttributeNameStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AccountAttributeName'
+ - xml:
+ name: attributeName
+ AccountAttributeValue:
+ type: object
+ properties:
+ attributeValue:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The value of the attribute.
+ description: Describes a value of an account attribute.
+ InstanceHealthStatus:
+ type: string
+ enum:
+ - healthy
+ - unhealthy
+ ActiveInstance:
+ type: object
+ properties:
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance.
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The instance type.
+ spotInstanceRequestId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Spot Instance request.
+ instanceHealth:
+ allOf:
+ - $ref: '#/components/schemas/InstanceHealthStatus'
+ - description: 'The health status of the instance. If the status of either the instance status check or the system status check is impaired, the health status of the instance is unhealthy. Otherwise, the health status is healthy.'
+ description: Describes a running instance in a Spot Fleet.
+ ActiveInstanceSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ActiveInstance'
+ - xml:
+ name: item
+ ActivityStatus:
+ type: string
+ enum:
+ - error
+ - pending_fulfillment
+ - pending_termination
+ - fulfilled
+ AddIpamOperatingRegionSet:
+ type: array
+ items:
+ $ref: '#/components/schemas/AddIpamOperatingRegion'
+ minItems: 0
+ maxItems: 50
+ AddPrefixListEntries:
+ type: array
+ items:
+ $ref: '#/components/schemas/AddPrefixListEntry'
+ minItems: 0
+ maxItems: 100
+ AnalysisComponent:
+ type: object
+ properties:
+ id:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the component.
+ arn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the component.
+ name:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the analysis component.
+ description: Describes a path component.
+ AdditionalDetail:
+ type: object
+ properties:
+ additionalDetailType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The information type.
+ component:
+ allOf:
+ - $ref: '#/components/schemas/AnalysisComponent'
+ - description: The path component.
+ description: Describes an additional detail for a path analysis.
+ AdditionalDetailList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AdditionalDetail'
+ - xml:
+ name: item
+ DomainType:
+ type: string
+ enum:
+ - vpc
+ - standard
+ Address:
+ type: object
+ properties:
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance that the address is associated with (if any).
+ publicIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Elastic IP address.
+ allocationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID representing the allocation of the address for use with EC2-VPC.
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID representing the association of the address with an instance in a VPC.
+ domain:
+ allOf:
+ - $ref: '#/components/schemas/DomainType'
+ - description: Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network interface.
+ networkInterfaceOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the network interface.
+ privateIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The private IP address associated with the Elastic IP address.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the Elastic IP address.
+ publicIpv4Pool:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of an address pool.
+ networkBorderGroup:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.'
+ customerOwnedIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The customer-owned IP address.
+ customerOwnedIpv4Pool:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the customer-owned address pool.
+ carrierIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). '
+ description: 'Describes an Elastic IP address, or a carrier IP address.'
+ PublicIpAddress:
+ type: string
+ PtrUpdateStatus:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The value for the PTR record update.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The status of the PTR record update.
+ reason:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The reason for the PTR record update.
+ description: The status of an updated pointer (PTR) record for an Elastic IP address.
+ AddressAttribute:
+ type: object
+ properties:
+ publicIp:
+ allOf:
+ - $ref: '#/components/schemas/PublicIpAddress'
+ - description: The public IP address.
+ allocationId:
+ allOf:
+ - $ref: '#/components/schemas/AllocationId'
+ - description: '[EC2-VPC] The allocation ID.'
+ ptrRecord:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The pointer (PTR) record for the IP address.
+ ptrRecordUpdate:
+ allOf:
+ - $ref: '#/components/schemas/PtrUpdateStatus'
+ - description: The updated PTR record for the IP address.
+ description: The attributes associated with an Elastic IP address.
+ AddressAttributeName:
+ type: string
+ enum:
+ - domain-name
+ AddressFamily:
+ type: string
+ enum:
+ - ipv4
+ - ipv6
+ AddressList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Address'
+ - xml:
+ name: item
+ AddressMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ AddressSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AddressAttribute'
+ - xml:
+ name: item
+ AdvertiseByoipCidrRequest:
+ type: object
+ required:
+ - Cidr
+ title: AdvertiseByoipCidrRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ByoipCidr:
+ type: object
+ properties:
+ cidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The address range, in CIDR notation.'
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the address range.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Upon success, contains the ID of the address pool. Otherwise, contains an error message.'
+ state:
+ allOf:
+ - $ref: '#/components/schemas/ByoipCidrState'
+ - description: The state of the address pool.
+ description: Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
+ Affinity:
+ type: string
+ enum:
+ - default
+ - host
+ AllocateAddressRequest:
+ type: object
+ title: AllocateAddressRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.'
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to assign to the Elastic IP address.
+ AutoPlacement:
+ type: string
+ enum:
+ - 'on'
+ - 'off'
+ AllocateHostsRequest:
+ type: object
+ required:
+ - AvailabilityZone
+ - Quantity
+ title: AllocateHostsRequest
+ properties:
+ autoPlacement:
+ allOf:
+ - $ref: '#/components/schemas/AutoPlacement'
+ - description: 'Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.
Default: on
Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
' + quantity: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The number of Dedicated Hosts to allocate to your account with these parameters. + TagSpecification: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. + ResponseHostIdList: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + IpamPoolAllocationDisallowedCidrs: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + AllocateIpamPoolCidrRequest: + type: object + required: + - IpamPoolId + title: AllocateIpamPoolCidrRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: A preview of the next available CIDR in a pool. + DisallowedCidr: + allOf: + - $ref: '#/components/schemas/IpamPoolAllocationDisallowedCidrs' + - description: Exclude a particular CIDR range from being returned by the pool. + IpamPoolAllocation: + type: object + properties: + cidr: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.'
+ ipamPoolAllocationId:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolAllocationId'
+ - description: The ID of an allocation.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the pool allocation.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolAllocationResourceType'
+ - description: The type of the resource.
+ resourceRegion:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services Region of the resource.
+ resourceOwner:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The owner of the resource.
+ description: 'In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool.'
+ AllocationIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AllocationId'
+ - xml:
+ name: AllocationId
+ AllocationIds:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AllocationId'
+ - xml:
+ name: item
+ AllocationState:
+ type: string
+ enum:
+ - available
+ - under-assessment
+ - permanent-failure
+ - released
+ - released-permanent-failure
+ - pending
+ PrincipalType:
+ type: string
+ enum:
+ - All
+ - Service
+ - OrganizationUnit
+ - Account
+ - User
+ - Role
+ AllowedPrincipal:
+ type: object
+ properties:
+ principalType:
+ allOf:
+ - $ref: '#/components/schemas/PrincipalType'
+ - description: The type of principal.
+ principal:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the principal.
+ description: Describes a principal.
+ AllowedPrincipalSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AllowedPrincipal'
+ - xml:
+ name: item
+ AllowsMultipleInstanceTypes:
+ type: string
+ enum:
+ - 'on'
+ - 'off'
+ AlternatePathHint:
+ type: object
+ properties:
+ componentId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the component.
+ componentArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the component.
+ description: Describes an potential intermediate component of a feasible path.
+ AlternatePathHintList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AlternatePathHint'
+ - xml:
+ name: item
+ PortRange:
+ type: object
+ properties:
+ from:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The first port in the range.
+ to:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The last port in the range.
+ description: Describes a range of ports.
+ AnalysisAclRule:
+ type: object
+ properties:
+ cidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IPv4 address range, in CIDR notation.'
+ egress:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the rule is an outbound rule.
+ portRange:
+ allOf:
+ - $ref: '#/components/schemas/PortRange'
+ - description: The range of ports.
+ protocol:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The protocol.
+ ruleAction:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Indicates whether to allow or deny traffic that matches the rule.
+ ruleNumber:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The rule number.
+ description: Describes a network access control (ACL) rule.
+ AnalysisComponentList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AnalysisComponent'
+ - xml:
+ name: item
+ Port:
+ type: integer
+ minimum: 1
+ maximum: 65535
+ AnalysisLoadBalancerListener:
+ type: object
+ properties:
+ loadBalancerPort:
+ allOf:
+ - $ref: '#/components/schemas/Port'
+ - description: The port on which the load balancer is listening.
+ instancePort:
+ allOf:
+ - $ref: '#/components/schemas/Port'
+ - description: '[Classic Load Balancers] The back-end port for the listener.'
+ description: Describes a load balancer listener.
+ IpAddress:
+ type: string
+ pattern: '^([0-9]{1,3}.){3}[0-9]{1,3}$'
+ minLength: 0
+ maxLength: 15
+ AnalysisLoadBalancerTarget:
+ type: object
+ properties:
+ address:
+ allOf:
+ - $ref: '#/components/schemas/IpAddress'
+ - description: The IP address.
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone.
+ instance:
+ allOf:
+ - $ref: '#/components/schemas/AnalysisComponent'
+ - description: Information about the instance.
+ port:
+ allOf:
+ - $ref: '#/components/schemas/Port'
+ - description: The port on which the target is listening.
+ description: Describes a load balancer target.
+ IpAddressList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpAddress'
+ - xml:
+ name: item
+ PortRangeList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PortRange'
+ - xml:
+ name: item
+ AnalysisPacketHeader:
+ type: object
+ properties:
+ destinationAddressSet:
+ allOf:
+ - $ref: '#/components/schemas/IpAddressList'
+ - description: The destination addresses.
+ destinationPortRangeSet:
+ allOf:
+ - $ref: '#/components/schemas/PortRangeList'
+ - description: The destination port ranges.
+ protocol:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The protocol.
+ sourceAddressSet:
+ allOf:
+ - $ref: '#/components/schemas/IpAddressList'
+ - description: The source addresses.
+ sourcePortRangeSet:
+ allOf:
+ - $ref: '#/components/schemas/PortRangeList'
+ - description: The source port ranges.
+ description: Describes a header. Reflects any changes made by a component as traffic passes through. The fields of an inbound header are null except for the first component of a path.
+ AnalysisRouteTableRoute:
+ type: object
+ properties:
+ destinationCidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The destination IPv4 address, in CIDR notation.'
+ destinationPrefixListId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The prefix of the Amazon Web Service.
+ egressOnlyInternetGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of an egress-only internet gateway.
+ gatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ID of the gateway, such as an internet gateway or virtual private gateway.'
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ID of the instance, such as a NAT instance.'
+ natGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of a NAT gateway.
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of a network interface.
+ origin:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Describes how the route was created. The following are the possible values:
CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.
The direction. The following are the possible values:
egress
ingress
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ClientVpnSecurityGroupIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: item
+ ArchitectureTypeList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ArchitectureType'
+ - xml:
+ name: item
+ ArnList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - xml:
+ name: item
+ IpPrefixList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ AssignIpv6AddressesRequest:
+ type: object
+ required:
+ - NetworkInterfaceId
+ title: AssignIpv6AddressesRequest
+ properties:
+ ipv6AddressCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
+ ipv6Addresses:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.
+ Ipv6Prefix:
+ allOf:
+ - $ref: '#/components/schemas/IpPrefixList'
+ - description: One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - description: The ID of the network interface.
+ Ipv6AddressList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ PrivateIpAddressStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: PrivateIpAddress
+ AssignPrivateIpAddressesRequest:
+ type: object
+ required:
+ - NetworkInterfaceId
+ title: AssignPrivateIpAddressesRequest
+ properties:
+ allowReassignment:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - description: The ID of the network interface.
+ privateIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/PrivateIpAddressStringList'
+ - description: 'One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can''t specify this parameter when also specifying a number of secondary IP addresses.
If you don''t specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
' + secondaryPrivateIpAddressCount: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. + Ipv4Prefix: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use theIpv4 Prefixes option.
+ description: Contains the parameters for AssignPrivateIpAddresses.
+ AssignedPrivateIpAddressList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AssignedPrivateIpAddress'
+ - xml:
+ name: item
+ Ipv4PrefixesList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PrefixSpecification'
+ - xml:
+ name: item
+ AssignedPrivateIpAddress:
+ type: object
+ properties:
+ privateIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The private IP address assigned to the network interface.
+ description: Describes the private IP addresses assigned to a network interface.
+ AssociateAddressRequest:
+ type: object
+ title: AssociateAddressRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: '[EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic.'
+ allowReassociation:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: '[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.'
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - description: '[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
' + privateIpAddress: + allOf: + - $ref: '#/components/schemas/String' + - description: '[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.' + AssociateClientVpnTargetNetworkRequest: + type: object + required: + - ClientVpnEndpointId + - SubnetId + title: AssociateClientVpnTargetNetworkRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ AssociationStatus:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/AssociationStatusCode'
+ - description: The state of the target network association.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A message about the status of the target network association, if applicable.'
+ description: Describes the state of a target network association.
+ AssociateDhcpOptionsRequest:
+ type: object
+ required:
+ - DhcpOptionsId
+ - VpcId
+ title: AssociateDhcpOptionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ AssociateEnclaveCertificateIamRoleRequest:
+ type: object
+ title: AssociateEnclaveCertificateIamRoleRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ AssociateIamInstanceProfileRequest:
+ type: object
+ required:
+ - IamInstanceProfile
+ - InstanceId
+ title: AssociateIamInstanceProfileRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of the instance.
+ IamInstanceProfileAssociation:
+ type: object
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the association.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance.
+ iamInstanceProfile:
+ allOf:
+ - $ref: '#/components/schemas/IamInstanceProfile'
+ - description: The IAM instance profile.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/IamInstanceProfileAssociationState'
+ - description: The state of the association.
+ timestamp:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time the IAM instance profile was associated with the instance.
+ description: Describes an association between an IAM instance profile and an instance.
+ InstanceEventWindowAssociationRequest:
+ type: object
+ properties:
+ InstanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdList'
+ - description: 'The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can''t specify the Instance ID parameter; you must use the Dedicated Host ID parameter.'
+ InstanceTag:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window.
+ DedicatedHostId:
+ allOf:
+ - $ref: '#/components/schemas/DedicatedHostIdList'
+ - description: The IDs of the Dedicated Hosts to associate with the event window.
+ description: 'One or more targets associated with the specified event window. Only one type of target (instance ID, instance tag, or Dedicated Host ID) can be associated with an event window.'
+ AssociateInstanceEventWindowRequest:
+ type: object
+ required:
+ - InstanceEventWindowId
+ - AssociationTarget
+ title: AssociateInstanceEventWindowRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowAssociationRequest'
+ - description: One or more targets associated with the specified event window.
+ InstanceEventWindow:
+ type: object
+ properties:
+ instanceEventWindowId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowId'
+ - description: The ID of the event window.
+ timeRangeSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowTimeRangeList'
+ - description: One or more time ranges defined for the event window.
+ name:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the event window.
+ cronExpression:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowCronExpression'
+ - description: The cron expression defined for the event window.
+ associationTarget:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowAssociationTarget'
+ - description: One or more targets associated with the event window.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowState'
+ - description: The current state of the event window.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The instance tags associated with the event window.
+ description: The event window.
+ RouteGatewayId:
+ type: string
+ AssociateRouteTableRequest:
+ type: object
+ required:
+ - RouteTableId
+ title: AssociateRouteTableRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ routeTableId:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableId'
+ - description: The ID of the route table.
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/RouteGatewayId'
+ - description: The ID of the internet gateway or virtual private gateway.
+ RouteTableAssociationState:
+ type: object
+ properties:
+ state:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableAssociationStateCode'
+ - description: The state of the association.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The status message, if applicable.'
+ description: Describes the state of an association between a route table and a subnet or gateway.
+ AssociateSubnetCidrBlockRequest:
+ type: object
+ required:
+ - Ipv6CidrBlock
+ - SubnetId
+ title: AssociateSubnetCidrBlockRequest
+ properties:
+ ipv6CidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - description: The ID of your subnet.
+ SubnetIpv6CidrBlockAssociation:
+ type: object
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/SubnetCidrAssociationId'
+ - description: The ID of the association.
+ ipv6CidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 CIDR block.
+ ipv6CidrBlockState:
+ allOf:
+ - $ref: '#/components/schemas/SubnetCidrBlockState'
+ - description: The state of the CIDR block.
+ description: Describes an association between a subnet and an IPv6 CIDR block.
+ AssociateTransitGatewayMulticastDomainRequest:
+ type: object
+ title: AssociateTransitGatewayMulticastDomainRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ AssociateTransitGatewayRouteTableRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ - TransitGatewayAttachmentId
+ title: AssociateTransitGatewayRouteTableRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayAssociation:
+ type: object
+ properties:
+ transitGatewayRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableId'
+ - description: The ID of the transit gateway route table.
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentId'
+ - description: The ID of the attachment.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
+ - description: The resource type. Note that the tgw-peering resource type has been deprecated.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAssociationState'
+ - description: The state of the association.
+ description: Describes an association between a resource attachment and a transit gateway route table.
+ AssociateTrunkInterfaceRequest:
+ type: object
+ required:
+ - BranchInterfaceId
+ - TrunkInterfaceId
+ title: AssociateTrunkInterfaceRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TrunkInterfaceAssociation:
+ type: object
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/TrunkInterfaceAssociationId'
+ - description: The ID of the association.
+ branchInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the branch network interface.
+ trunkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the trunk network interface.
+ interfaceProtocol:
+ allOf:
+ - $ref: '#/components/schemas/InterfaceProtocolType'
+ - description: The interface protocol. Valid values are VLAN and GRE.
+ vlanId:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The ID of the VLAN when you use the VLAN protocol.
+ greKey:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The application key when you use the GRE protocol.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for the trunk interface association.
+ description: 'Currently available in limited preview only. If you are interested in using this feature, contact your account manager.
Information about an association between a branch network interface with a trunk network interface.
' + NetmaskLength: + type: integer + AssociateVpcCidrBlockRequest: + type: object + required: + - VpcId + title: AssociateVpcCidrBlockRequest + properties: + amazonProvidedIpv6CidrBlock: + allOf: + - $ref: '#/components/schemas/String' + - description: An IPv4 CIDR block to associate with the VPC. + vpcId: + allOf: + - $ref: '#/components/schemas/NetmaskLength' + - description: 'The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide. ' + VpcIpv6CidrBlockAssociation: + type: object + properties: + associationId: + allOf: + - $ref: '#/components/schemas/String' + - description: The association ID for the IPv6 CIDR block. + ipv6CidrBlock: + allOf: + - $ref: '#/components/schemas/String' + - description: The IPv6 CIDR block. + ipv6CidrBlockState: + allOf: + - $ref: '#/components/schemas/VpcCidrBlockState' + - description: Information about the state of the CIDR block. + networkBorderGroup: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example,us-east-1-wl1-bos-wlz-1.'
+ ipv6Pool:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
+ description: Describes an IPv6 CIDR block associated with a VPC.
+ VpcCidrBlockAssociation:
+ type: object
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The association ID for the IPv4 CIDR block.
+ cidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv4 CIDR block.
+ cidrBlockState:
+ allOf:
+ - $ref: '#/components/schemas/VpcCidrBlockState'
+ - description: Information about the state of the CIDR block.
+ description: Describes an IPv4 CIDR block associated with a VPC.
+ AssociatedNetworkType:
+ type: string
+ enum:
+ - vpc
+ AssociatedRole:
+ type: object
+ properties:
+ associatedRoleArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The ARN of the associated IAM role.
+ certificateS3BucketName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the Amazon S3 bucket in which the Amazon S3 object is stored.
+ certificateS3ObjectKey:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle is stored. The object key is formated as follows: role_arn/certificate_arn. '
+ encryptionKmsKeyId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the KMS customer master key (CMK) used to encrypt the private key.
+ description: Information about the associated IAM roles.
+ AssociatedRolesList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AssociatedRole'
+ - xml:
+ name: item
+ AssociatedTargetNetwork:
+ type: object
+ properties:
+ networkId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the subnet.
+ networkType:
+ allOf:
+ - $ref: '#/components/schemas/AssociatedNetworkType'
+ - description: The target network type.
+ description: Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.
+ AssociatedTargetNetworkSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AssociatedTargetNetwork'
+ - xml:
+ name: item
+ AssociationIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IamInstanceProfileAssociationId'
+ - xml:
+ name: AssociationId
+ AssociationStatusCode:
+ type: string
+ enum:
+ - associating
+ - associated
+ - association-failed
+ - disassociating
+ - disassociated
+ MillisecondDateTime:
+ type: string
+ format: date-time
+ AthenaIntegration:
+ type: object
+ required:
+ - IntegrationResultS3DestinationArn
+ - PartitionLoadFrequency
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The end date for the partition.
+ description: Describes integration options for Amazon Athena.
+ GroupIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: groupId
+ AttachClassicLinkVpcRequest:
+ type: object
+ required:
+ - Groups
+ - InstanceId
+ - VpcId
+ title: AttachClassicLinkVpcRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SecurityGroupId:
+ allOf:
+ - $ref: '#/components/schemas/GroupIdStringList'
+ - description: The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of a ClassicLink-enabled VPC.
+ AttachInternetGatewayRequest:
+ type: object
+ required:
+ - InternetGatewayId
+ - VpcId
+ title: AttachInternetGatewayRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ internetGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/InternetGatewayId'
+ - description: The ID of the internet gateway.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ AttachNetworkInterfaceRequest:
+ type: object
+ required:
+ - DeviceIndex
+ - InstanceId
+ - NetworkInterfaceId
+ title: AttachNetworkInterfaceRequest
+ properties:
+ deviceIndex:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The index of the device for the network interface attachment.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of the instance.
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
+ description: Contains the parameters for AttachNetworkInterface.
+ AttachVolumeRequest:
+ type: object
+ required:
+ - Device
+ - InstanceId
+ - VolumeId
+ title: AttachVolumeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VolumeId'
+ - description: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ AttachVpnGatewayRequest:
+ type: object
+ required:
+ - VpcId
+ - VpnGatewayId
+ title: AttachVpnGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpnGatewayId'
+ - description: The ID of the virtual private gateway.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for AttachVpnGateway.
+ VpcAttachment:
+ type: object
+ properties:
+ state:
+ allOf:
+ - $ref: '#/components/schemas/AttachmentStatus'
+ - description: The current state of the attachment.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ description: Describes an attachment between a virtual private gateway and a VPC.
+ AttachmentStatus:
+ type: string
+ enum:
+ - attaching
+ - attached
+ - detaching
+ - detached
+ AttributeBooleanValue:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The attribute value. The valid values are true or false.
+ description: Describes a value for a resource attribute that is a Boolean value.
+ AttributeValue:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The attribute value. The value is case-sensitive.
+ description: Describes a value for a resource attribute that is a String.
+ ClientVpnAuthorizationRuleStatus:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatusCode'
+ - description: The state of the authorization rule.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A message about the status of the authorization rule, if applicable.'
+ description: Describes the state of an authorization rule.
+ AuthorizationRule:
+ type: object
+ properties:
+ clientVpnEndpointId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Client VPN endpoint with which the authorization rule is associated.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A brief description of the authorization rule.
+ groupId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Active Directory group to which the authorization rule grants access.
+ accessAll:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the authorization rule grants access to all clients.
+ destinationCidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.'
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus'
+ - description: The current state of the authorization rule.
+ description: Information about an authorization rule.
+ AuthorizationRuleSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AuthorizationRule'
+ - xml:
+ name: item
+ AuthorizeClientVpnIngressRequest:
+ type: object
+ required:
+ - ClientVpnEndpointId
+ - TargetNetworkCidr
+ title: AuthorizeClientVpnIngressRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ IpPermissionList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpPermission'
+ - xml:
+ name: item
+ AuthorizeSecurityGroupEgressRequest:
+ type: object
+ required:
+ - GroupId
+ title: AuthorizeSecurityGroupEgressRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ groupId:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - description: The ID of the security group.
+ ipPermissions:
+ allOf:
+ - $ref: '#/components/schemas/IpPermissionList'
+ - description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags applied to the security group rule.
+ cidrIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Not supported. Use a set of IP permissions to specify the CIDR.
+ fromPort:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: Not supported. Use a set of IP permissions to specify the port.
+ ipProtocol:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Not supported. Use a set of IP permissions to specify the protocol name or number.
+ toPort:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: Not supported. Use a set of IP permissions to specify the port.
+ sourceSecurityGroupName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Not supported. Use a set of IP permissions to specify a destination security group.
+ sourceSecurityGroupOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Not supported. Use a set of IP permissions to specify a destination security group.
+ SecurityGroupRuleList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRule'
+ - xml:
+ name: item
+ AuthorizeSecurityGroupIngressRequest:
+ type: object
+ title: AuthorizeSecurityGroupIngressRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: '[VPC Only] The tags applied to the security group rule.'
+ AutoAcceptSharedAttachmentsValue:
+ type: string
+ enum:
+ - enable
+ - disable
+ AutoRecoveryFlag:
+ type: boolean
+ AvailabilityZoneState:
+ type: string
+ enum:
+ - available
+ - information
+ - impaired
+ - unavailable
+ AvailabilityZoneOptInStatus:
+ type: string
+ enum:
+ - opt-in-not-required
+ - opted-in
+ - not-opted-in
+ AvailabilityZoneMessageList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AvailabilityZoneMessage'
+ - xml:
+ name: item
+ AvailabilityZone:
+ type: object
+ properties:
+ zoneState:
+ allOf:
+ - $ref: '#/components/schemas/AvailabilityZoneState'
+ - description: 'The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always available.'
+ optInStatus:
+ allOf:
+ - $ref: '#/components/schemas/AvailabilityZoneOptInStatus'
+ - description: 'For Availability Zones, this parameter always has the value of opt-in-not-required.
For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are opted-in, and not-opted-in.
For Availability Zones, this parameter has the same value as the Region name.
For Local Zones, the name of the associated group, for example us-west-2-lax-1.
For Wavelength Zones, the name of the associated group, for example us-east-1-wl1-bos-wlz-1.
availability-zone, local-zone, and wavelength-zone.'
+ parentZoneName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.'
+ parentZoneId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.'
+ description: 'Describes Availability Zones, Local Zones, and Wavelength Zones.'
+ AvailabilityZoneList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AvailabilityZone'
+ - xml:
+ name: item
+ AvailabilityZoneMessage:
+ type: object
+ properties:
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The message about the Availability Zone, Local Zone, or Wavelength Zone.'
+ description: 'Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.'
+ AvailabilityZoneStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: AvailabilityZone
+ AvailableInstanceCapacityList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceCapacity'
+ - xml:
+ name: item
+ AvailableCapacity:
+ type: object
+ properties:
+ availableInstanceCapacity:
+ allOf:
+ - $ref: '#/components/schemas/AvailableInstanceCapacityList'
+ - description: 'The number of instances that can be launched onto the Dedicated Host depending on the host''s available capacity. For Dedicated Hosts that support multiple instance types, this parameter represents the number of instances for each instance size that is supported on the host.'
+ availableVCpus:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of vCPUs available for launching instances onto the Dedicated Host.
+ description: 'The capacity information for instances that can be launched onto the Dedicated Host. '
+ InstanceCapacity:
+ type: object
+ properties:
+ availableCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of instances that can be launched onto the Dedicated Host based on the host's available capacity.
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The instance type supported by the Dedicated Host.
+ totalCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The total number of instances that can be launched onto the Dedicated Host if there are no instances running on it.
+ description: Information about the number of instances that can be launched onto the Dedicated Host.
+ BareMetal:
+ type: string
+ enum:
+ - included
+ - required
+ - excluded
+ BareMetalFlag:
+ type: boolean
+ BaselineBandwidthInMbps:
+ type: integer
+ BaselineEbsBandwidthMbps:
+ type: object
+ properties:
+ min:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.'
+ max:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.'
+ description: 'The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.'
+ BaselineIops:
+ type: integer
+ BaselineThroughputInMBps:
+ type: number
+ format: double
+ BatchState:
+ type: string
+ enum:
+ - submitted
+ - active
+ - cancelled
+ - failed
+ - cancelled_running
+ - cancelled_terminating
+ - modifying
+ BgpStatus:
+ type: string
+ enum:
+ - up
+ - down
+ BillingProductList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ BlobAttributeValue:
+ type: object
+ properties:
+ value:
+ $ref: '#/components/schemas/Blob'
+ EbsBlockDevice:
+ type: object
+ properties:
+ deleteOnTermination:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.'
+ iops:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2 and gp3:1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
' + outpostArn: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The ARN of the Outpost on which the snapshot is stored.
This parameter is only supported on BlockDeviceMapping objects called by CreateImage.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
' + description: Describes a block device for an EBS volume. + BlockDeviceMappingRequestList: + type: array + items: + allOf: + - $ref: '#/components/schemas/BlockDeviceMapping' + - xml: + name: BlockDeviceMapping + BootModeType: + type: string + enum: + - legacy-bios + - uefi + BootModeTypeList: + type: array + items: + allOf: + - $ref: '#/components/schemas/BootModeType' + - xml: + name: item + BootModeValues: + type: string + enum: + - legacy-bios + - uefi + BoxedDouble: + type: number + format: double + BundleIdStringList: + type: array + items: + allOf: + - $ref: '#/components/schemas/BundleId' + - xml: + name: BundleId + Storage: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/S3Storage' + - description: An Amazon S3 storage location. + description: Describes the storage location for an instance store-backed AMI. + BundleInstanceRequest: + type: object + required: + - InstanceId + - Storage + title: BundleInstanceRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Storage' + - description: 'The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for BundleInstance.
+ BundleTask:
+ type: object
+ properties:
+ bundleId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the bundle task.
+ error:
+ allOf:
+ - $ref: '#/components/schemas/BundleTaskError'
+ - description: 'If the task fails, a description of the error.'
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance associated with this bundle task.
+ progress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The level of task completion, as a percent (for example, 20%).'
+ startTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time this task started.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/BundleTaskState'
+ - description: The state of the task.
+ storage:
+ allOf:
+ - $ref: '#/components/schemas/Storage'
+ - description: The Amazon S3 storage locations.
+ updateTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time of the most recent update for the task.
+ description: Describes a bundle task.
+ BundleTaskError:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The error code.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The error message.
+ description: Describes an error for BundleInstance.
+ BundleTaskState:
+ type: string
+ enum:
+ - pending
+ - waiting-for-shutdown
+ - bundling
+ - storing
+ - cancelling
+ - complete
+ - failed
+ BundleTaskList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/BundleTask'
+ - xml:
+ name: item
+ BurstablePerformance:
+ type: string
+ enum:
+ - included
+ - required
+ - excluded
+ BurstablePerformanceFlag:
+ type: boolean
+ ByoipCidrState:
+ type: string
+ enum:
+ - advertised
+ - deprovisioned
+ - failed-deprovision
+ - failed-provision
+ - pending-deprovision
+ - pending-provision
+ - provisioned
+ - provisioned-not-publicly-advertisable
+ ByoipCidrSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ByoipCidr'
+ - xml:
+ name: item
+ CancelBatchErrorCode:
+ type: string
+ enum:
+ - fleetRequestIdDoesNotExist
+ - fleetRequestIdMalformed
+ - fleetRequestNotInCancellableState
+ - unexpectedError
+ CancelBundleTaskRequest:
+ type: object
+ required:
+ - BundleId
+ title: CancelBundleTaskRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/BundleId'
+ - description: The ID of the bundle task.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for CancelBundleTask.
+ CancelCapacityReservationFleetErrorCode:
+ type: string
+ CancelCapacityReservationFleetErrorMessage:
+ type: string
+ CancelCapacityReservationFleetError:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/CancelCapacityReservationFleetErrorCode'
+ - description: The error code.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/CancelCapacityReservationFleetErrorMessage'
+ - description: The error message.
+ description: Describes a Capacity Reservation Fleet cancellation error.
+ CapacityReservationFleetIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationFleetId'
+ - xml:
+ name: item
+ CancelCapacityReservationFleetsRequest:
+ type: object
+ required:
+ - CapacityReservationFleetIds
+ title: CancelCapacityReservationFleetsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ CapacityReservationFleetId:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationFleetIdSet'
+ - description: The IDs of the Capacity Reservation Fleets to cancel.
+ CapacityReservationFleetCancellationStateSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationFleetCancellationState'
+ - xml:
+ name: item
+ FailedCapacityReservationFleetCancellationResultSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/FailedCapacityReservationFleetCancellationResult'
+ - xml:
+ name: item
+ CancelCapacityReservationRequest:
+ type: object
+ required:
+ - CapacityReservationId
+ title: CancelCapacityReservationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ CancelConversionRequest:
+ type: object
+ required:
+ - ConversionTaskId
+ title: CancelConversionRequest
+ properties:
+ conversionTaskId:
+ allOf:
+ - $ref: '#/components/schemas/ConversionTaskId'
+ - description: The ID of the conversion task.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ reasonMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The reason for canceling the conversion task.
+ ExportVmTaskId:
+ type: string
+ CancelExportTaskRequest:
+ type: object
+ required:
+ - ExportTaskId
+ title: CancelExportTaskRequest
+ properties:
+ exportTaskId:
+ allOf:
+ - $ref: '#/components/schemas/ExportVmTaskId'
+ - description: The ID of the export task. This is the ID returned by CreateInstanceExportTask.
+ ImportTaskId:
+ type: string
+ CancelImportTaskRequest:
+ type: object
+ title: CancelImportTaskRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ImportTaskId'
+ - description: The ID of the import image or import snapshot task to be canceled.
+ ReservedInstancesListingId:
+ type: string
+ CancelReservedInstancesListingRequest:
+ type: object
+ required:
+ - ReservedInstancesListingId
+ title: CancelReservedInstancesListingRequest
+ properties:
+ reservedInstancesListingId:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesListingId'
+ - description: The ID of the Reserved Instance listing.
+ description: Contains the parameters for CancelReservedInstancesListing.
+ ReservedInstancesListingList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesListing'
+ - xml:
+ name: item
+ CancelSpotFleetRequestsError:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/CancelBatchErrorCode'
+ - description: The error code.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description for the error code.
+ description: Describes a Spot Fleet error.
+ CancelSpotFleetRequestsErrorItem:
+ type: object
+ properties:
+ error:
+ allOf:
+ - $ref: '#/components/schemas/CancelSpotFleetRequestsError'
+ - description: The error.
+ spotFleetRequestId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Spot Fleet request.
+ description: Describes a Spot Fleet request that was not successfully canceled.
+ CancelSpotFleetRequestsErrorSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CancelSpotFleetRequestsErrorItem'
+ - xml:
+ name: item
+ SpotFleetRequestIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetRequestId'
+ - xml:
+ name: item
+ CancelSpotFleetRequestsRequest:
+ type: object
+ required:
+ - SpotFleetRequestIds
+ - TerminateInstances
+ title: CancelSpotFleetRequestsRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ spotFleetRequestId:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetRequestIdList'
+ - description: The IDs of the Spot Fleet requests.
+ terminateInstances:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
+ description: Contains the parameters for CancelSpotFleetRequests.
+ CancelSpotFleetRequestsSuccessSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CancelSpotFleetRequestsSuccessItem'
+ - xml:
+ name: item
+ CancelSpotFleetRequestsSuccessItem:
+ type: object
+ properties:
+ currentSpotFleetRequestState:
+ allOf:
+ - $ref: '#/components/schemas/BatchState'
+ - description: The current state of the Spot Fleet request.
+ previousSpotFleetRequestState:
+ allOf:
+ - $ref: '#/components/schemas/BatchState'
+ - description: The previous state of the Spot Fleet request.
+ spotFleetRequestId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Spot Fleet request.
+ description: Describes a Spot Fleet request that was successfully canceled.
+ CancelSpotInstanceRequestState:
+ type: string
+ enum:
+ - active
+ - open
+ - closed
+ - cancelled
+ - completed
+ SpotInstanceRequestIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SpotInstanceRequestId'
+ - xml:
+ name: SpotInstanceRequestId
+ CancelSpotInstanceRequestsRequest:
+ type: object
+ required:
+ - SpotInstanceRequestIds
+ title: CancelSpotInstanceRequestsRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SpotInstanceRequestId:
+ allOf:
+ - $ref: '#/components/schemas/SpotInstanceRequestIdList'
+ - description: One or more Spot Instance request IDs.
+ description: Contains the parameters for CancelSpotInstanceRequests.
+ CancelledSpotInstanceRequestList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CancelledSpotInstanceRequest'
+ - xml:
+ name: item
+ CancelledSpotInstanceRequest:
+ type: object
+ properties:
+ spotInstanceRequestId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Spot Instance request.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/CancelSpotInstanceRequestState'
+ - description: The state of the Spot Instance request.
+ description: Describes a request to cancel a Spot Instance.
+ CapacityReservationInstancePlatform:
+ type: string
+ enum:
+ - Linux/UNIX
+ - Red Hat Enterprise Linux
+ - SUSE Linux
+ - Windows
+ - Windows with SQL Server
+ - Windows with SQL Server Enterprise
+ - Windows with SQL Server Standard
+ - Windows with SQL Server Web
+ - Linux with SQL Server Standard
+ - Linux with SQL Server Web
+ - Linux with SQL Server Enterprise
+ - RHEL with SQL Server Standard
+ - RHEL with SQL Server Enterprise
+ - RHEL with SQL Server Web
+ - RHEL with HA
+ - RHEL with HA and SQL Server Standard
+ - RHEL with HA and SQL Server Enterprise
+ CapacityReservationTenancy:
+ type: string
+ enum:
+ - default
+ - dedicated
+ CapacityReservationState:
+ type: string
+ enum:
+ - active
+ - expired
+ - cancelled
+ - pending
+ - failed
+ EndDateType:
+ type: string
+ enum:
+ - unlimited
+ - limited
+ InstanceMatchCriteria:
+ type: string
+ enum:
+ - open
+ - targeted
+ OutpostArn:
+ type: string
+ pattern: '^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$'
+ PlacementGroupArn:
+ type: string
+ pattern: '^arn:aws([a-z-]+)?:ec2:[a-z\d-]+:\d{12}:placement-group/([^\s].+[^\s]){1,255}$'
+ CapacityReservation:
+ type: object
+ properties:
+ capacityReservationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Capacity Reservation.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the Capacity Reservation.
+ capacityReservationArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the Capacity Reservation.
+ availabilityZoneId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone ID of the Capacity Reservation.
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The type of instance for which the Capacity Reservation reserves capacity.
+ instancePlatform:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationInstancePlatform'
+ - description: The type of operating system for which the Capacity Reservation reserves capacity.
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone in which the capacity is reserved.
+ tenancy:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationTenancy'
+ - description: 'Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active - The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
expired when it reaches its end date and time.'
+ endDateType:
+ allOf:
+ - $ref: '#/components/schemas/EndDateType'
+ - description: 'Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
The state of the Capacity Reservation Fleet. Possible states include:
submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.
modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.
active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.
partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.
expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.
expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can''t create new Capacity Reservations.
cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.
cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can''t create new Capacity Reservations.
failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.
The tenancy of the Capacity Reservation Fleet. Tenancies include:
default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
' + description: 'Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
This strategy can only be used if the EC2 Fleet is of type instant.
For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.
' + CapacityReservationOptionsRequest: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/FleetCapacityReservationUsageStrategy' + - description: 'Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
' + description: 'Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
This strategy can only be used if the EC2 Fleet is of type instant.
For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.
' + CapacityReservationPreference: + type: string + enum: + - open + - none + CapacityReservationSet: + type: array + items: + allOf: + - $ref: '#/components/schemas/CapacityReservation' + - xml: + name: item + CapacityReservationSpecification: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/CapacityReservationTarget' + - description: Information about the target Capacity Reservation or Capacity Reservation group. + description: 'Describes an instance''s Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.
Describes the instance''s Capacity Reservation preferences. Possible preferences include:
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
capacityReservationPreference response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the capacityReservationTarget response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group.'
+ CarrierGatewayState:
+ type: string
+ enum:
+ - pending
+ - available
+ - deleting
+ - deleted
+ CarrierGateway:
+ type: object
+ properties:
+ carrierGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/CarrierGatewayId'
+ - description: The ID of the carrier gateway.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC associated with the carrier gateway.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/CarrierGatewayState'
+ - description: The state of the carrier gateway.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID of the owner of the carrier gateway.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the carrier gateway.
+ description: Describes a carrier gateway.
+ CarrierGatewayIdSet:
+ type: array
+ items:
+ $ref: '#/components/schemas/CarrierGatewayId'
+ CarrierGatewayMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ CarrierGatewaySet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CarrierGateway'
+ - xml:
+ name: item
+ CertificateAuthentication:
+ type: object
+ properties:
+ clientRootCertificateChain:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ARN of the client certificate. '
+ description: Information about the client certificate used for authentication.
+ CertificateAuthenticationRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in Certificate Manager (ACM).
+ description: Information about the client certificate to be used for authentication.
+ CidrAuthorizationContext:
+ type: object
+ required:
+ - Message
+ - Signature
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The signed authorization message for the prefix and account.
+ description: 'Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.'
+ CidrBlock:
+ type: object
+ properties:
+ cidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv4 CIDR block.
+ description: Describes an IPv4 CIDR block.
+ CidrBlockSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CidrBlock'
+ - xml:
+ name: item
+ ClassicLinkDnsSupport:
+ type: object
+ properties:
+ classicLinkDnsSupported:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether ClassicLink DNS support is enabled for the VPC.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ description: Describes the ClassicLink DNS support status of a VPC.
+ ClassicLinkDnsSupportList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ClassicLinkDnsSupport'
+ - xml:
+ name: item
+ GroupIdentifierList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/GroupIdentifier'
+ - xml:
+ name: item
+ ClassicLinkInstance:
+ type: object
+ properties:
+ groupSet:
+ allOf:
+ - $ref: '#/components/schemas/GroupIdentifierList'
+ - description: A list of security groups.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the instance.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ description: Describes a linked EC2-Classic instance.
+ ClassicLinkInstanceList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ClassicLinkInstance'
+ - xml:
+ name: item
+ ClassicLoadBalancer:
+ type: object
+ properties:
+ name:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the load balancer.
+ description: Describes a Classic Load Balancer.
+ ClassicLoadBalancers:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ClassicLoadBalancer'
+ - xml:
+ name: item
+ minItems: 1
+ maxItems: 5
+ ClassicLoadBalancersConfig:
+ type: object
+ properties:
+ classicLoadBalancers:
+ allOf:
+ - $ref: '#/components/schemas/ClassicLoadBalancers'
+ - description: One or more Classic Load Balancers.
+ description: Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers.
+ ClientCertificateRevocationListStatusCode:
+ type: string
+ enum:
+ - pending
+ - active
+ ClientCertificateRevocationListStatus:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/ClientCertificateRevocationListStatusCode'
+ - description: The state of the client certificate revocation list.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A message about the status of the client certificate revocation list, if applicable.'
+ description: Describes the state of a client certificate revocation list.
+ ClientConnectOptions:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
+ description: The options for managing connection authorization for new client connections.
+ ClientVpnEndpointAttributeStatus:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnEndpointAttributeStatusCode'
+ - description: The status code.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The status message.
+ description: Describes the status of the Client VPN endpoint attribute.
+ ClientConnectResponseOptions:
+ type: object
+ properties:
+ enabled:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether client connect options are enabled.
+ lambdaFunctionArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnEndpointAttributeStatus'
+ - description: The status of any updates to the client connect options.
+ description: The options for managing connection authorization for new client connections.
+ ClientData:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time that the disk upload starts.
+ description: Describes the client-specific data.
+ ClientLoginBannerOptions:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.
+ description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
+ ClientLoginBannerResponseOptions:
+ type: object
+ properties:
+ enabled:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Current state of text banner feature.
Valid values: true | false
The state of the Client VPN endpoint. Possible states include:
pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.
available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.
deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.
deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
' + vpnProtocol: + allOf: + - $ref: '#/components/schemas/VpnProtocol' + - description: The protocol used by the VPN session. + transportProtocol: + allOf: + - $ref: '#/components/schemas/TransportProtocol' + - description: The transport protocol used by the Client VPN endpoint. + vpnPort: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The port number for the Client VPN endpoint. + associatedTargetNetwork: + allOf: + - $ref: '#/components/schemas/AssociatedTargetNetworkSet' + - deprecated: true + description: 'Information about the associated target networks. A target network is a subnet in a VPC.This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.' + serverCertificateArn: + allOf: + - $ref: '#/components/schemas/String' + - description: The ARN of the server certificate. + authenticationOptions: + allOf: + - $ref: '#/components/schemas/ClientVpnAuthenticationList' + - description: Information about the authentication method used by the Client VPN endpoint. + connectionLogOptions: + allOf: + - $ref: '#/components/schemas/ConnectionLogResponseOptions' + - description: Information about the client connection logging options for the Client VPN endpoint. + tagSet: + allOf: + - $ref: '#/components/schemas/TagList' + - description: Any tags assigned to the Client VPN endpoint. + securityGroupIdSet: + allOf: + - $ref: '#/components/schemas/ClientVpnSecurityGroupIdSet' + - description: The IDs of the security groups for the target network. + vpcId: + allOf: + - $ref: '#/components/schemas/VpcId' + - description: The ID of the VPC. + selfServicePortalUrl: + allOf: + - $ref: '#/components/schemas/String' + - description: The URL of the self-service portal. + clientConnectOptions: + allOf: + - $ref: '#/components/schemas/ClientConnectResponseOptions' + - description: The options for managing connection authorization for new client connections. + sessionTimeoutHours: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnRouteStatus'
+ - description: The current state of the route.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A brief description of the route.
+ description: Information about a Client VPN endpoint route.
+ ClientVpnRouteSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnRoute'
+ - xml:
+ name: item
+ ClientVpnRouteStatusCode:
+ type: string
+ enum:
+ - creating
+ - active
+ - failed
+ - deleting
+ CoipAddressUsage:
+ type: object
+ properties:
+ allocationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The allocation ID of the address.
+ awsAccountId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID.
+ awsService:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services service.
+ coIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The customer-owned IP address.
+ description: Describes address usage for a customer-owned address pool.
+ CoipAddressUsageSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CoipAddressUsage'
+ - xml:
+ name: item
+ CoipPool:
+ type: object
+ properties:
+ poolId:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PoolCoipId'
+ - description: The ID of the address pool.
+ poolCidrSet:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The address ranges of the address pool.
+ localGatewayRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRoutetableId'
+ - description: The ID of the local gateway route table.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags.
+ poolArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The ARN of the address pool.
+ description: Describes a customer-owned address pool.
+ CoipPoolId:
+ type: string
+ CoipPoolIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PoolCoipId'
+ - xml:
+ name: item
+ CoipPoolMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ CoipPoolSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CoipPool'
+ - xml:
+ name: item
+ ConfirmProductInstanceRequest:
+ type: object
+ required:
+ - InstanceId
+ - ProductCode
+ title: ConfirmProductInstanceRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The product code. This must be a product code that you own.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ConnectionLogOptions:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the CloudWatch Logs log stream to which the connection data is published.
+ description: Describes the client connection logging options for the Client VPN endpoint.
+ ConnectionNotificationType:
+ type: string
+ enum:
+ - Topic
+ ConnectionNotificationState:
+ type: string
+ enum:
+ - Enabled
+ - Disabled
+ ConnectionNotification:
+ type: object
+ properties:
+ connectionNotificationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the notification.
+ serviceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the endpoint service.
+ vpcEndpointId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC endpoint.
+ connectionNotificationType:
+ allOf:
+ - $ref: '#/components/schemas/ConnectionNotificationType'
+ - description: The type of notification.
+ connectionNotificationArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ARN of the SNS topic for the notification.
+ connectionEvents:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: 'The events for the notification. Valid values are Accept, Connect, Delete, and Reject.'
+ connectionNotificationState:
+ allOf:
+ - $ref: '#/components/schemas/ConnectionNotificationState'
+ - description: The state of the notification.
+ description: Describes a connection notification for a VPC endpoint or VPC endpoint service.
+ ConnectionNotificationIdsList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ConnectionNotificationId'
+ - xml:
+ name: item
+ ConnectionNotificationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ConnectionNotification'
+ - xml:
+ name: item
+ ConnectivityType:
+ type: string
+ enum:
+ - private
+ - public
+ ConversionIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ConversionTaskId'
+ - xml:
+ name: item
+ ImportInstanceTaskDetails:
+ type: object
+ properties:
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the task.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance.
+ platform:
+ allOf:
+ - $ref: '#/components/schemas/PlatformValues'
+ - description: The instance operating system.
+ volumes:
+ allOf:
+ - $ref: '#/components/schemas/ImportInstanceVolumeDetailSet'
+ - description: The volumes.
+ description: Describes an import instance task.
+ ImportVolumeTaskDetails:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone where the resulting volume will reside.
+ bytesConverted:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: The number of bytes converted so far.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description you provided when starting the import volume task.
+ image:
+ allOf:
+ - $ref: '#/components/schemas/DiskImageDescription'
+ - description: The image.
+ volume:
+ allOf:
+ - $ref: '#/components/schemas/DiskImageVolumeDescription'
+ - description: The volume.
+ description: Describes an import volume task.
+ ConversionTaskState:
+ type: string
+ enum:
+ - active
+ - cancelling
+ - cancelled
+ - completed
+ ConversionTask:
+ type: object
+ properties:
+ conversionTaskId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the conversion task.
+ expirationTime:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The time when the task expires. If the upload isn''t complete before the expiration time, we automatically cancel the task.'
+ importInstance:
+ allOf:
+ - $ref: '#/components/schemas/ImportInstanceTaskDetails'
+ - description: 'If the task is for importing an instance, this contains information about the import instance task.'
+ importVolume:
+ allOf:
+ - $ref: '#/components/schemas/ImportVolumeTaskDetails'
+ - description: 'If the task is for importing a volume, this contains information about the import volume task.'
+ state:
+ allOf:
+ - $ref: '#/components/schemas/ConversionTaskState'
+ - description: The state of the conversion task.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The status message related to the conversion task.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the task.
+ description: Describes a conversion task.
+ CopyFpgaImageRequest:
+ type: object
+ required:
+ - SourceFpgaImageId
+ - SourceRegion
+ title: CopyFpgaImageRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.'
+ CopyImageRequest:
+ type: object
+ required:
+ - Name
+ - SourceImageId
+ - SourceRegion
+ title: CopyImageRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description for the new AMI in the destination Region.
+ encrypted:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.'
+ kmsKeyId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copying AMIs from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for CopyImage.
+ KmsKeyId:
+ type: string
+ CopySnapshotRequest:
+ type: object
+ required:
+ - SourceRegion
+ - SourceSnapshotId
+ title: CopySnapshotRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
' + destinationRegion: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.
The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is specified using the --region parameter or the default Region in your Amazon Web Services configuration file.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
' + presignedUrl: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the EBS snapshot to copy. + TagSpecification: + allOf: + - $ref: '#/components/schemas/TagSpecificationList' + - description: The tags to apply to the new snapshot. + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ CopyTagsFromSource:
+ type: string
+ enum:
+ - volume
+ CoreCount:
+ type: integer
+ CoreCountList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CoreCount'
+ - xml:
+ name: item
+ CoreNetworkArn:
+ type: string
+ CpuManufacturer:
+ type: string
+ enum:
+ - intel
+ - amd
+ - amazon-web-services
+ CpuManufacturerSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CpuManufacturer'
+ - xml:
+ name: item
+ CpuOptions:
+ type: object
+ properties:
+ coreCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of CPU cores for the instance.
+ threadsPerCore:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of threads per CPU core.
+ description: The CPU options for the instance.
+ CpuOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.'
+ description: The CPU options for the instance. Both the core count and threads per core must be specified in the request.
+ CreateCapacityReservationFleetRequest:
+ type: object
+ required:
+ - InstanceTypeSpecifications
+ - TotalTargetCapacity
+ title: CreateCapacityReservationFleetRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.'
+ InstanceTypeSpecification:
+ allOf:
+ - $ref: '#/components/schemas/FleetInstanceMatchCriteria'
+ - description: 'Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ CreateCapacityReservationRequest:
+ type: object
+ required:
+ - InstanceType
+ - InstancePlatform
+ - InstanceCount
+ title: CreateCapacityReservationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/PlacementGroupArn'
+ - description: 'The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.'
+ CreateCarrierGatewayRequest:
+ type: object
+ required:
+ - VpcId
+ title: CreateCarrierGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC to associate with the carrier gateway.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ CreateClientVpnEndpointRequest:
+ type: object
+ required:
+ - ClientCidrBlock
+ - ServerCertificateArn
+ - AuthenticationOptions
+ - ConnectionLogOptions
+ title: CreateClientVpnEndpointRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ARN of the server certificate. For more information, see the Certificate Manager User Guide.'
+ Authentication:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to apply to the Client VPN endpoint during creation.
+ SecurityGroupId:
+ allOf:
+ - $ref: '#/components/schemas/ClientLoginBannerOptions'
+ - description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
+ CreateClientVpnRouteRequest:
+ type: object
+ required:
+ - ClientVpnEndpointId
+ - DestinationCidrBlock
+ - TargetVpcSubnetId
+ title: CreateClientVpnRouteRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ GatewayType:
+ type: string
+ enum:
+ - ipsec.1
+ CreateCustomerGatewayRequest:
+ type: object
+ required:
+ - BgpAsn
+ - Type
+ title: CreateCustomerGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'For devices that support BGP, the customer gateway''s BGP ASN.
Default: 65000
' + IpAddress: + allOf: + - $ref: '#/components/schemas/GatewayType' + - description: The type of VPN connection that this customer gateway supports (ipsec.1).
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A name for the customer gateway device.
Length Constraints: Up to 255 characters.
' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for CreateCustomerGateway.
+ CustomerGateway:
+ type: object
+ properties:
+ bgpAsn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
+ customerGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the customer gateway.
+ ipAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Internet-routable IP address of the customer gateway's outside interface.
+ certificateArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) for the customer gateway certificate.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The current state of the customer gateway (pending | available | deleting | deleted).
+ type:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The type of VPN connection the customer gateway supports (ipsec.1).
+ deviceName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of customer gateway device.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the customer gateway.
+ description: Describes a customer gateway.
+ CreateDefaultSubnetRequest:
+ type: object
+ required:
+ - AvailabilityZone
+ title: CreateDefaultSubnetRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.'
+ Subnet:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone of the subnet.
+ availabilityZoneId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The AZ ID of the subnet.
+ availableIpAddressCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
+ cidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv4 CIDR block assigned to the subnet.
+ defaultForAz:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether this is the default subnet for the Availability Zone.
+ enableLniAtDeviceIndex:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: ' Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1). '
+ mapPublicIpOnLaunch:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether instances launched in this subnet receive a public IPv4 address.
+ mapCustomerOwnedIpOnLaunch:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
+ customerOwnedIpv4Pool:
+ allOf:
+ - $ref: '#/components/schemas/CoipPoolId'
+ - description: The customer-owned IPv4 address pool associated with the subnet.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/SubnetState'
+ - description: The current state of the subnet.
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the subnet.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC the subnet is in.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the subnet.
+ assignIpv6AddressOnCreation:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
+ ipv6CidrBlockAssociationSet:
+ allOf:
+ - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociationSet'
+ - description: Information about the IPv6 CIDR blocks associated with the subnet.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the subnet.
+ subnetArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the subnet.
+ outpostArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the Outpost.
+ enableDns64:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
+ ipv6Native:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether this is an IPv6 only subnet.
+ privateDnsNameOptionsOnLaunch:
+ allOf:
+ - $ref: '#/components/schemas/PrivateDnsNameOptionsOnLaunch'
+ - description: The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.
+ description: Describes a subnet.
+ CreateDefaultVpcRequest:
+ type: object
+ title: CreateDefaultVpcRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Vpc:
+ type: object
+ properties:
+ cidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The primary IPv4 CIDR block for the VPC.
+ dhcpOptionsId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the set of DHCP options you've associated with the VPC.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/VpcState'
+ - description: The current state of the VPC.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the VPC.
+ instanceTenancy:
+ allOf:
+ - $ref: '#/components/schemas/Tenancy'
+ - description: The allowed tenancy of instances launched into the VPC.
+ ipv6CidrBlockAssociationSet:
+ allOf:
+ - $ref: '#/components/schemas/VpcIpv6CidrBlockAssociationSet'
+ - description: Information about the IPv6 CIDR blocks associated with the VPC.
+ cidrBlockAssociationSet:
+ allOf:
+ - $ref: '#/components/schemas/VpcCidrBlockAssociationSet'
+ - description: Information about the IPv4 CIDR blocks associated with the VPC.
+ isDefault:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the VPC is the default VPC.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the VPC.
+ description: Describes a VPC.
+ NewDhcpConfigurationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NewDhcpConfiguration'
+ - xml:
+ name: item
+ CreateDhcpOptionsRequest:
+ type: object
+ required:
+ - DhcpConfigurations
+ title: CreateDhcpOptionsRequest
+ properties:
+ dhcpConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/NewDhcpConfigurationList'
+ - description: A DHCP configuration option.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to assign to the DHCP option.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DhcpOptions:
+ type: object
+ properties:
+ dhcpConfigurationSet:
+ allOf:
+ - $ref: '#/components/schemas/DhcpConfigurationList'
+ - description: One or more DHCP options in the set.
+ dhcpOptionsId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the set of DHCP options.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the DHCP options set.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the DHCP options set.
+ description: Describes a set of DHCP options.
+ CreateEgressOnlyInternetGatewayRequest:
+ type: object
+ required:
+ - VpcId
+ title: CreateEgressOnlyInternetGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC for which to create the egress-only internet gateway.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to assign to the egress-only internet gateway.
+ EgressOnlyInternetGateway:
+ type: object
+ properties:
+ attachmentSet:
+ allOf:
+ - $ref: '#/components/schemas/InternetGatewayAttachmentList'
+ - description: Information about the attachment of the egress-only internet gateway.
+ egressOnlyInternetGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
+ - description: The ID of the egress-only internet gateway.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the egress-only internet gateway.
+ description: Describes an egress-only internet gateway.
+ LaunchTemplateAndOverridesResponse:
+ type: object
+ properties:
+ launchTemplateSpecification:
+ allOf:
+ - $ref: '#/components/schemas/FleetLaunchTemplateSpecification'
+ - description: The launch template.
+ overrides:
+ allOf:
+ - $ref: '#/components/schemas/FleetLaunchTemplateOverrides'
+ - description: Any parameters that you specify override the same parameters in the launch template.
+ description: Describes a launch template and overrides.
+ InstanceLifecycle:
+ type: string
+ enum:
+ - spot
+ - on-demand
+ CreateFleetError:
+ type: object
+ properties:
+ launchTemplateAndOverrides:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
+ - description: The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
+ lifecycle:
+ allOf:
+ - $ref: '#/components/schemas/InstanceLifecycle'
+ - description: Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
+ errorCode:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.'
+ errorMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.'
+ description: Describes the instances that could not be launched by the fleet.
+ CreateFleetErrorsSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CreateFleetError'
+ - xml:
+ name: item
+ InstanceIdsSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - xml:
+ name: item
+ PlatformValues:
+ type: string
+ enum:
+ - Windows
+ CreateFleetInstance:
+ type: object
+ properties:
+ launchTemplateAndOverrides:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
+ - description: The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
+ lifecycle:
+ allOf:
+ - $ref: '#/components/schemas/InstanceLifecycle'
+ - description: Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
+ instanceIds:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdsSet'
+ - description: The IDs of the instances.
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/InstanceType'
+ - description: The instance type.
+ platform:
+ allOf:
+ - $ref: '#/components/schemas/PlatformValues'
+ - description: 'The value is Windows for Windows instances. Otherwise, the value is blank.'
+ description: Describes the instances that were launched by the fleet.
+ CreateFleetInstancesSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CreateFleetInstance'
+ - xml:
+ name: item
+ CreateFleetRequest:
+ type: object
+ required:
+ - LaunchTemplateConfigs
+ - TargetCapacitySpecification
+ title: CreateFleetRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Reserved.
+ DestinationOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is false.
+ description: Describes the destination options for a flow log.
+ CreateFlowLogsRequest:
+ type: object
+ required:
+ - ResourceIds
+ - ResourceType
+ - TrafficType
+ title: CreateFlowLogsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow log records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.
Specify the fields using the ${field-id} format, separated by spaces. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of the instance.
+ name:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)
' + noReboot: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.
If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can''t guarantee the file system integrity of the created image.
Default: false (follow standard reboot process)
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
To tag the AMI, the value for ResourceType must be image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
' + InstanceEventWindowCronExpression: + type: string + CreateInstanceEventWindowRequest: + type: object + title: CreateInstanceEventWindowRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The name of the event window. + TimeRange: + allOf: + - $ref: '#/components/schemas/InstanceEventWindowCronExpression' + - description: 'The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can''t specify a time range.
Constraints:
Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
' + TagSpecification: + allOf: + - $ref: '#/components/schemas/TagSpecificationList' + - description: The tags to apply to the event window. + ExportToS3TaskSpecification: + type: object + properties: + containerFormat: + allOf: + - $ref: '#/components/schemas/ContainerFormat' + - description: 'The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.' + diskImageFormat: + allOf: + - $ref: '#/components/schemas/DiskImageFormat' + - description: The format for the exported image. + s3Bucket: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services accountvm-import-export@amazon.com.
+ s3Prefix:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
+ description: Describes an export instance task.
+ ExportEnvironment:
+ type: string
+ enum:
+ - citrix
+ - vmware
+ - microsoft
+ CreateInstanceExportTaskRequest:
+ type: object
+ required:
+ - ExportToS3Task
+ - InstanceId
+ - TargetEnvironment
+ title: CreateInstanceExportTaskRequest
+ properties:
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description for the conversion task or the resource being exported. The maximum length is 255 characters.
+ exportToS3:
+ allOf:
+ - $ref: '#/components/schemas/ExportToS3TaskSpecification'
+ - description: The format and location for an export instance task.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of the instance.
+ targetEnvironment:
+ allOf:
+ - $ref: '#/components/schemas/ExportEnvironment'
+ - description: The target virtualization environment.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to apply to the export instance task during creation.
+ ExportTask:
+ type: object
+ properties:
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the resource being exported.
+ exportTaskId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the export task.
+ exportToS3:
+ allOf:
+ - $ref: '#/components/schemas/ExportToS3Task'
+ - description: Information about the export task.
+ instanceExport:
+ allOf:
+ - $ref: '#/components/schemas/InstanceExportDetails'
+ - description: Information about the instance to export.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/ExportTaskState'
+ - description: The state of the export task.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The status message related to the export task.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for the export task.
+ description: Describes an export instance task.
+ CreateInternetGatewayRequest:
+ type: object
+ title: CreateInternetGatewayRequest
+ properties:
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to assign to the internet gateway.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ InternetGateway:
+ type: object
+ properties:
+ attachmentSet:
+ allOf:
+ - $ref: '#/components/schemas/InternetGatewayAttachmentList'
+ - description: Any VPCs attached to the internet gateway.
+ internetGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the internet gateway.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the internet gateway.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the internet gateway.
+ description: Describes an internet gateway.
+ IpamNetmaskLength:
+ type: integer
+ minimum: 0
+ maximum: 128
+ RequestIpamResourceTagList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/RequestIpamResourceTag'
+ - xml:
+ name: item
+ IpamPoolAwsService:
+ type: string
+ enum:
+ - ec2
+ CreateIpamPoolRequest:
+ type: object
+ required:
+ - IpamScopeId
+ - AddressFamily
+ title: CreateIpamPoolRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/IpamNetmaskLength'
+ - description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.'
+ AllocationResourceTag:
+ allOf:
+ - $ref: '#/components/schemas/RequestIpamResourceTagList'
+ - description: 'Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolAwsService'
+ - description: 'Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.'
+ IpamPool:
+ type: object
+ properties:
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID of the owner of the IPAM pool.
+ ipamPoolId:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolId'
+ - description: The ID of the IPAM pool.
+ sourceIpamPoolId:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolId'
+ - description: The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
+ ipamPoolArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The ARN of the IPAM pool.
+ ipamScopeArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The ARN of the scope of the IPAM pool.
+ ipamScopeType:
+ allOf:
+ - $ref: '#/components/schemas/IpamScopeType'
+ - description: 'In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.'
+ ipamArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The ARN of the IPAM.
+ ipamRegion:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services Region of the IPAM pool.
+ locale:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you''ll get an error.'
+ poolDepth:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide. '
+ state:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolState'
+ - description: The state of the IPAM pool.
+ stateMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A message related to the failed creation of an IPAM pool.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the IPAM pool.
+ autoImport:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
' + publiclyAdvertisable: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set toipv4.
+ addressFamily:
+ allOf:
+ - $ref: '#/components/schemas/AddressFamily'
+ - description: The address family of the pool.
+ allocationMinNetmaskLength:
+ allOf:
+ - $ref: '#/components/schemas/IpamNetmaskLength'
+ - description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
+ allocationMaxNetmaskLength:
+ allOf:
+ - $ref: '#/components/schemas/IpamNetmaskLength'
+ - description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
+ allocationDefaultNetmaskLength:
+ allOf:
+ - $ref: '#/components/schemas/IpamNetmaskLength'
+ - description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.'
+ allocationResourceTagSet:
+ allOf:
+ - $ref: '#/components/schemas/IpamResourceTagList'
+ - description: 'Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.'
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
+ awsService:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolAwsService'
+ - description: 'Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.'
+ description: 'In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.'
+ CreateIpamRequest:
+ type: object
+ title: CreateIpamRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description for the IPAM.
+ OperatingRegion:
+ allOf:
+ - $ref: '#/components/schemas/AddIpamOperatingRegionSet'
+ - description: 'The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' + TagSpecification: + allOf: + - $ref: '#/components/schemas/String' + - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' + Ipam: + type: object + properties: + ownerId: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Web Services account ID of the owner of the IPAM. + ipamId: + allOf: + - $ref: '#/components/schemas/IpamId' + - description: The ID of the IPAM. + ipamArn: + allOf: + - $ref: '#/components/schemas/ResourceArn' + - description: The ARN of the IPAM. + ipamRegion: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Web Services Region of the IPAM. + publicDefaultScopeId: + allOf: + - $ref: '#/components/schemas/IpamScopeId' + - description: The ID of the IPAM's default public scope. + privateDefaultScopeId: + allOf: + - $ref: '#/components/schemas/IpamScopeId' + - description: The ID of the IPAM's default private scope. + scopeCount: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide. ' + description: + allOf: + - $ref: '#/components/schemas/String' + - description: The description for the IPAM. + operatingRegionSet: + allOf: + - $ref: '#/components/schemas/IpamOperatingRegionSet' + - description: 'The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' + state: + allOf: + - $ref: '#/components/schemas/IpamState' + - description: The state of the IPAM. + tagSet: + allOf: + - $ref: '#/components/schemas/TagList' + - description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
+ description: 'IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.'
+ CreateIpamScopeRequest:
+ type: object
+ required:
+ - IpamId
+ title: CreateIpamScopeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description for the scope you're creating.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
+ IpamScope:
+ type: object
+ properties:
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID of the owner of the scope.
+ ipamScopeId:
+ allOf:
+ - $ref: '#/components/schemas/IpamScopeId'
+ - description: The ID of the scope.
+ ipamScopeArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The ARN of the scope.
+ ipamArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The ARN of the IPAM.
+ ipamRegion:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services Region of the IPAM scope.
+ ipamScopeType:
+ allOf:
+ - $ref: '#/components/schemas/IpamScopeType'
+ - description: The type of the scope.
+ isDefault:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Defines if the scope is the default scope or not.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the scope.
+ poolCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of pools in the scope.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/IpamScopeState'
+ - description: The state of the IPAM scope.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
+ description: 'In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see How IPAM works in the Amazon VPC IPAM User Guide.
' + KeyType: + type: string + enum: + - rsa + - ed25519 + KeyFormat: + type: string + enum: + - pem + - ppk + CreateKeyPairRequest: + type: object + required: + - KeyName + title: CreateKeyPairRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: 'A unique name for the key pair.
Constraints: Up to 255 ASCII characters
' + dryRun: + allOf: + - $ref: '#/components/schemas/KeyType' + - description: 'The type of key pair. Note that ED25519 keys are not supported for Windows instances.
Default: rsa
The format of the key pair.
Default: pem
The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance at Launch (Linux) or Adding User Data (Windows).
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
' + TagSpecification: + allOf: + - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequestList' + - description: 'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.' + ElasticGpuSpecification: + allOf: + - $ref: '#/components/schemas/ElasticGpuSpecificationList' + - description: An elastic GPU to associate with the instance. + ElasticInferenceAccelerator: + allOf: + - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorList' + - description: ' The elastic inference accelerator for the instance. ' + SecurityGroupId: + allOf: + - $ref: '#/components/schemas/SecurityGroupIdStringList' + - description: 'One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.' + SecurityGroup: + allOf: + - $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationRequest' + - description: 'The Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults toopen, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
+ LicenseSpecification:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptionsRequest'
+ - description: The maintenance options for the instance.
+ description: The information to include in the launch template.
You must specify at least one parameter for the launch template data.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ LocalGatewayRoute:
+ type: object
+ properties:
+ destinationCidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The CIDR block used for destination matches.
+ localGatewayVirtualInterfaceGroupId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
+ - description: The ID of the virtual interface group.
+ type:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteType'
+ - description: The route type.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteState'
+ - description: The state of the route.
+ localGatewayRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRoutetableId'
+ - description: The ID of the local gateway route table.
+ localGatewayRouteTableArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The Amazon Resource Name (ARN) of the local gateway route table.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the local gateway route.
+ description: Describes a route for a local gateway route table.
+ CreateLocalGatewayRouteTableVpcAssociationRequest:
+ type: object
+ required:
+ - LocalGatewayRouteTableId
+ - VpcId
+ title: CreateLocalGatewayRouteTableVpcAssociationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ LocalGatewayRouteTableVpcAssociation:
+ type: object
+ properties:
+ localGatewayRouteTableVpcAssociationId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId'
+ - description: The ID of the association.
+ localGatewayRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the local gateway route table.
+ localGatewayRouteTableArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The Amazon Resource Name (ARN) of the local gateway route table for the association.
+ localGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the local gateway.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the local gateway route table for the association.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The state of the association.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the association.
+ description: Describes an association between a local gateway route table and a VPC.
+ CreateManagedPrefixListRequest:
+ type: object
+ required:
+ - PrefixListName
+ - MaxEntries
+ - AddressFamily
+ title: CreateManagedPrefixListRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Up to 255 UTF-8 characters in length.
' + ManagedPrefixList: + type: object + properties: + prefixListId: + allOf: + - $ref: '#/components/schemas/PrefixListResourceId' + - description: The ID of the prefix list. + addressFamily: + allOf: + - $ref: '#/components/schemas/String' + - description: The IP address version. + state: + allOf: + - $ref: '#/components/schemas/PrefixListState' + - description: The current state of the prefix list. + stateMessage: + allOf: + - $ref: '#/components/schemas/String' + - description: The state message. + prefixListArn: + allOf: + - $ref: '#/components/schemas/ResourceArn' + - description: The Amazon Resource Name (ARN) for the prefix list. + prefixListName: + allOf: + - $ref: '#/components/schemas/String' + - description: The name of the prefix list. + maxEntries: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The maximum number of entries for the prefix list. + version: + allOf: + - $ref: '#/components/schemas/Long' + - description: The version of the prefix list. + tagSet: + allOf: + - $ref: '#/components/schemas/TagList' + - description: The tags for the prefix list. + ownerId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the owner of the prefix list. + description: Describes a managed prefix list. + CreateNatGatewayRequest: + type: object + required: + - SubnetId + title: CreateNatGatewayRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/SubnetId' + - description: The subnet in which to create the NAT gateway. + TagSpecification: + allOf: + - $ref: '#/components/schemas/ConnectivityType' + - description: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity. + NatGateway: + type: object + properties: + createTime: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: The date and time the NAT gateway was created. + deleteTime: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: 'The date and time the NAT gateway was deleted, if applicable.' + failureCode: + allOf: + - $ref: '#/components/schemas/String' + - description: 'If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)'
+ failureMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
The state of the NAT gateway.
pending: The NAT gateway is being created and is not ready to process traffic.
failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.
available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.
deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.
deleted: The NAT gateway has been terminated and is no longer processing traffic.
172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.'
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ egress:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
+ Icmp:
+ allOf:
+ - $ref: '#/components/schemas/IcmpTypeCode'
+ - description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.'
+ ipv6CidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).'
+ networkAclId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAclId'
+ - description: The ID of the network ACL.
+ portRange:
+ allOf:
+ - $ref: '#/components/schemas/PortRange'
+ - description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).'
+ protocol:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.'
+ ruleAction:
+ allOf:
+ - $ref: '#/components/schemas/RuleAction'
+ - description: Indicates whether to allow or deny the traffic that matches the rule.
+ ruleNumber:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
' + CreateNetworkAclRequest: + type: object + required: + - VpcId + title: CreateNetworkAclRequest + properties: + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to assign to the network ACL.
+ NetworkAcl:
+ type: object
+ properties:
+ associationSet:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAclAssociationList'
+ - description: Any associations between the network ACL and one or more subnets
+ entrySet:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAclEntryList'
+ - description: One or more entries (rules) in the network ACL.
+ default:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether this is the default network ACL for the VPC.
+ networkAclId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network ACL.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the network ACL.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC for the network ACL.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the network ACL.
+ description: Describes a network ACL.
+ CreateNetworkInsightsAccessScopeRequest:
+ type: object
+ required:
+ - ClientToken
+ title: CreateNetworkInsightsAccessScopeRequest
+ properties:
+ MatchPath:
+ allOf:
+ - $ref: '#/components/schemas/AccessScopePathListRequest'
+ - description: The paths to match.
+ ExcludePath:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ NetworkInsightsAccessScope:
+ type: object
+ properties:
+ networkInsightsAccessScopeId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
+ - description: The ID of the Network Access Scope.
+ networkInsightsAccessScopeArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The Amazon Resource Name (ARN) of the Network Access Scope.
+ createdDate:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The creation date.
+ updatedDate:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The last updated date.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags.
+ description: Describes a Network Access Scope.
+ NetworkInsightsAccessScopeContent:
+ type: object
+ properties:
+ networkInsightsAccessScopeId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
+ - description: The ID of the Network Access Scope.
+ matchPathSet:
+ allOf:
+ - $ref: '#/components/schemas/AccessScopePathList'
+ - description: The paths to match.
+ excludePathSet:
+ allOf:
+ - $ref: '#/components/schemas/AccessScopePathList'
+ - description: The paths to exclude.
+ description: Describes the Network Access Scope content.
+ CreateNetworkInsightsPathRequest:
+ type: object
+ required:
+ - Source
+ - Destination
+ - Protocol
+ - ClientToken
+ title: CreateNetworkInsightsPathRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Port'
+ - description: The destination port.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ NetworkInsightsPath:
+ type: object
+ properties:
+ networkInsightsPathId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsPathId'
+ - description: The ID of the path.
+ networkInsightsPathArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The Amazon Resource Name (ARN) of the path.
+ createdDate:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time stamp when the path was created.
+ source:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services resource that is the source of the path.
+ destination:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services resource that is the destination of the path.
+ sourceIp:
+ allOf:
+ - $ref: '#/components/schemas/IpAddress'
+ - description: The IP address of the Amazon Web Services resource that is the source of the path.
+ destinationIp:
+ allOf:
+ - $ref: '#/components/schemas/IpAddress'
+ - description: The IP address of the Amazon Web Services resource that is the destination of the path.
+ protocol:
+ allOf:
+ - $ref: '#/components/schemas/Protocol'
+ - description: The protocol.
+ destinationPort:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The destination port.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags associated with the path.
+ description: Describes a path.
+ CreateNetworkInterfacePermissionRequest:
+ type: object
+ required:
+ - NetworkInterfaceId
+ - Permission
+ title: CreateNetworkInterfacePermissionRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for CreateNetworkInterfacePermission.
+ NetworkInterfacePermission:
+ type: object
+ properties:
+ networkInterfacePermissionId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network interface permission.
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network interface.
+ awsAccountId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID.
+ awsService:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Service.
+ permission:
+ allOf:
+ - $ref: '#/components/schemas/InterfacePermissionType'
+ - description: The type of permission.
+ permissionState:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfacePermissionState'
+ - description: Information about the state of the permission.
+ description: Describes a permission for a network interface.
+ InstanceIpv6AddressList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIpv6Address'
+ - xml:
+ name: item
+ PrivateIpAddressSpecificationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PrivateIpAddressSpecification'
+ - xml:
+ name: item
+ NetworkInterfaceCreationType:
+ type: string
+ enum:
+ - efa
+ - branch
+ - trunk
+ CreateNetworkInterfaceRequest:
+ type: object
+ required:
+ - SubnetId
+ title: CreateNetworkInterfaceRequest
+ properties:
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description for the network interface.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SecurityGroupId:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupIdStringList'
+ - description: The IDs of one or more security groups.
+ ipv6AddressCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can''t use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.'
+ ipv6Addresses:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIpv6AddressList'
+ - description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
+ privateIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The primary private IPv4 address of the network interface. If you don''t specify an IPv4 address, Amazon EC2 selects one for you from the subnet''s IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).'
+ privateIpAddresses:
+ allOf:
+ - $ref: '#/components/schemas/PrivateIpAddressSpecificationList'
+ - description: One or more private IPv4 addresses.
+ secondaryPrivateIpAddressCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet''s IPv4 CIDR range. You can''t specify this option and specify more than one private IP address using privateIpAddresses.
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.
' + Ipv4Prefix: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use theIpv4 Prefixes option.
+ Ipv6Prefix:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceCreationType'
+ - description: The type of network interface. The default is interface.
The only supported values are efa and trunk.
true, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.'
+ ipv6Native:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether this is an IPv6 only network interface.
+ ipv6Address:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 globally unique address associated with the network interface.
+ description: Describes a network interface.
+ CreatePlacementGroupRequest:
+ type: object
+ title: CreatePlacementGroupRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ groupName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A name for the placement group. Must be unique within the scope of your account for the Region.
Constraints: Up to 255 ASCII characters
' + strategy: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The number of partitions. Valid only when Strategy is set topartition.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to apply to the new placement group.
+ PlacementGroup:
+ type: object
+ properties:
+ groupName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the placement group.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/PlacementGroupState'
+ - description: The state of the placement group.
+ strategy:
+ allOf:
+ - $ref: '#/components/schemas/PlacementStrategy'
+ - description: The placement strategy.
+ partitionCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of partitions. Valid only if strategy is set to partition.
+ groupId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the placement group.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags applied to the placement group.
+ groupArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the placement group.
+ description: Describes a placement group.
+ CreatePublicIpv4PoolRequest:
+ type: object
+ title: CreatePublicIpv4PoolRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
+ CreateReplaceRootVolumeTaskRequest:
+ type: object
+ required:
+ - InstanceId
+ title: CreateReplaceRootVolumeTaskRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to apply to the root volume replacement task.
+ ReplaceRootVolumeTask:
+ type: object
+ properties:
+ replaceRootVolumeTaskId:
+ allOf:
+ - $ref: '#/components/schemas/ReplaceRootVolumeTaskId'
+ - description: The ID of the root volume replacement task.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance for which the root volume replacement task was created.
+ taskState:
+ allOf:
+ - $ref: '#/components/schemas/ReplaceRootVolumeTaskState'
+ - description: 'The state of the task. The task can be in one of the following states:
pending - the replacement volume is being created.
in-progress - the original volume is being detached and the replacement volume is being attached.
succeeded - the replacement volume has been successfully attached to the instance and the instance is available.
failing - the replacement task is in the process of failing.
failed - the replacement task has failed but the original root volume is still attached.
failing-detached - the replacement task is in the process of failing. The instance might have no root volume attached.
failed-detached - the replacement task has failed and the instance has no root volume attached.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ CreateRouteRequest:
+ type: object
+ required:
+ - RouteTableId
+ title: CreateRouteRequest
+ properties:
+ destinationCidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.'
+ destinationIpv6CidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListResourceId'
+ - description: The ID of a prefix list used for the destination match.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointId'
+ - description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
+ egressOnlyInternetGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
+ - description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
+ gatewayId:
+ allOf:
+ - $ref: '#/components/schemas/RouteGatewayId'
+ - description: The ID of an internet gateway or virtual private gateway attached to your VPC.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
+ natGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/CarrierGatewayId'
+ - description: The ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
+ networkInterfaceId: + allOf: + - $ref: '#/components/schemas/NetworkInterfaceId' + - description: The ID of a network interface. + routeTableId: + allOf: + - $ref: '#/components/schemas/RouteTableId' + - description: The ID of the route table for the route. + vpcPeeringConnectionId: + allOf: + - $ref: '#/components/schemas/CoreNetworkArn' + - description: The Amazon Resource Name (ARN) of the core network. + CreateRouteTableRequest: + type: object + required: + - VpcId + title: CreateRouteTableRequest + properties: + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to assign to the route table.
+ RouteTable:
+ type: object
+ properties:
+ associationSet:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableAssociationList'
+ - description: The associations between the route table and one or more subnets or a gateway.
+ propagatingVgwSet:
+ allOf:
+ - $ref: '#/components/schemas/PropagatingVgwList'
+ - description: Any virtual private gateway (VGW) propagating routes.
+ routeTableId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the route table.
+ routeSet:
+ allOf:
+ - $ref: '#/components/schemas/RouteList'
+ - description: The routes in the route table.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the route table.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the route table.
+ description: Describes a route table.
+ CreateSecurityGroupRequest:
+ type: object
+ required:
+ - Description
+ - GroupName
+ title: CreateSecurityGroupRequest
+ properties:
+ GroupDescription:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: '[EC2-VPC] The ID of the VPC. Required for EC2-VPC.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to assign to the security group.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ CreateSnapshotRequest:
+ type: object
+ required:
+ - VolumeId
+ title: CreateSnapshotRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VolumeId'
+ - description: The ID of the Amazon EBS volume.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to apply to the snapshot during creation.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ CreateSnapshotsRequest:
+ type: object
+ required:
+ - InstanceSpecification
+ title: CreateSnapshotsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.
To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.
To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.
To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.
For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.
' + TagSpecification: + allOf: + - $ref: '#/components/schemas/CopyTagsFromSource' + - description: Copies the tags from the specified volume to corresponding snapshot. + SnapshotSet: + type: array + items: + allOf: + - $ref: '#/components/schemas/SnapshotInfo' + - xml: + name: item + CreateSpotDatafeedSubscriptionRequest: + type: object + required: + - Bucket + title: CreateSpotDatafeedSubscriptionRequest + properties: + bucket: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ prefix:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The prefix for the data feed file names.
+ description: Contains the parameters for CreateSpotDatafeedSubscription.
+ SpotDatafeedSubscription:
+ type: object
+ properties:
+ bucket:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the Amazon S3 bucket where the Spot Instance data feed is located.
+ fault:
+ allOf:
+ - $ref: '#/components/schemas/SpotInstanceStateFault'
+ - description: 'The fault codes for the Spot Instance request, if any.'
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID of the account.
+ prefix:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The prefix for the data feed files.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/DatafeedSubscriptionState'
+ - description: The state of the Spot Instance data feed subscription.
+ description: Describes the data feed for a Spot Instance.
+ CreateStoreImageTaskRequest:
+ type: object
+ required:
+ - ImageId
+ - Bucket
+ title: CreateStoreImageTaskRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed. '
+ S3ObjectTag:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ CreateSubnetCidrReservationRequest:
+ type: object
+ required:
+ - SubnetId
+ - Cidr
+ - ReservationType
+ title: CreateSubnetCidrReservationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to assign to the subnet CIDR reservation.
+ SubnetCidrReservation:
+ type: object
+ properties:
+ subnetCidrReservationId:
+ allOf:
+ - $ref: '#/components/schemas/SubnetCidrReservationId'
+ - description: The ID of the subnet CIDR reservation.
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - description: The ID of the subnet.
+ cidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The CIDR that has been reserved.
+ reservationType:
+ allOf:
+ - $ref: '#/components/schemas/SubnetCidrReservationType'
+ - description: 'The type of reservation. '
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ID of the account that owns the subnet CIDR reservation. '
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description assigned to the subnet CIDR reservation.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the subnet CIDR reservation.
+ description: Describes a subnet CIDR reservation.
+ CreateSubnetRequest:
+ type: object
+ required:
+ - VpcId
+ title: CreateSubnetRequest
+ properties:
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to create an IPv6 only subnet.
+ ResourceIdList:
+ type: array
+ items:
+ $ref: '#/components/schemas/TaggableResourceId'
+ CreateTagsRequest:
+ type: object
+ required:
+ - Resources
+ - Tags
+ title: CreateTagsRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ResourceId:
+ allOf:
+ - $ref: '#/components/schemas/ResourceIdList'
+ - description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' + Tag: + allOf: + - $ref: '#/components/schemas/TagList' + - description: 'The tags. Thevalue parameter is required, but if you don''t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.'
+ CreateTrafficMirrorFilterRequest:
+ type: object
+ title: CreateTrafficMirrorFilterRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the Traffic Mirror filter.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ TrafficMirrorFilter:
+ type: object
+ properties:
+ trafficMirrorFilterId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Traffic Mirror filter.
+ ingressFilterRuleSet:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorFilterRuleList'
+ - description: Information about the ingress rules that are associated with the Traffic Mirror filter.
+ egressFilterRuleSet:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorFilterRuleList'
+ - description: Information about the egress rules that are associated with the Traffic Mirror filter.
+ networkServiceSet:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorNetworkServiceList'
+ - description: The network service traffic that is associated with the Traffic Mirror filter.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the Traffic Mirror filter.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the Traffic Mirror filter.
+ description: Describes the Traffic Mirror filter.
+ CreateTrafficMirrorFilterRuleRequest:
+ type: object
+ required:
+ - TrafficMirrorFilterId
+ - TrafficDirection
+ - RuleNumber
+ - RuleAction
+ - DestinationCidrBlock
+ - SourceCidrBlock
+ title: CreateTrafficMirrorFilterRuleRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ TrafficMirrorFilterRule:
+ type: object
+ properties:
+ trafficMirrorFilterRuleId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Traffic Mirror rule.
+ trafficMirrorFilterId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Traffic Mirror filter that the rule is associated with.
+ trafficDirection:
+ allOf:
+ - $ref: '#/components/schemas/TrafficDirection'
+ - description: The traffic direction assigned to the Traffic Mirror rule.
+ ruleNumber:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The rule number of the Traffic Mirror rule.
+ ruleAction:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorRuleAction'
+ - description: The action assigned to the Traffic Mirror rule.
+ protocol:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The protocol assigned to the Traffic Mirror rule.
+ destinationPortRange:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorPortRange'
+ - description: The destination port range assigned to the Traffic Mirror rule.
+ sourcePortRange:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorPortRange'
+ - description: The source port range assigned to the Traffic Mirror rule.
+ destinationCidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The destination CIDR block assigned to the Traffic Mirror rule.
+ sourceCidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The source CIDR block assigned to the Traffic Mirror rule.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the Traffic Mirror rule.
+ description: Describes the Traffic Mirror rule.
+ CreateTrafficMirrorSessionRequest:
+ type: object
+ required:
+ - NetworkInterfaceId
+ - TrafficMirrorTargetId
+ - TrafficMirrorFilterId
+ - SessionNumber
+ title: CreateTrafficMirrorSessionRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the Traffic Mirror session.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ TrafficMirrorSession:
+ type: object
+ properties:
+ trafficMirrorSessionId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID for the Traffic Mirror session.
+ trafficMirrorTargetId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Traffic Mirror target.
+ trafficMirrorFilterId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Traffic Mirror filter.
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Traffic Mirror session's network interface.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the account that owns the Traffic Mirror session.
+ packetLength:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet'
+ sessionNumber:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
Valid values are 1-32766.
+ virtualNetworkId: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The virtual network ID associated with the Traffic Mirror session. + description: + allOf: + - $ref: '#/components/schemas/String' + - description: The description of the Traffic Mirror session. + tagSet: + allOf: + - $ref: '#/components/schemas/TagList' + - description: The tags assigned to the Traffic Mirror session. + description: Describes a Traffic Mirror session. + CreateTrafficMirrorTargetRequest: + type: object + title: CreateTrafficMirrorTargetRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The description of the Traffic Mirror target. + TagSpecification: + allOf: + - $ref: '#/components/schemas/VpcEndpointId' + - description: The ID of the Gateway Load Balancer endpoint. + TrafficMirrorTarget: + type: object + properties: + trafficMirrorTargetId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the Traffic Mirror target. + networkInterfaceId: + allOf: + - $ref: '#/components/schemas/String' + - description: The network interface ID that is attached to the target. + networkLoadBalancerArn: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Resource Name (ARN) of the Network Load Balancer. + type: + allOf: + - $ref: '#/components/schemas/TrafficMirrorTargetType' + - description: The type of Traffic Mirror target. + description: + allOf: + - $ref: '#/components/schemas/String' + - description: Information about the Traffic Mirror target. + ownerId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the account that owns the Traffic Mirror target. + tagSet: + allOf: + - $ref: '#/components/schemas/TagList' + - description: The tags assigned to the Traffic Mirror target. + gatewayLoadBalancerEndpointId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the Gateway Load Balancer endpoint. + description: Describes a Traffic Mirror target. + InsideCidrBlocksStringList: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + CreateTransitGatewayConnectPeerRequest: + type: object + required: + - TransitGatewayAttachmentId + - PeerAddress + - InsideCidrBlocks + title: CreateTransitGatewayConnectPeerRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/InsideCidrBlocksStringList' + - description: 'The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayConnectPeer:
+ type: object
+ properties:
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentId'
+ - description: The ID of the Connect attachment.
+ transitGatewayConnectPeerId:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnectPeerId'
+ - description: The ID of the Connect peer.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnectPeerState'
+ - description: The state of the Connect peer.
+ creationTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The creation time.
+ connectPeerConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnectPeerConfiguration'
+ - description: The Connect peer details.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for the Connect peer.
+ description: Describes a transit gateway Connect peer.
+ CreateTransitGatewayConnectRequestOptions:
+ type: object
+ required:
+ - Protocol
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ProtocolValue'
+ - description: The tunnel protocol.
+ description: The options for a Connect attachment.
+ CreateTransitGatewayConnectRequest:
+ type: object
+ required:
+ - TransportTransitGatewayAttachmentId
+ - Options
+ title: CreateTransitGatewayConnectRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/CreateTransitGatewayConnectRequestOptions'
+ - description: The Connect attachment options.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayConnect:
+ type: object
+ properties:
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentId'
+ - description: The ID of the Connect attachment.
+ transportTransitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentId'
+ - description: The ID of the attachment from which the Connect attachment was created.
+ transitGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayId'
+ - description: The ID of the transit gateway.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentState'
+ - description: The state of the attachment.
+ creationTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The creation time.
+ options:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnectOptions'
+ - description: The Connect attachment options.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for the attachment.
+ description: Describes a transit gateway Connect attachment.
+ CreateTransitGatewayMulticastDomainRequestOptions:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/AutoAcceptSharedAssociationsValue'
+ - description: Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.
+ description: The options for the transit gateway multicast domain.
+ CreateTransitGatewayMulticastDomainRequest:
+ type: object
+ required:
+ - TransitGatewayId
+ title: CreateTransitGatewayMulticastDomainRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainRequestOptions'
+ - description: The options for the transit gateway multicast domain.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayMulticastDomain:
+ type: object
+ properties:
+ transitGatewayMulticastDomainId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway multicast domain.
+ transitGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway.
+ transitGatewayMulticastDomainArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the transit gateway multicast domain.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: ' The ID of the Amazon Web Services account that owns the transit gateway multicast domain.'
+ options:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomainOptions'
+ - description: The options for the transit gateway multicast domain.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomainState'
+ - description: The state of the transit gateway multicast domain.
+ creationTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time the transit gateway multicast domain was created.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for the transit gateway multicast domain.
+ description: Describes the transit gateway multicast domain.
+ CreateTransitGatewayPeeringAttachmentRequest:
+ type: object
+ required:
+ - TransitGatewayId
+ - PeerTransitGatewayId
+ - PeerAccountId
+ - PeerRegion
+ title: CreateTransitGatewayPeeringAttachmentRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Region where the peer transit gateway is located.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ CreateTransitGatewayPrefixListReferenceRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ - PrefixListId
+ title: CreateTransitGatewayPrefixListReferenceRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayPrefixListReference:
+ type: object
+ properties:
+ transitGatewayRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableId'
+ - description: The ID of the transit gateway route table.
+ prefixListId:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListResourceId'
+ - description: The ID of the prefix list.
+ prefixListOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the prefix list owner.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPrefixListReferenceState'
+ - description: The state of the prefix list reference.
+ blackhole:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether traffic that matches this route is dropped.
+ transitGatewayAttachment:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPrefixListAttachment'
+ - description: Information about the transit gateway attachment.
+ description: Describes a prefix list reference.
+ TransitGatewayRequestOptions:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayCidrBlockStringList'
+ - description: 'One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.'
+ description: Describes the options for a transit gateway.
+ CreateTransitGatewayRequest:
+ type: object
+ title: CreateTransitGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRequestOptions'
+ - description: The transit gateway options.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGateway:
+ type: object
+ properties:
+ transitGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway.
+ transitGatewayArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the transit gateway.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayState'
+ - description: The state of the transit gateway.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the transit gateway.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the transit gateway.
+ creationTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The creation time.
+ options:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayOptions'
+ - description: The transit gateway options.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for the transit gateway.
+ description: Describes a transit gateway.
+ CreateTransitGatewayRouteRequest:
+ type: object
+ required:
+ - DestinationCidrBlock
+ - TransitGatewayRouteTableId
+ title: CreateTransitGatewayRouteRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayRoute:
+ type: object
+ properties:
+ destinationCidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The CIDR block used for destination matches.
+ prefixListId:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListResourceId'
+ - description: The ID of the prefix list used for destination matches.
+ transitGatewayAttachments:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteAttachmentList'
+ - description: The attachments.
+ type:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteType'
+ - description: The route type.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteState'
+ - description: The state of the route.
+ description: Describes a route for a transit gateway route table.
+ CreateTransitGatewayRouteTableRequest:
+ type: object
+ required:
+ - TransitGatewayId
+ title: CreateTransitGatewayRouteTableRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayRouteTable:
+ type: object
+ properties:
+ transitGatewayRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway route table.
+ transitGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableState'
+ - description: The state of the transit gateway route table.
+ defaultAssociationRouteTable:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether this is the default association route table for the transit gateway.
+ defaultPropagationRouteTable:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether this is the default propagation route table for the transit gateway.
+ creationTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The creation time.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the route table.
+ description: Describes a transit gateway route table.
+ CreateTransitGatewayVpcAttachmentRequest:
+ type: object
+ required:
+ - TransitGatewayId
+ - VpcId
+ - SubnetIds
+ title: CreateTransitGatewayVpcAttachmentRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ CreateTransitGatewayVpcAttachmentRequestOptions:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ApplianceModeSupportValue'
+ - description: 'Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.'
+ description: Describes the options for a VPC attachment.
+ PermissionGroup:
+ type: string
+ enum:
+ - all
+ CreateVolumePermission:
+ type: object
+ properties:
+ group:
+ allOf:
+ - $ref: '#/components/schemas/PermissionGroup'
+ - description: The group to be added or removed. The possible value is all.
+ userId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account to be added or removed.
+ description: Describes the user or group to be added or removed from the list of create volume permissions for a volume.
+ CreateVolumePermissionModifications:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/CreateVolumePermissionList'
+ - description: Removes the specified Amazon Web Services account ID or group from the list.
+ description: Describes modifications to the list of create volume permissions for a volume.
+ VolumeType:
+ type: string
+ enum:
+ - standard
+ - io1
+ - io2
+ - gp2
+ - sc1
+ - st1
+ - gp3
+ CreateVolumeRequest:
+ type: object
+ required:
+ - AvailabilityZone
+ title: CreateVolumeRequest
+ properties:
+ AvailabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone in which to create the volume.
+ encrypted:
+ allOf:
+ - $ref: '#/components/schemas/VolumeType'
+ - description: 'The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: gp2
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.'
+ CreateVpcEndpointConnectionNotificationRequest:
+ type: object
+ required:
+ - ConnectionNotificationArn
+ - ConnectionEvents
+ title: CreateVpcEndpointConnectionNotificationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ VpcEndpointRouteTableIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableId'
+ - xml:
+ name: item
+ VpcEndpointSubnetIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - xml:
+ name: item
+ CreateVpcEndpointRequest:
+ type: object
+ required:
+ - VpcId
+ - ServiceName
+ title: CreateVpcEndpointRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: '(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.'
+ RouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointRouteTableIdList'
+ - description: (Gateway endpoint) One or more route table IDs.
+ SubnetId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointSubnetIdList'
+ - description: '(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.'
+ SecurityGroupId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: '(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
Default: true
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ peerOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Amazon Web Services account ID of the owner of the accepter VPC.
Default: Your Amazon Web Services account ID
' + peerVpcId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. + vpcId: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
' + TagSpecification: + allOf: + - $ref: '#/components/schemas/TagSpecificationList' + - description: The tags to assign to the peering connection. + CreateVpcRequest: + type: object + title: CreateVpcRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The IPv4 network range for the VPC, in CIDR notation. For example,10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.'
+ amazonProvidedIpv6CidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/NetmaskLength'
+ - description: 'The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.'
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ instanceTenancy:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
Indicate whether to enable acceleration for the VPN connection.
Default: false
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ options:
+ allOf:
+ - $ref: '#/components/schemas/VpnConnectionOptionsSpecification'
+ - description: The options for the VPN connection.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to apply to the VPN connection.
+ description: Contains the parameters for CreateVpnConnection.
+ VpnConnection:
+ type: object
+ properties:
+ customerGatewayConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The configuration information for the VPN connection''s customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it''s present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.'
+ customerGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the customer gateway at your end of the VPN connection.
+ category:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/VpnState'
+ - description: The current state of the VPN connection.
+ type:
+ allOf:
+ - $ref: '#/components/schemas/GatewayType'
+ - description: The type of VPN connection.
+ vpnConnectionId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPN connection.
+ vpnGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
+ transitGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway associated with the VPN connection.
+ coreNetworkArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ARN of the core network.
+ coreNetworkAttachmentArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ARN of the core network attachment.
+ gatewayAssociationState:
+ allOf:
+ - $ref: '#/components/schemas/GatewayAssociationState'
+ - description: The current state of the gateway association.
+ options:
+ allOf:
+ - $ref: '#/components/schemas/VpnConnectionOptions'
+ - description: The VPN connection options.
+ routes:
+ allOf:
+ - $ref: '#/components/schemas/VpnStaticRouteList'
+ - description: The static routes associated with the VPN connection.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the VPN connection.
+ vgwTelemetry:
+ allOf:
+ - $ref: '#/components/schemas/VgwTelemetryList'
+ - description: Information about the VPN tunnel.
+ description: Describes a VPN connection.
+ CreateVpnConnectionRouteRequest:
+ type: object
+ required:
+ - DestinationCidrBlock
+ - VpnConnectionId
+ title: CreateVpnConnectionRouteRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpnConnectionId'
+ - description: The ID of the VPN connection.
+ description: Contains the parameters for CreateVpnConnectionRoute.
+ CreateVpnGatewayRequest:
+ type: object
+ required:
+ - Type
+ title: CreateVpnGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/GatewayType'
+ - description: The type of VPN connection this virtual private gateway supports.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: 'A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you''re using a 16-bit ASN, it must be in the 64512 to 65534 range. If you''re using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
Default: 64512
' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for CreateVpnGateway.
+ VpnGateway:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.'
+ state:
+ allOf:
+ - $ref: '#/components/schemas/VpnState'
+ - description: The current state of the virtual private gateway.
+ type:
+ allOf:
+ - $ref: '#/components/schemas/GatewayType'
+ - description: The type of VPN connection the virtual private gateway supports.
+ attachments:
+ allOf:
+ - $ref: '#/components/schemas/VpcAttachmentList'
+ - description: Any VPCs attached to the virtual private gateway.
+ vpnGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the virtual private gateway.
+ amazonSideAsn:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the virtual private gateway.
+ description: Describes a virtual private gateway.
+ CreditSpecification:
+ type: object
+ properties:
+ cpuCredits:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited.'
+ description: 'Describes the credit option for CPU usage of a T2, T3, or T3a instance.'
+ CreditSpecificationRequest:
+ type: object
+ required:
+ - CpuCredits
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited.'
+ description: 'The credit option for CPU usage of a T2, T3, or T3a instance.'
+ CurrentGenerationFlag:
+ type: boolean
+ CustomerGatewayIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CustomerGatewayId'
+ - xml:
+ name: CustomerGatewayId
+ CustomerGatewayList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/CustomerGateway'
+ - xml:
+ name: item
+ DITMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 100
+ DITOMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ DatafeedSubscriptionState:
+ type: string
+ enum:
+ - Active
+ - Inactive
+ DedicatedHostFlag:
+ type: boolean
+ DefaultNetworkCardIndex:
+ type: integer
+ DefaultRouteTableAssociationValue:
+ type: string
+ enum:
+ - enable
+ - disable
+ DefaultRouteTablePropagationValue:
+ type: string
+ enum:
+ - enable
+ - disable
+ DefaultTargetCapacityType:
+ type: string
+ enum:
+ - spot
+ - on-demand
+ DefaultingDhcpOptionsId:
+ type: string
+ DeleteCarrierGatewayRequest:
+ type: object
+ required:
+ - CarrierGatewayId
+ title: DeleteCarrierGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteClientVpnEndpointRequest:
+ type: object
+ required:
+ - ClientVpnEndpointId
+ title: DeleteClientVpnEndpointRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteClientVpnRouteRequest:
+ type: object
+ required:
+ - ClientVpnEndpointId
+ - DestinationCidrBlock
+ title: DeleteClientVpnRouteRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteCustomerGatewayRequest:
+ type: object
+ required:
+ - CustomerGatewayId
+ title: DeleteCustomerGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/CustomerGatewayId'
+ - description: The ID of the customer gateway.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DeleteCustomerGateway.
+ DeleteDhcpOptionsRequest:
+ type: object
+ required:
+ - DhcpOptionsId
+ title: DeleteDhcpOptionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/DhcpOptionsId'
+ - description: The ID of the DHCP options set.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteEgressOnlyInternetGatewayRequest:
+ type: object
+ required:
+ - EgressOnlyInternetGatewayId
+ title: DeleteEgressOnlyInternetGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
+ - description: The ID of the egress-only internet gateway.
+ DeleteFleetErrorCode:
+ type: string
+ enum:
+ - fleetIdDoesNotExist
+ - fleetIdMalformed
+ - fleetNotInDeletableState
+ - unexpectedError
+ DeleteFleetError:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/DeleteFleetErrorCode'
+ - description: The error code.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description for the error code.
+ description: Describes an EC2 Fleet error.
+ DeleteFleetErrorItem:
+ type: object
+ properties:
+ error:
+ allOf:
+ - $ref: '#/components/schemas/DeleteFleetError'
+ - description: The error.
+ fleetId:
+ allOf:
+ - $ref: '#/components/schemas/FleetId'
+ - description: The ID of the EC2 Fleet.
+ description: Describes an EC2 Fleet that was not successfully deleted.
+ DeleteFleetErrorSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DeleteFleetErrorItem'
+ - xml:
+ name: item
+ FleetStateCode:
+ type: string
+ enum:
+ - submitted
+ - active
+ - deleted
+ - failed
+ - deleted_running
+ - deleted_terminating
+ - modifying
+ DeleteFleetSuccessItem:
+ type: object
+ properties:
+ currentFleetState:
+ allOf:
+ - $ref: '#/components/schemas/FleetStateCode'
+ - description: The current state of the EC2 Fleet.
+ previousFleetState:
+ allOf:
+ - $ref: '#/components/schemas/FleetStateCode'
+ - description: The previous state of the EC2 Fleet.
+ fleetId:
+ allOf:
+ - $ref: '#/components/schemas/FleetId'
+ - description: The ID of the EC2 Fleet.
+ description: Describes an EC2 Fleet that was successfully deleted.
+ DeleteFleetSuccessSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DeleteFleetSuccessItem'
+ - xml:
+ name: item
+ DeleteFleetsRequest:
+ type: object
+ required:
+ - FleetIds
+ - TerminateInstances
+ title: DeleteFleetsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ FleetId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to terminate the instances.
To let the instances continue to run after the EC2 Fleet is deleted, specify NoTerminateInstances. Supported only for fleets of type maintain and request.
For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ FlowLogId:
+ allOf:
+ - $ref: '#/components/schemas/FlowLogIdList'
+ - description: 'One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
' + DeleteFpgaImageRequest: + type: object + required: + - FpgaImageId + title: DeleteFpgaImageRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/FpgaImageId' + - description: The ID of the AFI. + DeleteInstanceEventWindowRequest: + type: object + required: + - InstanceEventWindowId + title: DeleteInstanceEventWindowRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/InstanceEventWindowId' + - description: The ID of the event window. + InstanceEventWindowStateChange: + type: object + properties: + instanceEventWindowId: + allOf: + - $ref: '#/components/schemas/InstanceEventWindowId' + - description: The ID of the event window. + state: + allOf: + - $ref: '#/components/schemas/InstanceEventWindowState' + - description: The current state of the event window. + description: The state of the event window. + DeleteInternetGatewayRequest: + type: object + required: + - InternetGatewayId + title: DeleteInternetGatewayRequest + properties: + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ internetGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/InternetGatewayId'
+ - description: The ID of the internet gateway.
+ IpamPoolId:
+ type: string
+ DeleteIpamPoolRequest:
+ type: object
+ required:
+ - IpamPoolId
+ title: DeleteIpamPoolRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolId'
+ - description: The ID of the pool to delete.
+ DeleteIpamRequest:
+ type: object
+ required:
+ - IpamId
+ title: DeleteIpamRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:
Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.
No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.
Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.
Deletes all IPAM pools in private scopes.
Deletes all non-default private scopes in the IPAM.
Deletes the default public and private scopes and the IPAM.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteLaunchTemplateRequest:
+ type: object
+ title: DeleteLaunchTemplateRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateName'
+ - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
+ VersionStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ DeleteLaunchTemplateVersionsRequest:
+ type: object
+ required:
+ - Versions
+ title: DeleteLaunchTemplateVersionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateName'
+ - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
+ LaunchTemplateVersion:
+ allOf:
+ - $ref: '#/components/schemas/VersionStringList'
+ - description: The version numbers of one or more launch template versions to delete.
+ ResponseError:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateErrorCode'
+ - description: The error code.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The error message, if applicable.'
+ description: Describes the error that's returned when you cannot delete a launch template version.
+ DeleteLaunchTemplateVersionsResponseErrorItem:
+ type: object
+ properties:
+ launchTemplateId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the launch template.
+ launchTemplateName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the launch template.
+ versionNumber:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: The version number of the launch template.
+ responseError:
+ allOf:
+ - $ref: '#/components/schemas/ResponseError'
+ - description: Information about the error.
+ description: Describes a launch template version that could not be deleted.
+ DeleteLaunchTemplateVersionsResponseErrorSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseErrorItem'
+ - xml:
+ name: item
+ DeleteLaunchTemplateVersionsResponseSuccessItem:
+ type: object
+ properties:
+ launchTemplateId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the launch template.
+ launchTemplateName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the launch template.
+ versionNumber:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: The version number of the launch template.
+ description: Describes a launch template version that was successfully deleted.
+ DeleteLaunchTemplateVersionsResponseSuccessSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseSuccessItem'
+ - xml:
+ name: item
+ DeleteLocalGatewayRouteRequest:
+ type: object
+ required:
+ - DestinationCidrBlock
+ - LocalGatewayRouteTableId
+ title: DeleteLocalGatewayRouteRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteLocalGatewayRouteTableVpcAssociationRequest:
+ type: object
+ required:
+ - LocalGatewayRouteTableVpcAssociationId
+ title: DeleteLocalGatewayRouteTableVpcAssociationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteManagedPrefixListRequest:
+ type: object
+ required:
+ - PrefixListId
+ title: DeleteManagedPrefixListRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListResourceId'
+ - description: The ID of the prefix list.
+ DeleteNatGatewayRequest:
+ type: object
+ required:
+ - NatGatewayId
+ title: DeleteNatGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/NatGatewayId'
+ - description: The ID of the NAT gateway.
+ DeleteNetworkAclEntryRequest:
+ type: object
+ required:
+ - Egress
+ - NetworkAclId
+ - RuleNumber
+ title: DeleteNetworkAclEntryRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ egress:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the rule is an egress rule.
+ networkAclId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAclId'
+ - description: The ID of the network ACL.
+ ruleNumber:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The rule number of the entry to delete.
+ DeleteNetworkAclRequest:
+ type: object
+ required:
+ - NetworkAclId
+ title: DeleteNetworkAclRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ networkAclId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAclId'
+ - description: The ID of the network ACL.
+ DeleteNetworkInsightsAccessScopeAnalysisRequest:
+ type: object
+ required:
+ - NetworkInsightsAccessScopeAnalysisId
+ title: DeleteNetworkInsightsAccessScopeAnalysisRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteNetworkInsightsAccessScopeRequest:
+ type: object
+ required:
+ - NetworkInsightsAccessScopeId
+ title: DeleteNetworkInsightsAccessScopeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
+ - description: The ID of the Network Access Scope.
+ DeleteNetworkInsightsAnalysisRequest:
+ type: object
+ required:
+ - NetworkInsightsAnalysisId
+ title: DeleteNetworkInsightsAnalysisRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAnalysisId'
+ - description: The ID of the network insights analysis.
+ DeleteNetworkInsightsPathRequest:
+ type: object
+ required:
+ - NetworkInsightsPathId
+ title: DeleteNetworkInsightsPathRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsPathId'
+ - description: The ID of the path.
+ DeleteNetworkInterfacePermissionRequest:
+ type: object
+ required:
+ - NetworkInterfacePermissionId
+ title: DeleteNetworkInterfacePermissionRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DeleteNetworkInterfacePermission.
+ DeleteNetworkInterfaceRequest:
+ type: object
+ required:
+ - NetworkInterfaceId
+ title: DeleteNetworkInterfaceRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - description: The ID of the network interface.
+ description: Contains the parameters for DeleteNetworkInterface.
+ DeletePlacementGroupRequest:
+ type: object
+ required:
+ - GroupName
+ title: DeletePlacementGroupRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ groupName:
+ allOf:
+ - $ref: '#/components/schemas/PlacementGroupName'
+ - description: The name of the placement group.
+ DeletePublicIpv4PoolRequest:
+ type: object
+ required:
+ - PoolId
+ title: DeletePublicIpv4PoolRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PoolEc2Id'
+ - description: The ID of the public IPv4 pool you want to delete.
+ DeleteQueuedReservedInstancesErrorCode:
+ type: string
+ enum:
+ - reserved-instances-id-invalid
+ - reserved-instances-not-in-queued-state
+ - unexpected-error
+ DeleteQueuedReservedInstancesError:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/DeleteQueuedReservedInstancesErrorCode'
+ - description: The error code.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The error message.
+ description: Describes the error for a Reserved Instance whose queued purchase could not be deleted.
+ DeleteQueuedReservedInstancesIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservationId'
+ - xml:
+ name: item
+ minItems: 1
+ maxItems: 100
+ DeleteQueuedReservedInstancesRequest:
+ type: object
+ required:
+ - ReservedInstancesIds
+ title: DeleteQueuedReservedInstancesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ReservedInstancesId:
+ allOf:
+ - $ref: '#/components/schemas/DeleteQueuedReservedInstancesIdList'
+ - description: The IDs of the Reserved Instances.
+ SuccessfulQueuedPurchaseDeletionSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SuccessfulQueuedPurchaseDeletion'
+ - xml:
+ name: item
+ FailedQueuedPurchaseDeletionSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/FailedQueuedPurchaseDeletion'
+ - xml:
+ name: item
+ DeleteRouteRequest:
+ type: object
+ required:
+ - RouteTableId
+ title: DeleteRouteRequest
+ properties:
+ destinationCidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
+ destinationIpv6CidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListResourceId'
+ - description: The ID of the prefix list for the route.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ routeTableId:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableId'
+ - description: The ID of the route table.
+ DeleteRouteTableRequest:
+ type: object
+ required:
+ - RouteTableId
+ title: DeleteRouteTableRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ routeTableId:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableId'
+ - description: The ID of the route table.
+ DeleteSecurityGroupRequest:
+ type: object
+ title: DeleteSecurityGroupRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupName'
+ - description: '[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.'
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteSnapshotRequest:
+ type: object
+ required:
+ - SnapshotId
+ title: DeleteSnapshotRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotId'
+ - description: The ID of the EBS snapshot.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteSpotDatafeedSubscriptionRequest:
+ type: object
+ title: DeleteSpotDatafeedSubscriptionRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DeleteSpotDatafeedSubscription.
+ DeleteSubnetCidrReservationRequest:
+ type: object
+ required:
+ - SubnetCidrReservationId
+ title: DeleteSubnetCidrReservationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteSubnetRequest:
+ type: object
+ required:
+ - SubnetId
+ title: DeleteSubnetRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - description: The ID of the subnet.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTagsRequest:
+ type: object
+ required:
+ - Resources
+ title: DeleteTagsRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/ResourceIdList'
+ - description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' + tag: + allOf: + - $ref: '#/components/schemas/TagList' + - description: 'The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.
If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).
Constraints: Up to 1000 tags.
' + DeleteTrafficMirrorFilterRequest: + type: object + required: + - TrafficMirrorFilterId + title: DeleteTrafficMirrorFilterRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTrafficMirrorFilterRuleRequest:
+ type: object
+ required:
+ - TrafficMirrorFilterRuleId
+ title: DeleteTrafficMirrorFilterRuleRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTrafficMirrorSessionRequest:
+ type: object
+ required:
+ - TrafficMirrorSessionId
+ title: DeleteTrafficMirrorSessionRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTrafficMirrorTargetRequest:
+ type: object
+ required:
+ - TrafficMirrorTargetId
+ title: DeleteTrafficMirrorTargetRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTransitGatewayConnectPeerRequest:
+ type: object
+ required:
+ - TransitGatewayConnectPeerId
+ title: DeleteTransitGatewayConnectPeerRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTransitGatewayConnectRequest:
+ type: object
+ required:
+ - TransitGatewayAttachmentId
+ title: DeleteTransitGatewayConnectRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTransitGatewayMulticastDomainRequest:
+ type: object
+ required:
+ - TransitGatewayMulticastDomainId
+ title: DeleteTransitGatewayMulticastDomainRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTransitGatewayPeeringAttachmentRequest:
+ type: object
+ required:
+ - TransitGatewayAttachmentId
+ title: DeleteTransitGatewayPeeringAttachmentRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTransitGatewayPrefixListReferenceRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ - PrefixListId
+ title: DeleteTransitGatewayPrefixListReferenceRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTransitGatewayRequest:
+ type: object
+ required:
+ - TransitGatewayId
+ title: DeleteTransitGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTransitGatewayRouteRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ - DestinationCidrBlock
+ title: DeleteTransitGatewayRouteRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTransitGatewayRouteTableRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ title: DeleteTransitGatewayRouteTableRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteTransitGatewayVpcAttachmentRequest:
+ type: object
+ required:
+ - TransitGatewayAttachmentId
+ title: DeleteTransitGatewayVpcAttachmentRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteVolumeRequest:
+ type: object
+ required:
+ - VolumeId
+ title: DeleteVolumeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VolumeId'
+ - description: The ID of the volume.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteVpcEndpointConnectionNotificationsRequest:
+ type: object
+ required:
+ - ConnectionNotificationIds
+ title: DeleteVpcEndpointConnectionNotificationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ConnectionNotificationId:
+ allOf:
+ - $ref: '#/components/schemas/ConnectionNotificationIdsList'
+ - description: One or more notification IDs.
+ VpcEndpointServiceIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointServiceId'
+ - xml:
+ name: item
+ DeleteVpcEndpointServiceConfigurationsRequest:
+ type: object
+ required:
+ - ServiceIds
+ title: DeleteVpcEndpointServiceConfigurationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ServiceId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointServiceIdList'
+ - description: The IDs of one or more services.
+ DeleteVpcEndpointsRequest:
+ type: object
+ required:
+ - VpcEndpointIds
+ title: DeleteVpcEndpointsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ VpcEndpointId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointIdList'
+ - description: One or more VPC endpoint IDs.
+ description: Contains the parameters for DeleteVpcEndpoints.
+ DeleteVpcPeeringConnectionRequest:
+ type: object
+ required:
+ - VpcPeeringConnectionId
+ title: DeleteVpcPeeringConnectionRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ vpcPeeringConnectionId:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnectionId'
+ - description: The ID of the VPC peering connection.
+ DeleteVpcRequest:
+ type: object
+ required:
+ - VpcId
+ title: DeleteVpcRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeleteVpnConnectionRequest:
+ type: object
+ required:
+ - VpnConnectionId
+ title: DeleteVpnConnectionRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpnConnectionId'
+ - description: The ID of the VPN connection.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DeleteVpnConnection.
+ DeleteVpnConnectionRouteRequest:
+ type: object
+ required:
+ - DestinationCidrBlock
+ - VpnConnectionId
+ title: DeleteVpnConnectionRouteRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpnConnectionId'
+ - description: The ID of the VPN connection.
+ description: Contains the parameters for DeleteVpnConnectionRoute.
+ DeleteVpnGatewayRequest:
+ type: object
+ required:
+ - VpnGatewayId
+ title: DeleteVpnGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpnGatewayId'
+ - description: The ID of the virtual private gateway.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DeleteVpnGateway.
+ DeprovisionByoipCidrRequest:
+ type: object
+ required:
+ - Cidr
+ title: DeprovisionByoipCidrRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DeprovisionIpamPoolCidrRequest:
+ type: object
+ required:
+ - IpamPoolId
+ title: DeprovisionIpamPoolCidrRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The CIDR which you want to deprovision from the pool.
+ IpamPoolCidr:
+ type: object
+ properties:
+ cidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.'
+ state:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolCidrState'
+ - description: The state of the CIDR.
+ failureReason:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolCidrFailureReason'
+ - description: Details related to why an IPAM pool CIDR failed to be provisioned.
+ description: A CIDR provisioned to an IPAM pool.
+ DeprovisionPublicIpv4PoolCidrRequest:
+ type: object
+ required:
+ - PoolId
+ - Cidr
+ title: DeprovisionPublicIpv4PoolCidrRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The CIDR you want to deprovision from the pool.
+ DeprovisionedAddressSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ DeregisterImageRequest:
+ type: object
+ required:
+ - ImageId
+ title: DeregisterImageRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ImageId'
+ - description: The ID of the AMI.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DeregisterImage.
+ DeregisterInstanceTagAttributeRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to deregister all tag keys in the current Region. Specify false to deregister all tag keys.
+ InstanceTagKey:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTagKeySet'
+ - description: Information about the tag keys to deregister.
+ description: Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
+ DeregisterInstanceEventNotificationAttributesRequest:
+ type: object
+ title: DeregisterInstanceEventNotificationAttributesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/DeregisterInstanceTagAttributeRequest'
+ - description: Information about the tag keys to deregister.
+ InstanceTagNotificationAttribute:
+ type: object
+ properties:
+ instanceTagKeySet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTagKeySet'
+ - description: The registered tag keys.
+ includeAllTagsOfInstance:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. true indicates that all tag keys in the current Region are registered.
+ description: Describes the registered tag keys for the current Region.
+ DeregisterTransitGatewayMulticastGroupMembersRequest:
+ type: object
+ title: DeregisterTransitGatewayMulticastGroupMembersRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayMulticastDeregisteredGroupMembers:
+ type: object
+ properties:
+ transitGatewayMulticastDomainId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway multicast domain.
+ deregisteredNetworkInterfaceIds:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The network interface IDs of the deregistered members.
+ groupIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IP address assigned to the transit gateway multicast group.
+ description: Describes the deregistered transit gateway multicast group members.
+ DeregisterTransitGatewayMulticastGroupSourcesRequest:
+ type: object
+ title: DeregisterTransitGatewayMulticastGroupSourcesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayMulticastDeregisteredGroupSources:
+ type: object
+ properties:
+ transitGatewayMulticastDomainId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway multicast domain.
+ deregisteredNetworkInterfaceIds:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The network interface IDs of the non-registered members.
+ groupIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IP address assigned to the transit gateway multicast group.
+ description: Describes the deregistered transit gateway multicast group sources.
+ DescribeAccountAttributesRequest:
+ type: object
+ title: DescribeAccountAttributesRequest
+ properties:
+ attributeName:
+ allOf:
+ - $ref: '#/components/schemas/AccountAttributeNameStringList'
+ - description: The account attribute names.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeAddressesAttributeRequest:
+ type: object
+ title: DescribeAddressesAttributeRequest
+ properties:
+ AllocationId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ NextToken:
+ type: string
+ FilterList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Filter'
+ - xml:
+ name: Filter
+ PublicIpStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: PublicIp
+ DescribeAddressesRequest:
+ type: object
+ title: DescribeAddressesRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters. Filter names and values are case-sensitive.
allocation-id - [EC2-VPC] The allocation ID for the address.
association-id - [EC2-VPC] The association ID for the address.
domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).
instance-id - The ID of the instance the address is associated with, if any.
network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The Amazon Web Services account ID of the owner.
private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
' + AllocationId: + allOf: + - $ref: '#/components/schemas/AllocationIdList' + - description: '[EC2-VPC] Information about the allocation IDs.' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeAggregateIdFormatRequest:
+ type: object
+ title: DescribeAggregateIdFormatRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ IdFormatList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IdFormat'
+ - xml:
+ name: item
+ ZoneNameStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: ZoneName
+ DescribeAvailabilityZonesRequest:
+ type: object
+ title: DescribeAvailabilityZonesRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'The filters.
group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
message - The Zone message.
opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required).
parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name - The name of the Region for the Zone (for example, us-east-1).
state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available).
zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeBundleTasksRequest:
+ type: object
+ title: DescribeBundleTasksRequest
+ properties:
+ BundleId:
+ allOf:
+ - $ref: '#/components/schemas/BundleIdStringList'
+ - description: 'The bundle task IDs.
Default: Describes all your bundle tasks.
' + Filter: + allOf: + - $ref: '#/components/schemas/FilterList' + - description: 'The filters.
bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeByoipCidrsMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 100
+ DescribeByoipCidrsRequest:
+ type: object
+ required:
+ - MaxResults
+ title: DescribeByoipCidrsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ DescribeCapacityReservationFleetsMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 100
+ DescribeCapacityReservationFleetsRequest:
+ type: object
+ title: DescribeCapacityReservationFleetsRequest
+ properties:
+ CapacityReservationFleetId:
+ allOf:
+ - $ref: '#/components/schemas/DescribeCapacityReservationFleetsMaxResults'
+ - description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeCapacityReservationsMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ DescribeCapacityReservationsRequest:
+ type: object
+ title: DescribeCapacityReservationsRequest
+ properties:
+ CapacityReservationId:
+ allOf:
+ - $ref: '#/components/schemas/DescribeCapacityReservationsMaxResults'
+ - description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeCarrierGatewaysRequest:
+ type: object
+ title: DescribeCarrierGatewaysRequest
+ properties:
+ CarrierGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/CarrierGatewayIdSet'
+ - description: One or more carrier gateway IDs.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeClassicLinkInstancesMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ InstanceIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - xml:
+ name: InstanceId
+ DescribeClassicLinkInstancesRequest:
+ type: object
+ title: DescribeClassicLinkInstancesRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
group-id - The ID of a VPC security group that''s associated with the instance.
instance-id - The ID of the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
vpc-id - The ID of the VPC that the instance is linked to.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ InstanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdStringList'
+ - description: One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
+ maxResults:
+ allOf:
+ - $ref: '#/components/schemas/DescribeClassicLinkInstancesMaxResults'
+ - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Constraint: If the value is greater than 1000, we return only 1000 items.
' + nextToken: + allOf: + - $ref: '#/components/schemas/String' + - description: The token for the next page of results. + DescribeClientVpnAuthorizationRulesMaxResults: + type: integer + minimum: 5 + maximum: 1000 + DescribeClientVpnAuthorizationRulesRequest: + type: object + required: + - ClientVpnEndpointId + title: DescribeClientVpnAuthorizationRulesRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/NextToken' + - description: The token to retrieve the next page of results. + Filter: + allOf: + - $ref: '#/components/schemas/DescribeClientVpnAuthorizationRulesMaxResults' + - description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. + DescribeClientVpnConnectionsMaxResults: + type: integer + minimum: 5 + maximum: 1000 + DescribeClientVpnConnectionsRequest: + type: object + required: + - ClientVpnEndpointId + title: DescribeClientVpnConnectionsRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/ClientVpnEndpointId' + - description: The ID of the Client VPN endpoint. + Filter: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeClientVpnEndpointMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ DescribeClientVpnEndpointsRequest:
+ type: object
+ title: DescribeClientVpnEndpointsRequest
+ properties:
+ ClientVpnEndpointId:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to retrieve the next page of results.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ EndpointSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnEndpoint'
+ - xml:
+ name: item
+ DescribeClientVpnRoutesMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ DescribeClientVpnRoutesRequest:
+ type: object
+ required:
+ - ClientVpnEndpointId
+ title: DescribeClientVpnRoutesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnEndpointId'
+ - description: The ID of the Client VPN endpoint.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeClientVpnTargetNetworksMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ DescribeClientVpnTargetNetworksRequest:
+ type: object
+ required:
+ - ClientVpnEndpointId
+ title: DescribeClientVpnTargetNetworksRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to retrieve the next page of results.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TargetNetworkSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TargetNetwork'
+ - xml:
+ name: item
+ DescribeCoipPoolsRequest:
+ type: object
+ title: DescribeCoipPoolsRequest
+ properties:
+ PoolId:
+ allOf:
+ - $ref: '#/components/schemas/CoipPoolIdSet'
+ - description: The IDs of the address pools.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeConversionTaskList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ConversionTask'
+ - xml:
+ name: item
+ DescribeConversionTasksRequest:
+ type: object
+ title: DescribeConversionTasksRequest
+ properties:
+ conversionTaskId:
+ allOf:
+ - $ref: '#/components/schemas/ConversionIdStringList'
+ - description: The conversion task IDs.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeCustomerGatewaysRequest:
+ type: object
+ title: DescribeCustomerGatewaysRequest
+ properties:
+ CustomerGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/CustomerGatewayIdStringList'
+ - description: 'One or more customer gateway IDs.
Default: Describes all your customer gateways.
' + Filter: + allOf: + - $ref: '#/components/schemas/FilterList' + - description: 'One or more filters.
bgp-asn - The customer gateway''s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway''s Internet-routable external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DescribeCustomerGateways.
+ DescribeDhcpOptionsMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ DhcpOptionsIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DhcpOptionsId'
+ - xml:
+ name: DhcpOptionsId
+ DescribeDhcpOptionsRequest:
+ type: object
+ title: DescribeDhcpOptionsRequest
+ properties:
+ DhcpOptionsId:
+ allOf:
+ - $ref: '#/components/schemas/DhcpOptionsIdStringList'
+ - description: 'The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
' + Filter: + allOf: + - $ref: '#/components/schemas/FilterList' + - description: 'One or more filters.
dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
nextToken value.'
+ DhcpOptionsList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DhcpOptions'
+ - xml:
+ name: item
+ DescribeEgressOnlyInternetGatewaysMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 255
+ DescribeEgressOnlyInternetGatewaysRequest:
+ type: object
+ title: DescribeEgressOnlyInternetGatewaysRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ EgressOnlyInternetGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next page of results.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to request the next page of results.
+ ElasticGpuSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ElasticGpus'
+ - xml:
+ name: item
+ DescribeExportImageTasksMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 500
+ DescribeExportImageTasksRequest:
+ type: object
+ title: DescribeExportImageTasksRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
+ ExportImageTaskId:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: A token that indicates the next page of results.
+ ExportImageTaskList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ExportImageTask'
+ - xml:
+ name: item
+ ExportTaskIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ExportTaskId'
+ - xml:
+ name: ExportTaskId
+ DescribeExportTasksRequest:
+ type: object
+ title: DescribeExportTasksRequest
+ properties:
+ exportTaskId:
+ allOf:
+ - $ref: '#/components/schemas/ExportTaskIdStringList'
+ - description: The export task IDs.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: the filters for the export tasks.
+ ExportTaskList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ExportTask'
+ - xml:
+ name: item
+ FastLaunchImageIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImageId'
+ - xml:
+ name: ImageId
+ DescribeFastLaunchImagesRequest:
+ type: object
+ title: DescribeFastLaunchImagesRequest
+ properties:
+ ImageId:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchImageIdList'
+ - description: Details for one or more Windows AMI image IDs.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeFastLaunchImagesRequestMaxResults:
+ type: integer
+ minimum: 0
+ maximum: 200
+ DescribeFastLaunchImagesSuccessSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DescribeFastLaunchImagesSuccessItem'
+ - xml:
+ name: item
+ FastLaunchResourceType:
+ type: string
+ enum:
+ - snapshot
+ FastLaunchSnapshotConfigurationResponse:
+ type: object
+ properties:
+ targetResourceCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of pre-provisioned snapshots requested to keep on hand for a fast-launch enabled Windows AMI.
+ description: Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
+ FastLaunchLaunchTemplateSpecificationResponse:
+ type: object
+ properties:
+ launchTemplateId:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateId'
+ - description: The ID of the launch template for faster launching of the associated Windows AMI.
+ launchTemplateName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the launch template for faster launching of the associated Windows AMI.
+ version:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The version of the launch template for faster launching of the associated Windows AMI.
+ description: Identifies the launch template to use for faster launching of the Windows AMI.
+ FastLaunchStateCode:
+ type: string
+ enum:
+ - enabling
+ - enabling-failed
+ - enabled
+ - enabled-failed
+ - disabling
+ - disabling-failed
+ DescribeFastLaunchImagesSuccessItem:
+ type: object
+ properties:
+ imageId:
+ allOf:
+ - $ref: '#/components/schemas/ImageId'
+ - description: The image ID that identifies the fast-launch enabled Windows image.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchResourceType'
+ - description: 'The resource type that is used for pre-provisioning the Windows AMI. Supported values include: snapshot.'
+ snapshotConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchSnapshotConfigurationResponse'
+ - description: A group of parameters that are used for pre-provisioning the associated Windows AMI using snapshots.
+ launchTemplate:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationResponse'
+ - description: The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances from pre-provisioned snapshots.
+ maxParallelLaunches:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The maximum number of parallel instances that are launched for creating resources.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The owner ID for the fast-launch enabled Windows AMI.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/FastLaunchStateCode'
+ - description: The current state of faster launching for the specified Windows AMI.
+ stateTransitionReason:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The reason that faster launching for the Windows AMI changed to the current state.
+ stateTransitionTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time that faster launching for the Windows AMI changed to the current state.
+ description: Describe details about a fast-launch enabled Windows image that meets the requested criteria. Criteria are defined by the DescribeFastLaunchImages action filters.
+ FastSnapshotRestoreStateCode:
+ type: string
+ enum:
+ - enabling
+ - optimizing
+ - enabled
+ - disabling
+ - disabled
+ DescribeFastSnapshotRestoreSuccessItem:
+ type: object
+ properties:
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the snapshot.
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/FastSnapshotRestoreStateCode'
+ - description: The state of fast snapshot restores.
+ stateTransitionReason:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
enabling state.
+ optimizingTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time at which fast snapshot restores entered the optimizing state.
+ enabledTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time at which fast snapshot restores entered the enabled state.
+ disablingTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time at which fast snapshot restores entered the disabling state.
+ disabledTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time at which fast snapshot restores entered the disabled state.
+ description: Describes fast snapshot restores for a snapshot.
+ DescribeFastSnapshotRestoreSuccessSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DescribeFastSnapshotRestoreSuccessItem'
+ - xml:
+ name: item
+ DescribeFastSnapshotRestoresMaxResults:
+ type: integer
+ minimum: 0
+ maximum: 200
+ DescribeFastSnapshotRestoresRequest:
+ type: object
+ title: DescribeFastSnapshotRestoresRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeFleetError:
+ type: object
+ properties:
+ launchTemplateAndOverrides:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
+ - description: The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
+ lifecycle:
+ allOf:
+ - $ref: '#/components/schemas/InstanceLifecycle'
+ - description: Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
+ errorCode:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.'
+ errorMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.'
+ description: Describes the instances that could not be launched by the fleet.
+ DescribeFleetHistoryRequest:
+ type: object
+ required:
+ - FleetId
+ - StartTime
+ title: DescribeFleetHistoryRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ HistoryRecordSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/HistoryRecordEntry'
+ - xml:
+ name: item
+ DescribeFleetInstancesRequest:
+ type: object
+ required:
+ - FleetId
+ title: DescribeFleetInstancesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/FleetId'
+ - description: The ID of the EC2 Fleet.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: The filters.
instance-type - The instance type.
Windows for Windows instances. Otherwise, the value is blank.'
+ description: Describes the instances that were launched by the fleet.
+ DescribeFleetsInstancesSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DescribeFleetsInstances'
+ - xml:
+ name: item
+ FleetIdSet:
+ type: array
+ items:
+ $ref: '#/components/schemas/FleetId'
+ DescribeFleetsRequest:
+ type: object
+ title: DescribeFleetsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next set of results.
+ FleetId:
+ allOf:
+ - $ref: '#/components/schemas/FleetIdSet'
+ - description: 'The IDs of the EC2 Fleets.
If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.
The filters.
activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).
excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).
fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).
replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).
type - The type of request (instant | request | maintain).
One or more filters.
deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).
log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and s3.
flow-log-id - The ID of the flow log.
log-group-name - The name of the log group.
resource-id - The ID of the VPC, subnet, or network interface.
traffic-type - The type of traffic (ACCEPT | REJECT | ALL).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ FpgaImageId:
+ allOf:
+ - $ref: '#/components/schemas/FpgaImageIdList'
+ - description: The AFI IDs.
+ Owner:
+ allOf:
+ - $ref: '#/components/schemas/OwnerStringList'
+ - description: 'Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/DescribeFpgaImagesMaxResults'
+ - description: The maximum number of results to return in a single call.
+ FpgaImageList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/FpgaImage'
+ - xml:
+ name: item
+ OfferingId:
+ type: string
+ DescribeHostReservationOfferingsRequest:
+ type: object
+ title: DescribeHostReservationOfferingsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/OfferingId'
+ - description: The ID of the reservation offering.
+ HostOfferingSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/HostOffering'
+ - xml:
+ name: item
+ DescribeHostReservationsMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 500
+ DescribeHostReservationsRequest:
+ type: object
+ title: DescribeHostReservationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to use to retrieve the next page of results.
+ HostReservationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/HostReservation'
+ - xml:
+ name: item
+ RequestHostIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DedicatedHostId'
+ - xml:
+ name: item
+ DescribeHostsRequest:
+ type: object
+ title: DescribeHostsRequest
+ properties:
+ filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'The filters.
auto-placement - Whether auto-placement is enabled or disabled (on | off).
availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you allocated the host.
host-reservation-id - The ID of the reservation assigned to this host.
instance-type - The instance type size that the Dedicated Host is configured to support.
state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
' + nextToken: + allOf: + - $ref: '#/components/schemas/String' + - description: The token to use to retrieve the next page of results. + HostList: + type: array + items: + allOf: + - $ref: '#/components/schemas/Host' + - xml: + name: item + DescribeIamInstanceProfileAssociationsMaxResults: + type: integer + minimum: 5 + maximum: 1000 + DescribeIamInstanceProfileAssociationsRequest: + type: object + title: DescribeIamInstanceProfileAssociationsRequest + properties: + AssociationId: + allOf: + - $ref: '#/components/schemas/AssociationIdList' + - description: The IAM instance profile associations. + Filter: + allOf: + - $ref: '#/components/schemas/NextToken' + - description: The token to request the next page of results. + IamInstanceProfileAssociationSet: + type: array + items: + allOf: + - $ref: '#/components/schemas/IamInstanceProfileAssociation' + - xml: + name: item + DescribeIdFormatRequest: + type: object + title: DescribeIdFormatRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The type of resource:bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
+ DescribeIdentityIdFormatRequest:
+ type: object
+ required:
+ - PrincipalArn
+ title: DescribeIdentityIdFormatRequest
+ properties:
+ principalArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ARN of the principal, which can be an IAM role, IAM user, or the root user.'
+ resource:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
+ DescribeImageAttributeRequest:
+ type: object
+ required:
+ - Attribute
+ - ImageId
+ title: DescribeImageAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ImageId'
+ - description: The ID of the AMI.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DescribeImageAttribute.
+ ExecutableByStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: ExecutableBy
+ ImageIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImageId'
+ - xml:
+ name: ImageId
+ DescribeImagesRequest:
+ type: object
+ title: DescribeImagesRequest
+ properties:
+ ExecutableBy:
+ allOf:
+ - $ref: '#/components/schemas/ExecutableByStringList'
+ - description: 'Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).
If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.
If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.
If you specify all, all public AMIs are returned.
The filters.
architecture - The image architecture (i386 | x86_64 | arm64).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
description - The description of the image (provided during image creation).
ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
platform - The platform. To only list Windows-based AMIs, use windows.
product-code - The product code.
product-code.type - The type of the product code (marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
virtualization-type - The virtualization type (paravirtual | hvm).
The image IDs.
Default: Describes all images available to you.
' + Owner: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ImageList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Image'
+ - xml:
+ name: item
+ DescribeImportImageTasksRequest:
+ type: object
+ title: DescribeImportImageTasksRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
+ ImportTaskId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A token that indicates the next page of results.
+ ImportImageTaskList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImportImageTask'
+ - xml:
+ name: item
+ DescribeImportSnapshotTasksRequest:
+ type: object
+ title: DescribeImportSnapshotTasksRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: The filters.
+ ImportTaskId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A token that indicates the next page of results.
+ ImportSnapshotTaskList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImportSnapshotTask'
+ - xml:
+ name: item
+ InstanceAttributeName:
+ type: string
+ enum:
+ - instanceType
+ - kernel
+ - ramdisk
+ - userData
+ - disableApiTermination
+ - instanceInitiatedShutdownBehavior
+ - rootDeviceName
+ - blockDeviceMapping
+ - productCodes
+ - sourceDestCheck
+ - groupSet
+ - ebsOptimized
+ - sriovNetSupport
+ - enaSupport
+ - enclaveOptions
+ DescribeInstanceAttributeRequest:
+ type: object
+ required:
+ - Attribute
+ - InstanceId
+ title: DescribeInstanceAttributeRequest
+ properties:
+ attribute:
+ allOf:
+ - $ref: '#/components/schemas/InstanceAttributeName'
+ - description: 'The instance attribute.
Note: The enaSupport attribute is not supported at this time.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of the instance.
+ DescribeInstanceCreditSpecificationsMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ DescribeInstanceCreditSpecificationsRequest:
+ type: object
+ title: DescribeInstanceCreditSpecificationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: The filters.
instance-id - The ID of the instance.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ InstanceEventWindowIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowId'
+ - xml:
+ name: InstanceEventWindowId
+ DescribeInstanceEventWindowsRequest:
+ type: object
+ title: DescribeInstanceEventWindowsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ InstanceEventWindowId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowIdSet'
+ - description: The IDs of the event windows.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to request the next page of results.
+ description: The filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ includeAllInstances:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ InstanceType:
+ allOf:
+ - $ref: '#/components/schemas/RequestInstanceTypeList'
+ - description: 'The instance types. For more information, see Instance types in the Amazon EC2 User Guide.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token to retrieve the next page of results.
+ InstanceTypeInfoList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTypeInfo'
+ - xml:
+ name: item
+ DescribeInstancesRequest:
+ type: object
+ title: DescribeInstancesRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. EC2-Classic only.
group-name - The name of the security group for the instance. EC2-Classic only.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (enabled | disabled)
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance''s reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The instance IDs.
Default: Describes all your instances.
' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ maxResults:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to request the next page of results.
+ ReservationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Reservation'
+ - xml:
+ name: item
+ DescribeInternetGatewaysMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ DescribeInternetGatewaysRequest:
+ type: object
+ title: DescribeInternetGatewaysRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ internetGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/DescribeInternetGatewaysMaxResults'
+ - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ InternetGatewayList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InternetGateway'
+ - xml:
+ name: item
+ DescribeIpamPoolsRequest:
+ type: object
+ title: DescribeIpamPoolsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ IpamPoolId:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The IDs of the IPAM pools you would like information on.
+ IpamPoolSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpamPool'
+ - xml:
+ name: item
+ DescribeIpamScopesRequest:
+ type: object
+ title: DescribeIpamScopesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ IpamScopeId:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The IDs of the scopes you want information on.
+ IpamScopeSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpamScope'
+ - xml:
+ name: item
+ DescribeIpamsRequest:
+ type: object
+ title: DescribeIpamsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ IpamId:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The IDs of the IPAMs you want information on.
+ IpamSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipam'
+ - xml:
+ name: item
+ DescribeIpv6PoolsRequest:
+ type: object
+ title: DescribeIpv6PoolsRequest
+ properties:
+ PoolId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The key pair names.
Default: Describes all of your key pairs.
' + KeyPairId: + allOf: + - $ref: '#/components/schemas/KeyPairIdStringList' + - description: The IDs of the key pairs. + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'If true, the public key material is included in the response.
Default: false
NextToken value. This value can be between 1 and 200.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: One or more filters.
create-time - The time the launch template version was created.
ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).
http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).
host-resource-group-arn - The ARN of the host resource group in which to launch the instances.
http-tokens - The state of token usage for your instance metadata requests (optional | required).
iam-instance-profile - The ARN of the IAM instance profile.
image-id - The ID of the AMI.
instance-type - The instance type.
is-default-version - A boolean that indicates whether the launch template version is the default version.
kernel-id - The kernel ID.
license-configuration-arn - The ARN of the license configuration.
network-card-index - The index of the network card.
ram-disk-id - The RAM disk ID.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ LaunchTemplateId:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateIdStringList'
+ - description: One or more launch template IDs.
+ LaunchTemplateName:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateNameStringList'
+ - description: One or more launch template names.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/DescribeLaunchTemplatesMaxResults'
+ - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.'
+ LaunchTemplateSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplate'
+ - xml:
+ name: item
+ LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId'
+ - xml:
+ name: item
+ DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest:
+ type: object
+ title: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest
+ properties:
+ LocalGatewayRouteTableVirtualInterfaceGroupAssociationId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet'
+ - description: The IDs of the associations.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociation'
+ - xml:
+ name: item
+ LocalGatewayRouteTableVpcAssociationIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId'
+ - xml:
+ name: item
+ DescribeLocalGatewayRouteTableVpcAssociationsRequest:
+ type: object
+ title: DescribeLocalGatewayRouteTableVpcAssociationsRequest
+ properties:
+ LocalGatewayRouteTableVpcAssociationId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationIdSet'
+ - description: The IDs of the associations.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ LocalGatewayRouteTableVpcAssociationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociation'
+ - xml:
+ name: item
+ LocalGatewayRouteTableIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRoutetableId'
+ - xml:
+ name: item
+ DescribeLocalGatewayRouteTablesRequest:
+ type: object
+ title: DescribeLocalGatewayRouteTablesRequest
+ properties:
+ LocalGatewayRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableIdSet'
+ - description: The IDs of the local gateway route tables.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ LocalGatewayRouteTableSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTable'
+ - xml:
+ name: item
+ LocalGatewayVirtualInterfaceGroupIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
+ - xml:
+ name: item
+ DescribeLocalGatewayVirtualInterfaceGroupsRequest:
+ type: object
+ title: DescribeLocalGatewayVirtualInterfaceGroupsRequest
+ properties:
+ LocalGatewayVirtualInterfaceGroupId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupIdSet'
+ - description: The IDs of the virtual interface groups.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ LocalGatewayVirtualInterfaceGroupSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroup'
+ - xml:
+ name: item
+ LocalGatewayVirtualInterfaceIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceId'
+ - xml:
+ name: item
+ DescribeLocalGatewayVirtualInterfacesRequest:
+ type: object
+ title: DescribeLocalGatewayVirtualInterfacesRequest
+ properties:
+ LocalGatewayVirtualInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceIdSet'
+ - description: The IDs of the virtual interfaces.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ LocalGatewayVirtualInterfaceSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterface'
+ - xml:
+ name: item
+ LocalGatewayIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayId'
+ - xml:
+ name: item
+ DescribeLocalGatewaysRequest:
+ type: object
+ title: DescribeLocalGatewaysRequest
+ properties:
+ LocalGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayIdSet'
+ - description: The IDs of the local gateways.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ LocalGatewaySet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGateway'
+ - xml:
+ name: item
+ DescribeManagedPrefixListsRequest:
+ type: object
+ title: DescribeManagedPrefixListsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ PrefixListId:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: One or more prefix list IDs.
+ ManagedPrefixListSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ManagedPrefixList'
+ - xml:
+ name: item
+ DescribeMovingAddressesMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ DescribeMovingAddressesRequest:
+ type: object
+ title: DescribeMovingAddressesRequest
+ properties:
+ filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ maxResults:
+ allOf:
+ - $ref: '#/components/schemas/DescribeMovingAddressesMaxResults'
+ - description: 'The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
' + nextToken: + allOf: + - $ref: '#/components/schemas/String' + - description: The token for the next page of results. + publicIp: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: One or more Elastic IP addresses. + MovingAddressStatusSet: + type: array + items: + allOf: + - $ref: '#/components/schemas/MovingAddressStatus' + - xml: + name: item + DescribeNatGatewaysMaxResults: + type: integer + minimum: 5 + maximum: 1000 + DescribeNatGatewaysRequest: + type: object + title: DescribeNatGatewaysRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/DescribeNatGatewaysMaxResults' + - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
+ NatGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next page of results.
+ NatGatewayList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NatGateway'
+ - xml:
+ name: item
+ DescribeNetworkAclsMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ DescribeNetworkAclsRequest:
+ type: object
+ title: DescribeNetworkAclsRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the Amazon Web Services account that owns the network ACL.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network ACL.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ NetworkAclId:
+ allOf:
+ - $ref: '#/components/schemas/DescribeNetworkAclsMaxResults'
+ - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ NetworkAclList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAcl'
+ - xml:
+ name: item
+ DescribeNetworkInsightsAccessScopeAnalysesRequest:
+ type: object
+ title: DescribeNetworkInsightsAccessScopeAnalysesRequest
+ properties:
+ NetworkInsightsAccessScopeAnalysisId:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: Filters the results based on the start time. The analysis must have started on or before this time.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ NetworkInsightsAccessScopeAnalysisList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysis'
+ - xml:
+ name: item
+ NetworkInsightsAccessScopeIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
+ - xml:
+ name: item
+ DescribeNetworkInsightsAccessScopesRequest:
+ type: object
+ title: DescribeNetworkInsightsAccessScopesRequest
+ properties:
+ NetworkInsightsAccessScopeId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeIdList'
+ - description: The IDs of the Network Access Scopes.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ NetworkInsightsAccessScopeList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScope'
+ - xml:
+ name: item
+ DescribeNetworkInsightsAnalysesRequest:
+ type: object
+ title: DescribeNetworkInsightsAnalysesRequest
+ properties:
+ NetworkInsightsAnalysisId:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time when the network insights analyses ended.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ NetworkInsightsAnalysisList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAnalysis'
+ - xml:
+ name: item
+ NetworkInsightsPathIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsPathId'
+ - xml:
+ name: item
+ DescribeNetworkInsightsPathsRequest:
+ type: object
+ title: DescribeNetworkInsightsPathsRequest
+ properties:
+ NetworkInsightsPathId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsPathIdList'
+ - description: The IDs of the paths.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ NetworkInsightsPathList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsPath'
+ - xml:
+ name: item
+ NetworkInterfaceAttribute:
+ type: string
+ enum:
+ - description
+ - groupSet
+ - sourceDestCheck
+ - attachment
+ DescribeNetworkInterfaceAttributeRequest:
+ type: object
+ required:
+ - NetworkInterfaceId
+ title: DescribeNetworkInterfaceAttributeRequest
+ properties:
+ attribute:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceAttribute'
+ - description: The attribute of the network interface. This parameter is required.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - description: The ID of the network interface.
+ description: Contains the parameters for DescribeNetworkInterfaceAttribute.
+ NetworkInterfaceAttachment:
+ type: object
+ properties:
+ attachTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The timestamp indicating when the attachment initiated.
+ attachmentId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network interface attachment.
+ deleteOnTermination:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the network interface is deleted when the instance is terminated.
+ deviceIndex:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The device index of the network interface attachment on the instance.
+ networkCardIndex:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The index of the network card.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance.
+ instanceOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID of the owner of the instance.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/AttachmentStatus'
+ - description: The attachment state.
+ description: Describes a network interface attachment.
+ DescribeNetworkInterfacePermissionsMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 255
+ NetworkInterfacePermissionIdList:
+ type: array
+ items:
+ $ref: '#/components/schemas/NetworkInterfacePermissionId'
+ DescribeNetworkInterfacePermissionsRequest:
+ type: object
+ title: DescribeNetworkInterfacePermissionsRequest
+ properties:
+ NetworkInterfacePermissionId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfacePermissionIdList'
+ - description: One or more network interface permission IDs.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsMaxResults'
+ - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.'
+ description: Contains the parameters for DescribeNetworkInterfacePermissions.
+ NetworkInterfacePermissionList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfacePermission'
+ - xml:
+ name: item
+ DescribeNetworkInterfacesMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ DescribeNetworkInterfacesRequest:
+ type: object
+ title: DescribeNetworkInterfacesRequest
+ properties:
+ filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attachment-id - The ID of the interface attachment.
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | efa | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ NetworkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/DescribeNetworkInterfacesMaxResults'
+ - description: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request.
+ description: Contains the parameters for DescribeNetworkInterfaces.
+ NetworkInterfaceList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterface'
+ - xml:
+ name: item
+ PlacementGroupStringList:
+ type: array
+ items:
+ $ref: '#/components/schemas/PlacementGroupName'
+ PlacementGroupIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PlacementGroupId'
+ - xml:
+ name: GroupId
+ DescribePlacementGroupsRequest:
+ type: object
+ title: DescribePlacementGroupsRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'The filters.
group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ groupName:
+ allOf:
+ - $ref: '#/components/schemas/PlacementGroupStringList'
+ - description: 'The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
' + GroupId: + allOf: + - $ref: '#/components/schemas/PlacementGroupIdStringList' + - description: The IDs of the placement groups. + PlacementGroupList: + type: array + items: + allOf: + - $ref: '#/components/schemas/PlacementGroup' + - xml: + name: item + PrefixListResourceIdStringList: + type: array + items: + allOf: + - $ref: '#/components/schemas/PrefixListResourceId' + - xml: + name: item + DescribePrefixListsRequest: + type: object + title: DescribePrefixListsRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next page of results.
+ PrefixListId:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListResourceIdStringList'
+ - description: One or more prefix list IDs.
+ PrefixListSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PrefixList'
+ - xml:
+ name: item
+ DescribePrincipalIdFormatMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ DescribePrincipalIdFormatRequest:
+ type: object
+ title: DescribePrincipalIdFormatRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Resource:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to request the next page of results.
+ PrincipalIdFormatList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PrincipalIdFormat'
+ - xml:
+ name: item
+ PoolMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 10
+ DescribePublicIpv4PoolsRequest:
+ type: object
+ title: DescribePublicIpv4PoolsRequest
+ properties:
+ PoolId:
+ allOf:
+ - $ref: '#/components/schemas/PoolMaxResults'
+ - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).
region-name - The name of the Region (for example, us-east-1).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ReplaceRootVolumeTasks:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReplaceRootVolumeTask'
+ - xml:
+ name: item
+ DescribeReservedInstancesListingsRequest:
+ type: object
+ title: DescribeReservedInstancesListingsRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: One or more filters.
reserved-instances-id - The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active | cancelled | closed).
status-message - The reason for the status.
One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
(Amazon VPC) in the description are for use with Amazon VPC.
+ ReservedInstancesOfferingId:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesOfferingIdStringList'
+ - description: One or more Reserved Instances offering IDs.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ instanceTenancy:
+ allOf:
+ - $ref: '#/components/schemas/Tenancy'
+ - description: 'The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.
Default: 100
' + nextToken: + allOf: + - $ref: '#/components/schemas/String' + - description: The token to retrieve the next page of results. + offeringType: + allOf: + - $ref: '#/components/schemas/OfferingTypeValues' + - description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to theMedium Utilization Reserved Instance offering type. '
+ description: Contains the parameters for DescribeReservedInstancesOfferings.
+ ReservedInstancesOfferingList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesOffering'
+ - xml:
+ name: item
+ OfferingClassType:
+ type: string
+ enum:
+ - standard
+ - convertible
+ ReservedInstancesIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservationId'
+ - xml:
+ name: ReservedInstancesId
+ DescribeReservedInstancesRequest:
+ type: object
+ title: DescribeReservedInstancesRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/OfferingClassType'
+ - description: Describes whether the Reserved Instance is Standard or Convertible.
+ ReservedInstancesId:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesIdStringList'
+ - description: 'One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ offeringType:
+ allOf:
+ - $ref: '#/components/schemas/OfferingTypeValues'
+ - description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.'
+ description: Contains the parameters for DescribeReservedInstances.
+ ReservedInstancesList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstances'
+ - xml:
+ name: item
+ DescribeRouteTablesMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 100
+ DescribeRouteTablesRequest:
+ type: object
+ title: DescribeRouteTablesRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.
owner-id - The ID of the Amazon Web Services account that owns the route table.
route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service specified in a route in the table.
route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.transit-gateway-id - The ID of a transit gateway.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route''s target isn''t available (for example, the specified gateway isn''t attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the route table.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ RouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/DescribeRouteTablesMaxResults'
+ - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ RouteTableList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/RouteTable'
+ - xml:
+ name: item
+ DescribeScheduledInstanceAvailabilityMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 300
+ ScheduledInstanceRecurrenceRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.'
+ OccurrenceDay:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
+ description: Describes the recurring schedule for a Scheduled Instance.
+ DescribeScheduledInstanceAvailabilityRequest:
+ type: object
+ required:
+ - FirstSlotStartTimeRange
+ - Recurrence
+ title: DescribeScheduledInstanceAvailabilityRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/ScheduledInstanceRecurrenceRequest'
+ - description: The schedule recurrence.
+ description: Contains the parameters for DescribeScheduledInstanceAvailability.
+ ScheduledInstanceAvailabilitySet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ScheduledInstanceAvailability'
+ - xml:
+ name: item
+ SlotStartTimeRangeRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The latest date and time, in UTC, for the Scheduled Instance to start.'
+ description: Describes the time period for a Scheduled Instance to start its first schedule.
+ DescribeScheduledInstancesRequest:
+ type: object
+ title: DescribeScheduledInstancesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next set of results.
+ ScheduledInstanceId:
+ allOf:
+ - $ref: '#/components/schemas/SlotStartTimeRangeRequest'
+ - description: The time period for the first schedule to start.
+ description: Contains the parameters for DescribeScheduledInstances.
+ ScheduledInstanceSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ScheduledInstance'
+ - xml:
+ name: item
+ GroupIds:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: item
+ DescribeSecurityGroupReferencesRequest:
+ type: object
+ required:
+ - GroupId
+ title: DescribeSecurityGroupReferencesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/GroupIds'
+ - description: The IDs of the security groups in your account.
+ SecurityGroupReferences:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupReference'
+ - xml:
+ name: item
+ DescribeSecurityGroupRulesMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ DescribeSecurityGroupRulesRequest:
+ type: object
+ title: DescribeSecurityGroupRulesRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
group-id - The ID of the security group.
security-group-rule-id - The ID of the security group rule.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.'
+ DescribeSecurityGroupsMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ GroupNameStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupName'
+ - xml:
+ name: GroupName
+ DescribeSecurityGroupsRequest:
+ type: object
+ title: DescribeSecurityGroupsRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
description - The description of the security group.
egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.
egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.
egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule.
egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an outbound security group rule.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.
ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule.
ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an inbound security group rule.
owner-id - The Amazon Web Services account ID of the owner of the security group.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC specified when the security group was created.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
' + GroupName: + allOf: + - $ref: '#/components/schemas/GroupNameStringList' + - description: '[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
' + dryRun: + allOf: + - $ref: '#/components/schemas/DescribeSecurityGroupsMaxResults' + - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returnedNextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.'
+ SecurityGroupList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroup'
+ - xml:
+ name: item
+ DescribeSnapshotAttributeRequest:
+ type: object
+ required:
+ - Attribute
+ - SnapshotId
+ title: DescribeSnapshotAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotId'
+ - description: The ID of the EBS snapshot.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ProductCodeList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ProductCode'
+ - xml:
+ name: item
+ DescribeSnapshotTierStatusMaxResults:
+ type: integer
+ DescribeSnapshotTierStatusRequest:
+ type: object
+ title: DescribeSnapshotTierStatusRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/DescribeSnapshotTierStatusMaxResults'
+ - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ snapshotTierStatusSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotTierStatus'
+ - xml:
+ name: item
+ RestorableByStringList:
+ type: array
+ items:
+ $ref: '#/components/schemas/String'
+ SnapshotIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotId'
+ - xml:
+ name: SnapshotId
+ DescribeSnapshotsRequest:
+ type: object
+ title: DescribeSnapshotsRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
+ Owner:
+ allOf:
+ - $ref: '#/components/schemas/OwnerStringList'
+ - description: 'Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.'
+ RestorableBy:
+ allOf:
+ - $ref: '#/components/schemas/RestorableByStringList'
+ - description: The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
+ SnapshotId:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotIdStringList'
+ - description: 'The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SnapshotList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Snapshot'
+ - xml:
+ name: item
+ DescribeSpotDatafeedSubscriptionRequest:
+ type: object
+ title: DescribeSpotDatafeedSubscriptionRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DescribeSpotDatafeedSubscription.
+ DescribeSpotFleetInstancesMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ DescribeSpotFleetInstancesRequest:
+ type: object
+ required:
+ - SpotFleetRequestId
+ title: DescribeSpotFleetInstancesRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ maxResults:
+ allOf:
+ - $ref: '#/components/schemas/DescribeSpotFleetInstancesMaxResults'
+ - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next set of results.
+ spotFleetRequestId:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetRequestId'
+ - description: The ID of the Spot Fleet request.
+ description: Contains the parameters for DescribeSpotFleetInstances.
+ DescribeSpotFleetRequestHistoryMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ EventType:
+ type: string
+ enum:
+ - instanceChange
+ - fleetRequestChange
+ - error
+ - information
+ DescribeSpotFleetRequestHistoryRequest:
+ type: object
+ required:
+ - SpotFleetRequestId
+ - StartTime
+ title: DescribeSpotFleetRequestHistoryRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ eventType:
+ allOf:
+ - $ref: '#/components/schemas/EventType'
+ - description: 'The type of events to describe. By default, all events are described.'
+ maxResults:
+ allOf:
+ - $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryMaxResults'
+ - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next set of results.
+ spotFleetRequestId:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetRequestId'
+ - description: The ID of the Spot Fleet request.
+ startTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ description: Contains the parameters for DescribeSpotFleetRequestHistory.
+ HistoryRecords:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/HistoryRecord'
+ - xml:
+ name: item
+ DescribeSpotFleetRequestsRequest:
+ type: object
+ title: DescribeSpotFleetRequestsRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ maxResults:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next set of results.
+ spotFleetRequestId:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetRequestIdList'
+ - description: The IDs of the Spot Fleet requests.
+ description: Contains the parameters for DescribeSpotFleetRequests.
+ SpotFleetRequestConfigSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetRequestConfig'
+ - xml:
+ name: item
+ DescribeSpotInstanceRequestsRequest:
+ type: object
+ title: DescribeSpotInstanceRequestsRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.
launch.group-id - The ID of the security group for the instance.
launch.group-name - The name of the security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m3.medium).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
launched-availability-zone - The Availability Zone in which the request is launched.
network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
network-interface.description - A description of the network interface.
network-interface.device-index - The index of the device for the network interface attachment on the instance.
network-interface.group-id - The ID of the security group associated with the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.private-ip-address - The primary private IP address of the network interface.
network-interface.subnet-id - The ID of the subnet for the instance.
product-description - The product description associated with the instance (Linux/UNIX | Windows).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of Spot Instance request (one-time | persistent).
valid-from - The start date of the request.
valid-until - The end date of the request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SpotInstanceRequestId:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ description: Contains the parameters for DescribeSpotInstanceRequests.
+ SpotInstanceRequestList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SpotInstanceRequest'
+ - xml:
+ name: item
+ InstanceTypeList:
+ type: array
+ items:
+ $ref: '#/components/schemas/InstanceType'
+ ProductDescriptionList:
+ type: array
+ items:
+ $ref: '#/components/schemas/String'
+ DescribeSpotPriceHistoryRequest:
+ type: object
+ title: DescribeSpotPriceHistoryRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m3.medium).
product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ endTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ InstanceType:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTypeList'
+ - description: Filters the results by the specified instance types.
+ maxResults:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next set of results.
+ ProductDescription:
+ allOf:
+ - $ref: '#/components/schemas/ProductDescriptionList'
+ - description: Filters the results by the specified basic product descriptions.
+ startTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ description: Contains the parameters for DescribeSpotPriceHistory.
+ SpotPriceHistoryList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SpotPrice'
+ - xml:
+ name: item
+ DescribeStaleSecurityGroupsMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 255
+ DescribeStaleSecurityGroupsNextToken:
+ type: string
+ minLength: 1
+ maxLength: 1024
+ DescribeStaleSecurityGroupsRequest:
+ type: object
+ required:
+ - VpcId
+ title: DescribeStaleSecurityGroupsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ StaleSecurityGroupSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/StaleSecurityGroup'
+ - xml:
+ name: item
+ DescribeStoreImageTasksRequestMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 200
+ DescribeStoreImageTasksRequest:
+ type: object
+ title: DescribeStoreImageTasksRequest
+ properties:
+ ImageId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/DescribeStoreImageTasksRequestMaxResults'
+ - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200. You cannot specify this parameter and the ImageIDs parameter in the same call.'
+ StoreImageTaskResultSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/StoreImageTaskResult'
+ - xml:
+ name: item
+ DescribeSubnetsMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ SubnetIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - xml:
+ name: SubnetId
+ DescribeSubnetsRequest:
+ type: object
+ title: DescribeSubnetsRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.
availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.
available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet''s CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.
default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the subnet.
state - The state of the subnet (pending | available).
subnet-arn - The Amazon Resource Name (ARN) of the subnet.
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the subnet.
One or more subnet IDs.
Default: Describes all your subnets.
' + dryRun: + allOf: + - $ref: '#/components/schemas/DescribeSubnetsMaxResults' + - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
+ SubnetList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Subnet'
+ - xml:
+ name: item
+ DescribeTagsRequest:
+ type: object
+ title: DescribeTagsRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.
NextToken value.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to retrieve the next page of results.
+ TagDescriptionList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TagDescription'
+ - xml:
+ name: item
+ DescribeTrafficMirrorFiltersRequest:
+ type: object
+ title: DescribeTrafficMirrorFiltersRequest
+ properties:
+ TrafficMirrorFilterId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ TrafficMirrorFilterSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorFilter'
+ - xml:
+ name: item
+ DescribeTrafficMirrorSessionsRequest:
+ type: object
+ title: DescribeTrafficMirrorSessionsRequest
+ properties:
+ TrafficMirrorSessionId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ TrafficMirrorSessionSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorSession'
+ - xml:
+ name: item
+ DescribeTrafficMirrorTargetsRequest:
+ type: object
+ title: DescribeTrafficMirrorTargetsRequest
+ properties:
+ TrafficMirrorTargetId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ TrafficMirrorTargetSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorTarget'
+ - xml:
+ name: item
+ TransitGatewayAttachmentIdStringList:
+ type: array
+ items:
+ $ref: '#/components/schemas/TransitGatewayAttachmentId'
+ DescribeTransitGatewayAttachmentsRequest:
+ type: object
+ title: DescribeTransitGatewayAttachmentsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList'
+ - description: The IDs of the attachments.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayAttachmentList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachment'
+ - xml:
+ name: item
+ TransitGatewayConnectPeerIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnectPeerId'
+ - xml:
+ name: item
+ DescribeTransitGatewayConnectPeersRequest:
+ type: object
+ title: DescribeTransitGatewayConnectPeersRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnectPeerIdStringList'
+ - description: The IDs of the Connect peers.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayConnectPeerList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnectPeer'
+ - xml:
+ name: item
+ DescribeTransitGatewayConnectsRequest:
+ type: object
+ title: DescribeTransitGatewayConnectsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList'
+ - description: The IDs of the attachments.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayConnectList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayConnect'
+ - xml:
+ name: item
+ TransitGatewayMulticastDomainIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
+ - xml:
+ name: item
+ DescribeTransitGatewayMulticastDomainsRequest:
+ type: object
+ title: DescribeTransitGatewayMulticastDomainsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomainIdStringList'
+ - description: The ID of the transit gateway multicast domain.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayMulticastDomainList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomain'
+ - xml:
+ name: item
+ DescribeTransitGatewayPeeringAttachmentsRequest:
+ type: object
+ title: DescribeTransitGatewayPeeringAttachmentsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList'
+ - description: One or more IDs of the transit gateway peering attachments.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayPeeringAttachmentList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
+ - xml:
+ name: item
+ TransitGatewayRouteTableIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableId'
+ - xml:
+ name: item
+ DescribeTransitGatewayRouteTablesRequest:
+ type: object
+ title: DescribeTransitGatewayRouteTablesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableIdStringList'
+ - description: The IDs of the transit gateway route tables.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayRouteTableList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTable'
+ - xml:
+ name: item
+ DescribeTransitGatewayVpcAttachmentsRequest:
+ type: object
+ title: DescribeTransitGatewayVpcAttachmentsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList'
+ - description: The IDs of the attachments.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayVpcAttachmentList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayVpcAttachment'
+ - xml:
+ name: item
+ TransitGatewayIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayId'
+ - xml:
+ name: item
+ DescribeTransitGatewaysRequest:
+ type: object
+ title: DescribeTransitGatewaysRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayIdStringList'
+ - description: The IDs of the transit gateways.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGateway'
+ - xml:
+ name: item
+ DescribeTrunkInterfaceAssociationsMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 255
+ DescribeTrunkInterfaceAssociationsRequest:
+ type: object
+ title: DescribeTrunkInterfaceAssociationsRequest
+ properties:
+ AssociationId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsMaxResults'
+ - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ TrunkInterfaceAssociationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TrunkInterfaceAssociation'
+ - xml:
+ name: item
+ DescribeVolumeAttributeRequest:
+ type: object
+ required:
+ - Attribute
+ - VolumeId
+ title: DescribeVolumeAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VolumeId'
+ - description: The ID of the volume.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ VolumeIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VolumeId'
+ - xml:
+ name: VolumeId
+ DescribeVolumeStatusRequest:
+ type: object
+ title: DescribeVolumeStatusRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.'
+ VolumeId:
+ allOf:
+ - $ref: '#/components/schemas/VolumeIdStringList'
+ - description: 'The IDs of the volumes.
Default: Describes all your volumes.
' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ VolumeStatusList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusItem'
+ - xml:
+ name: item
+ DescribeVolumesModificationsRequest:
+ type: object
+ title: DescribeVolumesModificationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ VolumeId:
+ allOf:
+ - $ref: '#/components/schemas/VolumeIdStringList'
+ - description: The IDs of the volumes.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The maximum number of results (up to a limit of 500) to be returned in a paginated request.
+ VolumeModificationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VolumeModification'
+ - xml:
+ name: item
+ DescribeVolumesRequest:
+ type: object
+ title: DescribeVolumesRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true | false)
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available | in-use | deleting | deleted | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ maxResults:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
+ VolumeList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Volume'
+ - xml:
+ name: item
+ DescribeVpcAttributeRequest:
+ type: object
+ required:
+ - Attribute
+ - VpcId
+ title: DescribeVpcAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DescribeVpcClassicLinkDnsSupportMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 255
+ DescribeVpcClassicLinkDnsSupportNextToken:
+ type: string
+ minLength: 1
+ maxLength: 1024
+ VpcClassicLinkIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - xml:
+ name: VpcId
+ DescribeVpcClassicLinkDnsSupportRequest:
+ type: object
+ title: DescribeVpcClassicLinkDnsSupportRequest
+ properties:
+ maxResults:
+ allOf:
+ - $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportMaxResults'
+ - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ nextToken:
+ allOf:
+ - $ref: '#/components/schemas/VpcClassicLinkIdList'
+ - description: One or more VPC IDs.
+ DescribeVpcClassicLinkRequest:
+ type: object
+ title: DescribeVpcClassicLinkRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ VpcId:
+ allOf:
+ - $ref: '#/components/schemas/VpcClassicLinkIdList'
+ - description: One or more VPCs for which you want to describe the ClassicLink status.
+ VpcClassicLinkList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcClassicLink'
+ - xml:
+ name: item
+ DescribeVpcEndpointConnectionNotificationsRequest:
+ type: object
+ title: DescribeVpcEndpointConnectionNotificationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ConnectionNotificationId'
+ - description: The ID of the notification.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to request the next page of results.
+ DescribeVpcEndpointConnectionsRequest:
+ type: object
+ title: DescribeVpcEndpointConnectionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to retrieve the next page of results.
+ VpcEndpointConnectionSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointConnection'
+ - xml:
+ name: item
+ DescribeVpcEndpointServiceConfigurationsRequest:
+ type: object
+ title: DescribeVpcEndpointServiceConfigurationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ServiceId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointServiceIdList'
+ - description: The IDs of one or more services.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to retrieve the next page of results.
+ ServiceConfigurationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ServiceConfiguration'
+ - xml:
+ name: item
+ DescribeVpcEndpointServicePermissionsRequest:
+ type: object
+ required:
+ - ServiceId
+ title: DescribeVpcEndpointServicePermissionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointServiceId'
+ - description: The ID of the service.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token to retrieve the next page of results.
+ DescribeVpcEndpointServicesRequest:
+ type: object
+ title: DescribeVpcEndpointServicesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ServiceName:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: One or more service names.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next set of items to return. (You received this token from a prior call.)
+ description: Contains the parameters for DescribeVpcEndpointServices.
+ ServiceDetailSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ServiceDetail'
+ - xml:
+ name: item
+ DescribeVpcEndpointsRequest:
+ type: object
+ title: DescribeVpcEndpointsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ VpcEndpointId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointIdList'
+ - description: One or more endpoint IDs.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next set of items to return. (You received this token from a prior call.)
+ description: Contains the parameters for DescribeVpcEndpoints.
+ VpcEndpointSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpoint'
+ - xml:
+ name: item
+ DescribeVpcPeeringConnectionsMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ DescribeVpcPeeringConnectionsRequest:
+ type: object
+ title: DescribeVpcPeeringConnectionsRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester''s VPC.
requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-peering-connection-id - The ID of the VPC peering connection.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ VpcPeeringConnectionId:
+ allOf:
+ - $ref: '#/components/schemas/DescribeVpcPeeringConnectionsMaxResults'
+ - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
+ VpcPeeringConnectionList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnection'
+ - xml:
+ name: item
+ DescribeVpcsMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ VpcIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - xml:
+ name: VpcId
+ DescribeVpcsRequest:
+ type: object
+ title: DescribeVpcsRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC''s CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
is-default - Indicates whether the VPC is the default VPC.
owner-id - The ID of the Amazon Web Services account that owns the VPC.
state - The state of the VPC (pending | available).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC.
One or more VPC IDs.
Default: Describes all your VPCs.
' + dryRun: + allOf: + - $ref: '#/components/schemas/DescribeVpcsMaxResults' + - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
+ VpcList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Vpc'
+ - xml:
+ name: item
+ VpnConnectionIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpnConnectionId'
+ - xml:
+ name: VpnConnectionId
+ DescribeVpnConnectionsRequest:
+ type: object
+ title: DescribeVpnConnectionsRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
One or more VPN connection IDs.
Default: Describes your VPN connections.
' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DescribeVpnConnections.
+ VpnConnectionList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpnConnection'
+ - xml:
+ name: item
+ VpnGatewayIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpnGatewayId'
+ - xml:
+ name: VpnGatewayId
+ DescribeVpnGatewaysRequest:
+ type: object
+ title: DescribeVpnGatewaysRequest
+ properties:
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/FilterList'
+ - description: 'One or more filters.
amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway (if applicable).
state - The state of the virtual private gateway (pending | available | deleting | deleted).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DescribeVpnGateways.
+ VpnGatewayList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpnGateway'
+ - xml:
+ name: item
+ DestinationFileFormat:
+ type: string
+ enum:
+ - plain-text
+ - parquet
+ DestinationOptionsResponse:
+ type: object
+ properties:
+ fileFormat:
+ allOf:
+ - $ref: '#/components/schemas/DestinationFileFormat'
+ - description: The format for the flow log.
+ hiveCompatiblePartitions:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.
+ perHourPartition:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to partition the flow log per hour.
+ description: Describes the destination options for a flow log.
+ DetachClassicLinkVpcRequest:
+ type: object
+ required:
+ - InstanceId
+ - VpcId
+ title: DetachClassicLinkVpcRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of the instance to unlink from the VPC.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC to which the instance is linked.
+ DetachInternetGatewayRequest:
+ type: object
+ required:
+ - InternetGatewayId
+ - VpcId
+ title: DetachInternetGatewayRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ internetGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/InternetGatewayId'
+ - description: The ID of the internet gateway.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ DetachNetworkInterfaceRequest:
+ type: object
+ required:
+ - AttachmentId
+ title: DetachNetworkInterfaceRequest
+ properties:
+ attachmentId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceAttachmentId'
+ - description: The ID of the attachment.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ force:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Specifies whether to force a detachment.
Use the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DetachVpnGatewayRequest:
+ type: object
+ required:
+ - VpcId
+ - VpnGatewayId
+ title: DetachVpnGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpnGatewayId'
+ - description: The ID of the virtual private gateway.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DetachVpnGateway.
+ DeviceType:
+ type: string
+ enum:
+ - ebs
+ - instance-store
+ DhcpConfigurationValueList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - xml:
+ name: item
+ DhcpConfiguration:
+ type: object
+ properties:
+ key:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of a DHCP option.
+ valueSet:
+ allOf:
+ - $ref: '#/components/schemas/DhcpConfigurationValueList'
+ - description: One or more values for the DHCP option.
+ description: Describes a DHCP configuration option.
+ DhcpConfigurationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DhcpConfiguration'
+ - xml:
+ name: item
+ DirectoryServiceAuthenticationRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Active Directory to be used for authentication.
+ description: Describes the Active Directory to be used for client authentication.
+ DisableEbsEncryptionByDefaultRequest:
+ type: object
+ title: DisableEbsEncryptionByDefaultRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DisableFastLaunchRequest:
+ type: object
+ required:
+ - ImageId
+ title: DisableFastLaunchRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DisableFastSnapshotRestoreStateErrorSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DisableFastSnapshotRestoreStateErrorItem'
+ - xml:
+ name: item
+ DisableFastSnapshotRestoreErrorItem:
+ type: object
+ properties:
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the snapshot.
+ fastSnapshotRestoreStateErrorSet:
+ allOf:
+ - $ref: '#/components/schemas/DisableFastSnapshotRestoreStateErrorSet'
+ - description: The errors.
+ description: Contains information about the errors that occurred when disabling fast snapshot restores.
+ DisableFastSnapshotRestoreErrorSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DisableFastSnapshotRestoreErrorItem'
+ - xml:
+ name: item
+ DisableFastSnapshotRestoreStateError:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The error code.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The error message.
+ description: Describes an error that occurred when disabling fast snapshot restores.
+ DisableFastSnapshotRestoreStateErrorItem:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone.
+ error:
+ allOf:
+ - $ref: '#/components/schemas/DisableFastSnapshotRestoreStateError'
+ - description: The error.
+ description: Contains information about an error that occurred when disabling fast snapshot restores.
+ DisableFastSnapshotRestoreSuccessItem:
+ type: object
+ properties:
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the snapshot.
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/FastSnapshotRestoreStateCode'
+ - description: The state of fast snapshot restores for the snapshot.
+ stateTransitionReason:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
enabling state.
+ optimizingTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time at which fast snapshot restores entered the optimizing state.
+ enabledTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time at which fast snapshot restores entered the enabled state.
+ disablingTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time at which fast snapshot restores entered the disabling state.
+ disabledTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time at which fast snapshot restores entered the disabled state.
+ description: Describes fast snapshot restores that were successfully disabled.
+ DisableFastSnapshotRestoreSuccessSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/DisableFastSnapshotRestoreSuccessItem'
+ - xml:
+ name: item
+ DisableFastSnapshotRestoresRequest:
+ type: object
+ required:
+ - AvailabilityZones
+ - SourceSnapshotIds
+ title: DisableFastSnapshotRestoresRequest
+ properties:
+ AvailabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/AvailabilityZoneStringList'
+ - description: 'One or more Availability Zones. For example, us-east-2a.'
+ SourceSnapshotId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DisableImageDeprecationRequest:
+ type: object
+ required:
+ - ImageId
+ title: DisableImageDeprecationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DisableIpamOrganizationAdminAccountRequest:
+ type: object
+ required:
+ - DelegatedAdminAccountId
+ title: DisableIpamOrganizationAdminAccountRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Organizations member account ID that you want to disable as IPAM account.
+ DisableSerialConsoleAccessRequest:
+ type: object
+ title: DisableSerialConsoleAccessRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DisableTransitGatewayRouteTablePropagationRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ - TransitGatewayAttachmentId
+ title: DisableTransitGatewayRouteTablePropagationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayPropagation:
+ type: object
+ properties:
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentId'
+ - description: The ID of the attachment.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
+ - description: The resource type. Note that the tgw-peering resource type has been deprecated.
+ transitGatewayRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway route table.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPropagationState'
+ - description: The state.
+ description: Describes route propagation.
+ DisableVgwRoutePropagationRequest:
+ type: object
+ required:
+ - GatewayId
+ - RouteTableId
+ title: DisableVgwRoutePropagationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for DisableVgwRoutePropagation.
+ DisableVpcClassicLinkDnsSupportRequest:
+ type: object
+ title: DisableVpcClassicLinkDnsSupportRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ DisableVpcClassicLinkRequest:
+ type: object
+ required:
+ - VpcId
+ title: DisableVpcClassicLinkRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ DisassociateAddressRequest:
+ type: object
+ title: DisassociateAddressRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.'
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DisassociateClientVpnTargetNetworkRequest:
+ type: object
+ required:
+ - ClientVpnEndpointId
+ - AssociationId
+ title: DisassociateClientVpnTargetNetworkRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DisassociateEnclaveCertificateIamRoleRequest:
+ type: object
+ title: DisassociateEnclaveCertificateIamRoleRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DisassociateIamInstanceProfileRequest:
+ type: object
+ required:
+ - AssociationId
+ title: DisassociateIamInstanceProfileRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/IamInstanceProfileAssociationId'
+ - description: The ID of the IAM instance profile association.
+ InstanceEventWindowDisassociationRequest:
+ type: object
+ properties:
+ InstanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdList'
+ - description: The IDs of the instances to disassociate from the event window.
+ InstanceTag:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window.
+ DedicatedHostId:
+ allOf:
+ - $ref: '#/components/schemas/DedicatedHostIdList'
+ - description: The IDs of the Dedicated Hosts to disassociate from the event window.
+ description: The targets to disassociate from the specified event window.
+ DisassociateInstanceEventWindowRequest:
+ type: object
+ required:
+ - InstanceEventWindowId
+ - AssociationTarget
+ title: DisassociateInstanceEventWindowRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowDisassociationRequest'
+ - description: One or more targets to disassociate from the specified event window.
+ RouteTableAssociationId:
+ type: string
+ DisassociateRouteTableRequest:
+ type: object
+ required:
+ - AssociationId
+ title: DisassociateRouteTableRequest
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableAssociationId'
+ - description: The association ID representing the current association between the route table and subnet or gateway.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SubnetCidrAssociationId:
+ type: string
+ DisassociateSubnetCidrBlockRequest:
+ type: object
+ required:
+ - AssociationId
+ title: DisassociateSubnetCidrBlockRequest
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/SubnetCidrAssociationId'
+ - description: The association ID for the CIDR block.
+ DisassociateTransitGatewayMulticastDomainRequest:
+ type: object
+ title: DisassociateTransitGatewayMulticastDomainRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DisassociateTransitGatewayRouteTableRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ - TransitGatewayAttachmentId
+ title: DisassociateTransitGatewayRouteTableRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ DisassociateTrunkInterfaceRequest:
+ type: object
+ required:
+ - AssociationId
+ title: DisassociateTrunkInterfaceRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ VpcCidrAssociationId:
+ type: string
+ DisassociateVpcCidrBlockRequest:
+ type: object
+ required:
+ - AssociationId
+ title: DisassociateVpcCidrBlockRequest
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/VpcCidrAssociationId'
+ - description: The association ID for the CIDR block.
+ DiskCount:
+ type: integer
+ VolumeDetail:
+ type: object
+ required:
+ - Size
+ properties:
+ size:
+ type: integer
+ description: 'The size of the volume, in GiB.'
+ description: Describes an EBS volume.
+ DiskImageDescription:
+ type: object
+ properties:
+ checksum:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The checksum computed for the disk image.
+ format:
+ allOf:
+ - $ref: '#/components/schemas/DiskImageFormat'
+ - description: The disk image format.
+ importManifestUrl:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' + size: + allOf: + - $ref: '#/components/schemas/Long' + - description: 'The size of the disk image, in GiB.' + description: Describes a disk image. + DiskImageDetail: + type: object + required: + - Bytes + - Format + - ImportManifestUrl + properties: + bytes: + allOf: + - $ref: '#/components/schemas/Long' + - description: 'The size of the disk image, in GiB.' + format: + allOf: + - $ref: '#/components/schemas/DiskImageFormat' + - description: The disk image format. + importManifestUrl: + allOf: + - $ref: '#/components/schemas/String' + - description: 'A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' + description: Describes a disk image. + DiskImageList: + type: array + items: + $ref: '#/components/schemas/DiskImage' + DiskImageVolumeDescription: + type: object + properties: + id: + allOf: + - $ref: '#/components/schemas/String' + - description: The volume identifier. + size: + allOf: + - $ref: '#/components/schemas/Long' + - description: 'The size of the volume, in GiB.' + description: Describes a disk image volume. + DiskSize: + type: integer + DiskType: + type: string + enum: + - hdd + - ssd + DiskInfo: + type: object + properties: + sizeInGB: + allOf: + - $ref: '#/components/schemas/DiskSize' + - description: The size of the disk in GB. + count: + allOf: + - $ref: '#/components/schemas/DiskCount' + - description: The number of disks with this configuration. + type: + allOf: + - $ref: '#/components/schemas/DiskType' + - description: The type of disk. + description: Describes a disk. + DiskInfoList: + type: array + items: + allOf: + - $ref: '#/components/schemas/DiskInfo' + - xml: + name: item + DnsEntry: + type: object + properties: + dnsName: + allOf: + - $ref: '#/components/schemas/String' + - description: The DNS name. + hostedZoneId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the private hosted zone. + description: Describes a DNS entry. + DnsEntrySet: + type: array + items: + allOf: + - $ref: '#/components/schemas/DnsEntry' + - xml: + name: item + DnsNameState: + type: string + enum: + - pendingVerification + - verified + - failed + DnsOptions: + type: object + properties: + dnsRecordIpType: + allOf: + - $ref: '#/components/schemas/DnsRecordIpType' + - description: The DNS records created for the endpoint. + description: Describes the DNS options for an endpoint. + DnsOptionsSpecification: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/DnsRecordIpType' + - description: The DNS records created for the endpoint. + description: Describes the DNS options for an endpoint. + DnsServersOptionsModifyStructure: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Indicates whether DNS servers should be used. SpecifyFalse to delete the existing DNS servers.
+ description: Information about the DNS server to be used.
+ DnsSupportValue:
+ type: string
+ enum:
+ - enable
+ - disable
+ DoubleWithConstraints:
+ type: number
+ format: double
+ minimum: 0.001
+ maximum: 99.999
+ EbsEncryptionSupport:
+ type: string
+ enum:
+ - unsupported
+ - supported
+ EbsOptimizedSupport:
+ type: string
+ enum:
+ - unsupported
+ - supported
+ - default
+ EbsOptimizedInfo:
+ type: object
+ properties:
+ baselineBandwidthInMbps:
+ allOf:
+ - $ref: '#/components/schemas/BaselineBandwidthInMbps'
+ - description: 'The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.'
+ baselineThroughputInMBps:
+ allOf:
+ - $ref: '#/components/schemas/BaselineThroughputInMBps'
+ - description: 'The baseline throughput performance for an EBS-optimized instance type, in MB/s.'
+ baselineIops:
+ allOf:
+ - $ref: '#/components/schemas/BaselineIops'
+ - description: The baseline input/output storage operations per seconds for an EBS-optimized instance type.
+ maximumBandwidthInMbps:
+ allOf:
+ - $ref: '#/components/schemas/MaximumBandwidthInMbps'
+ - description: 'The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.'
+ maximumThroughputInMBps:
+ allOf:
+ - $ref: '#/components/schemas/MaximumThroughputInMBps'
+ - description: 'The maximum throughput performance for an EBS-optimized instance type, in MB/s.'
+ maximumIops:
+ allOf:
+ - $ref: '#/components/schemas/MaximumIops'
+ - description: The maximum input/output storage operations per second for an EBS-optimized instance type.
+ description: Describes the optimized EBS performance for supported instance types.
+ EbsNvmeSupport:
+ type: string
+ enum:
+ - unsupported
+ - supported
+ - required
+ EbsInfo:
+ type: object
+ properties:
+ ebsOptimizedSupport:
+ allOf:
+ - $ref: '#/components/schemas/EbsOptimizedSupport'
+ - description: 'Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized instances in Amazon EC2 User Guide.'
+ encryptionSupport:
+ allOf:
+ - $ref: '#/components/schemas/EbsEncryptionSupport'
+ - description: Indicates whether Amazon EBS encryption is supported.
+ ebsOptimizedInfo:
+ allOf:
+ - $ref: '#/components/schemas/EbsOptimizedInfo'
+ - description: Describes the optimized EBS performance for the instance type.
+ nvmeSupport:
+ allOf:
+ - $ref: '#/components/schemas/EbsNvmeSupport'
+ - description: Indicates whether non-volatile memory express (NVMe) is supported.
+ description: Describes the Amazon EBS features supported by the instance type.
+ EbsInstanceBlockDevice:
+ type: object
+ properties:
+ attachTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time stamp when the attachment initiated.
+ deleteOnTermination:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the volume is deleted on instance termination.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/AttachmentStatus'
+ - description: The attachment state.
+ volumeId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the EBS volume.
+ description: Describes a parameter used to set up an EBS volume in a block device mapping.
+ EbsInstanceBlockDeviceSpecification:
+ type: object
+ properties:
+ deleteOnTermination:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the volume is deleted on instance termination.
+ volumeId:
+ allOf:
+ - $ref: '#/components/schemas/VolumeId'
+ - description: The ID of the EBS volume.
+ description: Describes information used to set up an EBS volume specified in a block device mapping.
+ MaximumBandwidthInMbps:
+ type: integer
+ MaximumThroughputInMBps:
+ type: number
+ format: double
+ MaximumIops:
+ type: integer
+ MaximumEfaInterfaces:
+ type: integer
+ EfaInfo:
+ type: object
+ properties:
+ maximumEfaInterfaces:
+ allOf:
+ - $ref: '#/components/schemas/MaximumEfaInterfaces'
+ - description: The maximum number of Elastic Fabric Adapters for the instance type.
+ description: Describes the Elastic Fabric Adapters for the instance type.
+ EfaSupportedFlag:
+ type: boolean
+ InternetGatewayAttachmentList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InternetGatewayAttachment'
+ - xml:
+ name: item
+ EgressOnlyInternetGatewayIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
+ - xml:
+ name: item
+ ElasticGpuAssociation:
+ type: object
+ properties:
+ elasticGpuId:
+ allOf:
+ - $ref: '#/components/schemas/ElasticGpuId'
+ - description: The ID of the Elastic Graphics accelerator.
+ elasticGpuAssociationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the association.
+ elasticGpuAssociationState:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The state of the association between the instance and the Elastic Graphics accelerator.
+ elasticGpuAssociationTime:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The time the Elastic Graphics accelerator was associated with the instance.
+ description: Describes the association between an instance and an Elastic Graphics accelerator.
+ ElasticGpuAssociationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ElasticGpuAssociation'
+ - xml:
+ name: item
+ ElasticGpuStatus:
+ type: string
+ enum:
+ - OK
+ - IMPAIRED
+ ElasticGpuHealth:
+ type: object
+ properties:
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ElasticGpuStatus'
+ - description: The health status.
+ description: Describes the status of an Elastic Graphics accelerator.
+ ElasticGpuIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ElasticGpuId'
+ - xml:
+ name: item
+ ElasticGpus:
+ type: object
+ properties:
+ elasticGpuId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Elastic Graphics accelerator.
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone in the which the Elastic Graphics accelerator resides.
+ elasticGpuType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The type of Elastic Graphics accelerator.
+ elasticGpuHealth:
+ allOf:
+ - $ref: '#/components/schemas/ElasticGpuHealth'
+ - description: The status of the Elastic Graphics accelerator.
+ elasticGpuState:
+ allOf:
+ - $ref: '#/components/schemas/ElasticGpuState'
+ - description: The state of the Elastic Graphics accelerator.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance to which the Elastic Graphics accelerator is attached.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the Elastic Graphics accelerator.
+ description: Describes an Elastic Graphics accelerator.
+ ElasticGpuSpecificationResponse:
+ type: object
+ properties:
+ type:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The elastic GPU type.
+ description: Describes an elastic GPU.
+ ElasticGpuSpecificationResponseList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ElasticGpuSpecificationResponse'
+ - xml:
+ name: item
+ ElasticGpuSpecifications:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ElasticGpuSpecification'
+ - xml:
+ name: item
+ ElasticGpuState:
+ type: string
+ enum:
+ - ATTACHED
+ ElasticInferenceAcceleratorCount:
+ type: integer
+ minimum: 1
+ ElasticInferenceAcceleratorAssociation:
+ type: object
+ properties:
+ elasticInferenceAcceleratorArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: ' The Amazon Resource Name (ARN) of the elastic inference accelerator. '
+ elasticInferenceAcceleratorAssociationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: ' The ID of the association. '
+ elasticInferenceAcceleratorAssociationState:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: ' The state of the elastic inference accelerator. '
+ elasticInferenceAcceleratorAssociationTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: ' The time at which the elastic inference accelerator is associated with an instance. '
+ description: ' Describes the association between an instance and an elastic inference accelerator. '
+ ElasticInferenceAcceleratorAssociationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ElasticInferenceAcceleratorAssociation'
+ - xml:
+ name: item
+ ElasticInferenceAccelerators:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ElasticInferenceAccelerator'
+ - xml:
+ name: item
+ ElasticIpAssociationId:
+ type: string
+ EnaSupport:
+ type: string
+ enum:
+ - unsupported
+ - supported
+ - required
+ EnableEbsEncryptionByDefaultRequest:
+ type: object
+ title: EnableEbsEncryptionByDefaultRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ EnableFastLaunchRequest:
+ type: object
+ required:
+ - ImageId
+ title: EnableFastLaunchRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ EnableFastSnapshotRestoreStateErrorSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/EnableFastSnapshotRestoreStateErrorItem'
+ - xml:
+ name: item
+ EnableFastSnapshotRestoreErrorItem:
+ type: object
+ properties:
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the snapshot.
+ fastSnapshotRestoreStateErrorSet:
+ allOf:
+ - $ref: '#/components/schemas/EnableFastSnapshotRestoreStateErrorSet'
+ - description: The errors.
+ description: Contains information about the errors that occurred when enabling fast snapshot restores.
+ EnableFastSnapshotRestoreErrorSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/EnableFastSnapshotRestoreErrorItem'
+ - xml:
+ name: item
+ EnableFastSnapshotRestoreStateError:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The error code.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The error message.
+ description: Describes an error that occurred when enabling fast snapshot restores.
+ EnableFastSnapshotRestoreStateErrorItem:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone.
+ error:
+ allOf:
+ - $ref: '#/components/schemas/EnableFastSnapshotRestoreStateError'
+ - description: The error.
+ description: Contains information about an error that occurred when enabling fast snapshot restores.
+ EnableFastSnapshotRestoreSuccessItem:
+ type: object
+ properties:
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the snapshot.
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/FastSnapshotRestoreStateCode'
+ - description: The state of fast snapshot restores.
+ stateTransitionReason:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
enabling state.
+ optimizingTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time at which fast snapshot restores entered the optimizing state.
+ enabledTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time at which fast snapshot restores entered the enabled state.
+ disablingTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time at which fast snapshot restores entered the disabling state.
+ disabledTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time at which fast snapshot restores entered the disabled state.
+ description: Describes fast snapshot restores that were successfully enabled.
+ EnableFastSnapshotRestoreSuccessSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/EnableFastSnapshotRestoreSuccessItem'
+ - xml:
+ name: item
+ EnableFastSnapshotRestoresRequest:
+ type: object
+ required:
+ - AvailabilityZones
+ - SourceSnapshotIds
+ title: EnableFastSnapshotRestoresRequest
+ properties:
+ AvailabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/AvailabilityZoneStringList'
+ - description: 'One or more Availability Zones. For example, us-east-2a.'
+ SourceSnapshotId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ EnableImageDeprecationRequest:
+ type: object
+ required:
+ - ImageId
+ - DeprecateAt
+ title: EnableImageDeprecationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ EnableIpamOrganizationAdminAccountRequest:
+ type: object
+ required:
+ - DelegatedAdminAccountId
+ title: EnableIpamOrganizationAdminAccountRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Organizations member account ID that you want to enable as the IPAM account.
+ EnableSerialConsoleAccessRequest:
+ type: object
+ title: EnableSerialConsoleAccessRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ EnableTransitGatewayRouteTablePropagationRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ - TransitGatewayAttachmentId
+ title: EnableTransitGatewayRouteTablePropagationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ EnableVgwRoutePropagationRequest:
+ type: object
+ required:
+ - GatewayId
+ - RouteTableId
+ title: EnableVgwRoutePropagationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for EnableVgwRoutePropagation.
+ EnableVolumeIORequest:
+ type: object
+ required:
+ - VolumeId
+ title: EnableVolumeIORequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ volumeId:
+ allOf:
+ - $ref: '#/components/schemas/VolumeId'
+ - description: The ID of the volume.
+ EnableVpcClassicLinkDnsSupportRequest:
+ type: object
+ title: EnableVpcClassicLinkDnsSupportRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ EnableVpcClassicLinkRequest:
+ type: object
+ required:
+ - VpcId
+ title: EnableVpcClassicLinkRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/VpcId'
+ - description: The ID of the VPC.
+ EnclaveOptions:
+ type: object
+ properties:
+ enabled:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.'
+ description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
+ EnclaveOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.'
+ description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.'
+ EncryptionInTransitSupported:
+ type: boolean
+ EphemeralNvmeSupport:
+ type: string
+ enum:
+ - unsupported
+ - supported
+ - required
+ ValidationError:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes.'
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error Codes.'
+ description: The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.
+ ErrorSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ValidationError'
+ - xml:
+ name: item
+ EventCode:
+ type: string
+ enum:
+ - instance-reboot
+ - system-reboot
+ - system-maintenance
+ - instance-retirement
+ - instance-stop
+ EventInformation:
+ type: object
+ properties:
+ eventDescription:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the event.
+ eventSubType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The event.
error events:
iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.
allLaunchSpecsTemporarilyBlacklisted - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.
spotInstanceCountLimitExceeded - You''ve reached the limit on the number of Spot Instances that you can launch.
spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.
fleetRequestChange events:
active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.
cancelled - The EC2 Fleet or Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.
cancelled_running - The EC2 Fleet or Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.
cancelled_terminating - The EC2 Fleet or Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.
expired - The EC2 Fleet or Spot Fleet request has expired. If the request was created with TerminateInstancesWithExpiration set, a subsequent terminated event indicates that the instances are terminated.
modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.
modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.
submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.
progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.
instanceChange events:
launched - A new instance was launched.
terminated - An instance was terminated by the user.
termination_notified - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.
Information events:
fleetProgressHalted - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced launchSpecUnusable events). A launch specification might become valid if the Spot price changes.
launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.
launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot price.
registerWithLoadBalancersFailed - An attempt to register instances with load balancers failed. For more information, see the description of the event.
instanceChange events.
+ description: Describes an EC2 Fleet or Spot Fleet event.
+ ExcludedInstanceType:
+ type: string
+ pattern: '[a-zA-Z0-9\.\*]+'
+ minLength: 1
+ maxLength: 30
+ StringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ TransitGatewayRouteTableRoute:
+ type: object
+ properties:
+ destinationCidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The CIDR block used for destination matches.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The state of the route.
+ routeOrigin:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The route origin. The following are the possible values:
static
propagated
The direction. The following are the possible values:
egress
ingress
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ExportClientVpnClientConfigurationRequest:
+ type: object
+ required:
+ - ClientVpnEndpointId
+ title: ExportClientVpnClientConfigurationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ExportImageRequest:
+ type: object
+ required:
+ - DiskImageFormat
+ - ImageId
+ - S3ExportLocation
+ title: ExportImageRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named ''vmimport''.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to apply to the export image task during creation.
+ ExportTaskS3Location:
+ type: object
+ properties:
+ s3Bucket:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The destination Amazon S3 bucket.
+ s3Prefix:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The prefix (logical hierarchy) in the bucket.
+ description: Describes the destination for an export image task.
+ ExportImageTask:
+ type: object
+ properties:
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the image being exported.
+ exportImageTaskId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the export image task.
+ imageId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the image.
+ progress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The percent complete of the export image task.
+ s3ExportLocation:
+ allOf:
+ - $ref: '#/components/schemas/ExportTaskS3Location'
+ - description: Information about the destination Amazon S3 bucket.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The status of the export image task. The possible values are active, completed, deleting, and deleted.'
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The status message for the export image task.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the export image task.
+ description: Describes an export image task.
+ ExportImageTaskIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ExportImageTaskId'
+ - xml:
+ name: ExportImageTaskId
+ ExportToS3Task:
+ type: object
+ properties:
+ containerFormat:
+ allOf:
+ - $ref: '#/components/schemas/ContainerFormat'
+ - description: 'The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.'
+ diskImageFormat:
+ allOf:
+ - $ref: '#/components/schemas/DiskImageFormat'
+ - description: The format for the exported image.
+ s3Bucket:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.
+ s3Key:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The encryption key for your S3 bucket.
+ description: Describes the format and location for the export task.
+ InstanceExportDetails:
+ type: object
+ properties:
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource being exported.
+ targetEnvironment:
+ allOf:
+ - $ref: '#/components/schemas/ExportEnvironment'
+ - description: The target virtualization environment.
+ description: Describes an instance to export.
+ ExportTaskState:
+ type: string
+ enum:
+ - active
+ - cancelling
+ - cancelled
+ - completed
+ ExportTaskS3LocationRequest:
+ type: object
+ required:
+ - S3Bucket
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The prefix (logical hierarchy) in the bucket.
+ description: Describes the destination for an export image task.
+ ExportTransitGatewayRoutesRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ - S3Bucket
+ title: ExportTransitGatewayRoutesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableId'
+ - description: The ID of the route table.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ FailedCapacityReservationFleetCancellationResult:
+ type: object
+ properties:
+ capacityReservationFleetId:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationFleetId'
+ - description: The ID of the Capacity Reservation Fleet that could not be cancelled.
+ cancelCapacityReservationFleetError:
+ allOf:
+ - $ref: '#/components/schemas/CancelCapacityReservationFleetError'
+ - description: Information about the Capacity Reservation Fleet cancellation error.
+ description: Describes a Capacity Reservation Fleet that could not be cancelled.
+ FailedQueuedPurchaseDeletion:
+ type: object
+ properties:
+ error:
+ allOf:
+ - $ref: '#/components/schemas/DeleteQueuedReservedInstancesError'
+ - description: The error.
+ reservedInstancesId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Reserved Instance.
+ description: Describes a Reserved Instance whose queued purchase was not deleted.
+ FastLaunchLaunchTemplateSpecificationRequest:
+ type: object
+ required:
+ - Version
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The version of the launch template to use for faster launching for a Windows AMI.
+ description: 'Request to create a launch template for a fast-launch enabled Windows AMI.
Note - You can specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
DefaultTargetCapacityType.'
+ onDemandTargetCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.'
+ spotTargetCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.'
+ defaultTargetCapacityType:
+ allOf:
+ - $ref: '#/components/schemas/DefaultTargetCapacityType'
+ - description: 'The default TotalTargetCapacity, which is either Spot or On-Demand.'
+ targetCapacityUnitType:
+ allOf:
+ - $ref: '#/components/schemas/TargetCapacityUnitType'
+ - description: 'The unit for the target capacity.
Default: units (translates to number of instances)
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptions and SpotOptions.
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.
lowest-price - EC2 Fleet launches instances from the Spot Instance pools with the lowest price.
diversified - EC2 Fleet launches instances from all of the Spot Instance pools that you specify.
capacity-optimized (recommended) - EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
Default: lowest-price
The behavior when a Spot Instance is interrupted.
Default: terminate
The number of Spot pools across which to allocate your target Spot capacity. Supported only when AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
' + singleInstanceType: + allOf: + - $ref: '#/components/schemas/Boolean' + - description:Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant.
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.
lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.
prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.
Default: lowest-price
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
Supported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
Supported only for fleets of type instant.
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.'
+ createTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The creation date and time of the EC2 Fleet.
+ fleetId:
+ allOf:
+ - $ref: '#/components/schemas/FleetId'
+ - description: The ID of the EC2 Fleet.
+ fleetState:
+ allOf:
+ - $ref: '#/components/schemas/FleetStateCode'
+ - description: The state of the EC2 Fleet.
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraints: Maximum 64 ASCII characters
' + excessCapacityTerminationPolicy: + allOf: + - $ref: '#/components/schemas/FleetExcessCapacityTerminationPolicy' + - description: Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. + fulfilledCapacity: + allOf: + - $ref: '#/components/schemas/Double' + - description: The number of units fulfilled by this request compared to the set target capacity. + fulfilledOnDemandCapacity: + allOf: + - $ref: '#/components/schemas/Double' + - description: The number of units fulfilled by this request compared to the set target On-Demand capacity. + launchTemplateConfigs: + allOf: + - $ref: '#/components/schemas/FleetLaunchTemplateConfigList' + - description: The launch template and overrides. + targetCapacitySpecification: + allOf: + - $ref: '#/components/schemas/TargetCapacitySpecification' + - description: 'The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type ismaintain, you can specify a target capacity of 0 and add capacity later.'
+ terminateInstancesWithExpiration:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether running instances should be terminated when the EC2 Fleet expires. '
+ type:
+ allOf:
+ - $ref: '#/components/schemas/FleetType'
+ - description: 'The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.'
+ validFrom:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately. '
+ validUntil:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date. '
+ replaceUnhealthyInstances:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.'
+ spotOptions:
+ allOf:
+ - $ref: '#/components/schemas/SpotOptions'
+ - description: The configuration of Spot Instances in an EC2 Fleet.
+ onDemandOptions:
+ allOf:
+ - $ref: '#/components/schemas/OnDemandOptions'
+ - description: The allocation strategy of On-Demand Instances in an EC2 Fleet.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for an EC2 Fleet resource.
+ errorSet:
+ allOf:
+ - $ref: '#/components/schemas/DescribeFleetsErrorSet'
+ - description: Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.
+ fleetInstanceSet:
+ allOf:
+ - $ref: '#/components/schemas/DescribeFleetsInstancesSet'
+ - description: Information about the instances that were launched by the fleet. Valid only when Type is set to instant.
+ context:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Reserved.
+ description: Describes an EC2 Fleet.
+ FleetEventType:
+ type: string
+ enum:
+ - instance-change
+ - fleet-change
+ - service-error
+ FleetLaunchTemplateSpecification:
+ type: object
+ properties:
+ launchTemplateId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ID of the launch template. If you specify the template ID, you can''t specify the template name.'
+ launchTemplateName:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateName'
+ - description: 'The name of the launch template. If you specify the template name, you can''t specify the template ID.'
+ version:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
The CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don''t confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
' + memoryGiBPerVCpu: + allOf: + - $ref: '#/components/schemas/MemoryGiBPerVCpu' + - description: 'The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
' + excludedInstanceTypeSet: + allOf: + - $ref: '#/components/schemas/ExcludedInstanceTypeSet' + - description: 'The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
Default: No excluded instance types
' + instanceGenerationSet: + allOf: + - $ref: '#/components/schemas/InstanceGenerationSet' + - description: 'Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.
For current generation instance types, specify current.
For previous generation instance types, specify previous.
Default: Current and previous generation instance types
' + spotMaxPricePercentageOverLowestPrice: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 100
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20
Indicates whether bare metal instance types must be included, excluded, or required.
To include bare metal instance types, specify included.
To require only bare metal instance types, specify required.
To exclude bare metal instance types, specify excluded.
Default: excluded
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
To include burstable performance instance types, specify included.
To require only burstable performance instance types, specify required.
To exclude burstable performance instance types, specify excluded.
Default: excluded
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default: false
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
' + localStorage: + allOf: + - $ref: '#/components/schemas/LocalStorage' + - description: 'Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
To include instance types with instance store volumes, specify included.
To require only instance types with instance store volumes, specify required.
To exclude instance types with instance store volumes, specify excluded.
Default: included
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SDD) storage, specify sdd.
Default: hdd and sdd
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
' + baselineEbsBandwidthMbps: + allOf: + - $ref: '#/components/schemas/BaselineEbsBandwidthMbps' + - description: 'The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
' + acceleratorTypeSet: + allOf: + - $ref: '#/components/schemas/AcceleratorTypeSet' + - description: 'The accelerator types that must be on the instance type.
For instance types with GPU accelerators, specify gpu.
For instance types with FPGA accelerators, specify fpga.
For instance types with inference accelerators, specify inference.
Default: Any accelerator type
' + acceleratorCount: + allOf: + - $ref: '#/components/schemas/AcceleratorCount' + - description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
' + acceleratorManufacturerSet: + allOf: + - $ref: '#/components/schemas/AcceleratorManufacturerSet' + - description: 'Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
' + acceleratorNameSet: + allOf: + - $ref: '#/components/schemas/AcceleratorNameSet' + - description: 'The accelerators that must be on the instance type.
For instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
Default: Any accelerator
' + acceleratorTotalMemoryMiB: + allOf: + - $ref: '#/components/schemas/AcceleratorTotalMemoryMiB' + - description: 'The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
' + description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
You must specify VCpuCount and MemoryMiB. All other parameters are optional. Any unspecified optional parameter is set to its default.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
' + FleetLaunchTemplateOverrides: + type: object + properties: + instanceType: + allOf: + - $ref: '#/components/schemas/InstanceType' + - description: 'The instance type.
If you specify InstanceTypes, you can''t specify InstanceRequirements.
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can''t specify InstanceTypes.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can''t specify InstanceTypes.
The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
The replacement strategy to use. Only available for fleets of type maintain.
launch - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay), terminates the instances that received a rebalance notification.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you''ve reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.'
+ deliverLogsPermissionArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ARN of the IAM role that posts logs to CloudWatch Logs.
+ deliverLogsStatus:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The status of the logs delivery (SUCCESS | FAILED).
+ flowLogId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The flow log ID.
+ flowLogStatus:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The status of the flow log (ACTIVE).
+ logGroupName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the flow log group.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource on which the flow log was created.
+ trafficType:
+ allOf:
+ - $ref: '#/components/schemas/TrafficType'
+ - description: The type of traffic captured for the flow log.
+ logDestinationType:
+ allOf:
+ - $ref: '#/components/schemas/LogDestinationType'
+ - description: The type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3.
+ logDestination:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published.'
+ logFormat:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The format of the flow log record.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for the flow log.
+ maxAggregationInterval:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.
Valid Values: 60 | 600
The state. The following are the possible values:
pending - AFI bitstream generation is in progress.
available - The AFI is available for use.
failed - AFI bitstream generation failed.
unavailable - The AFI is no longer available for use.
failed, this is the error message.'
+ description: Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).
+ FpgaImage:
+ type: object
+ properties:
+ fpgaImageId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The FPGA image identifier (AFI ID).
+ fpgaImageGlobalId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The global FPGA image identifier (AGFI ID).
+ name:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the AFI.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the AFI.
+ shellVersion:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The version of the Amazon Web Services Shell that was used to create the bitstream.
+ pciId:
+ allOf:
+ - $ref: '#/components/schemas/PciId'
+ - description: Information about the PCI bus.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/FpgaImageState'
+ - description: Information about the state of the AFI.
+ createTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The date and time the AFI was created.
+ updateTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time of the most recent update to the AFI.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the AFI.
+ ownerAlias:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.'
+ productCodes:
+ allOf:
+ - $ref: '#/components/schemas/ProductCodeList'
+ - description: The product codes for the AFI.
+ tags:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the AFI.
+ public:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the AFI is public.
+ dataRetentionSupport:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether data retention support is enabled for the AFI.
+ description: Describes an Amazon FPGA image (AFI).
+ LoadPermissionList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LoadPermission'
+ - xml:
+ name: item
+ FpgaImageStateCode:
+ type: string
+ enum:
+ - pending
+ - failed
+ - available
+ - unavailable
+ totalFpgaMemory:
+ type: integer
+ FpgaInfo:
+ type: object
+ properties:
+ fpgas:
+ allOf:
+ - $ref: '#/components/schemas/FpgaDeviceInfoList'
+ - description: Describes the FPGAs for the instance type.
+ totalFpgaMemoryInMiB:
+ allOf:
+ - $ref: '#/components/schemas/totalFpgaMemory'
+ - description: The total memory of all FPGA accelerators for the instance type.
+ description: Describes the FPGAs for the instance type.
+ FreeTierEligibleFlag:
+ type: boolean
+ GVCDMaxResults:
+ type: integer
+ minimum: 200
+ maximum: 1000
+ GatewayAssociationState:
+ type: string
+ enum:
+ - associated
+ - not-associated
+ - associating
+ - disassociating
+ GetAssociatedEnclaveCertificateIamRolesRequest:
+ type: object
+ title: GetAssociatedEnclaveCertificateIamRolesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ GetAssociatedIpv6PoolCidrsRequest:
+ type: object
+ required:
+ - PoolId
+ title: GetAssociatedIpv6PoolCidrsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Ipv6CidrAssociationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6CidrAssociation'
+ - xml:
+ name: item
+ GetCapacityReservationUsageRequest:
+ type: object
+ required:
+ - CapacityReservationId
+ title: GetCapacityReservationUsageRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ GetCapacityReservationUsageRequestMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ InstanceUsageSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceUsage'
+ - xml:
+ name: item
+ GetCoipPoolUsageRequest:
+ type: object
+ required:
+ - PoolId
+ title: GetCoipPoolUsageRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PoolCoipId'
+ - description: The ID of the address pool.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ GetConsoleOutputRequest:
+ type: object
+ required:
+ - InstanceId
+ title: GetConsoleOutputRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of the instance.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'When enabled, retrieves the latest console output for the instance.
Default: disabled (false)
true, acts as keystroke input and wakes up an instance that''s in standby or "sleep" mode.'
+ UnlimitedSupportedInstanceFamily:
+ type: string
+ enum:
+ - t2
+ - t3
+ - t3a
+ - t4g
+ GetDefaultCreditSpecificationRequest:
+ type: object
+ required:
+ - InstanceFamily
+ title: GetDefaultCreditSpecificationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/UnlimitedSupportedInstanceFamily'
+ - description: The instance family.
+ InstanceFamilyCreditSpecification:
+ type: object
+ properties:
+ instanceFamily:
+ allOf:
+ - $ref: '#/components/schemas/UnlimitedSupportedInstanceFamily'
+ - description: The instance family.
+ cpuCredits:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The default credit option for CPU usage of the instance family. Valid values are standard and unlimited.
+ description: Describes the default credit option for CPU usage of a burstable performance instance family.
+ GetEbsDefaultKmsKeyIdRequest:
+ type: object
+ title: GetEbsDefaultKmsKeyIdRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ GetEbsEncryptionByDefaultRequest:
+ type: object
+ title: GetEbsEncryptionByDefaultRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ IntegrateServices:
+ type: object
+ properties:
+ AthenaIntegration:
+ allOf:
+ - $ref: '#/components/schemas/AthenaIntegrationsSet'
+ - description: Information about the integration with Amazon Athena.
+ description: Describes service integrations with VPC Flow logs.
+ GetFlowLogsIntegrationTemplateRequest:
+ type: object
+ required:
+ - FlowLogId
+ - ConfigDeliveryS3DestinationArn
+ - IntegrateServices
+ title: GetFlowLogsIntegrationTemplateRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.'
+ IntegrateService:
+ allOf:
+ - $ref: '#/components/schemas/IntegrateServices'
+ - description: Information about the service integration.
+ GetGroupsForCapacityReservationRequest:
+ type: object
+ required:
+ - CapacityReservationId
+ title: GetGroupsForCapacityReservationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ GetGroupsForCapacityReservationRequestMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ GetHostReservationPurchasePreviewRequest:
+ type: object
+ required:
+ - HostIdSet
+ - OfferingId
+ title: GetHostReservationPurchasePreviewRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/OfferingId'
+ - description: The offering ID of the reservation.
+ PurchaseSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Purchase'
+ - xml:
+ name: item
+ GetInstanceTypesFromInstanceRequirementsRequest:
+ type: object
+ required:
+ - ArchitectureTypes
+ - VirtualizationTypes
+ - InstanceRequirements
+ title: GetInstanceTypesFromInstanceRequirementsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ArchitectureType:
+ allOf:
+ - $ref: '#/components/schemas/ArchitectureTypeSet'
+ - description: The processor architecture type.
+ VirtualizationType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next set of results.
+ InstanceTypeInfoFromInstanceRequirementsSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTypeInfoFromInstanceRequirements'
+ - xml:
+ name: item
+ GetInstanceUefiDataRequest:
+ type: object
+ required:
+ - InstanceId
+ title: GetInstanceUefiDataRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ GetIpamAddressHistoryRequest:
+ type: object
+ required:
+ - Cidr
+ - IpamScopeId
+ title: GetIpamAddressHistoryRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ IpamAddressHistoryRecordSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpamAddressHistoryRecord'
+ - xml:
+ name: item
+ GetIpamPoolAllocationsMaxResults:
+ type: integer
+ minimum: 1000
+ maximum: 100000
+ IpamPoolAllocationId:
+ type: string
+ GetIpamPoolAllocationsRequest:
+ type: object
+ required:
+ - IpamPoolId
+ title: GetIpamPoolAllocationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolAllocationId'
+ - description: The ID of the allocation.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ IpamPoolAllocationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolAllocation'
+ - xml:
+ name: item
+ GetIpamPoolCidrsRequest:
+ type: object
+ required:
+ - IpamPoolId
+ title: GetIpamPoolCidrsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolId'
+ - description: The ID of the IPAM pool you want the CIDR for.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/NextToken'
+ - description: The token for the next page of results.
+ IpamPoolCidrSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolCidr'
+ - xml:
+ name: item
+ GetIpamResourceCidrsRequest:
+ type: object
+ required:
+ - IpamScopeId
+ title: GetIpamResourceCidrsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the resource.
+ IpamResourceCidrSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpamResourceCidr'
+ - xml:
+ name: item
+ GetLaunchTemplateDataRequest:
+ type: object
+ required:
+ - InstanceId
+ title: GetLaunchTemplateDataRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of the instance.
+ ResponseLaunchTemplateData:
+ type: object
+ properties:
+ kernelId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ID of the kernel, if applicable.'
+ ebsOptimized:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether the instance is optimized for Amazon EBS I/O. '
+ iamInstanceProfile:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecification'
+ - description: The IAM instance profile.
+ blockDeviceMappingSet:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingList'
+ - description: The block device mappings.
+ networkInterfaceSet:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecificationList'
+ - description: The network interfaces.
+ imageId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the AMI that was used to launch the instance.
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/InstanceType'
+ - description: The instance type.
+ keyName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the key pair.
+ monitoring:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplatesMonitoring'
+ - description: The monitoring for the instance.
+ placement:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplatePlacement'
+ - description: The placement of the instance.
+ ramDiskId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ID of the RAM disk, if applicable.'
+ disableApiTermination:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.'
+ instanceInitiatedShutdownBehavior:
+ allOf:
+ - $ref: '#/components/schemas/ShutdownBehavior'
+ - description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
+ userData:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The user data for the instance. '
+ tagSpecificationSet:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateTagSpecificationList'
+ - description: The tags.
+ elasticGpuSpecificationSet:
+ allOf:
+ - $ref: '#/components/schemas/ElasticGpuSpecificationResponseList'
+ - description: The elastic GPU specification.
+ elasticInferenceAcceleratorSet:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorResponseList'
+ - description: ' The elastic inference accelerator for the instance. '
+ securityGroupIdSet:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The security group IDs.
+ securityGroupSet:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The security group names.
+ instanceMarketOptions:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateInstanceMarketOptions'
+ - description: The market (purchasing) option for the instances.
+ creditSpecification:
+ allOf:
+ - $ref: '#/components/schemas/CreditSpecification'
+ - description: The credit option for CPU usage of the instance.
+ cpuOptions:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateCpuOptions'
+ - description: 'The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide.'
+ capacityReservationSpecification:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationResponse'
+ - description: Information about the Capacity Reservation targeting option.
+ licenseSet:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateLicenseList'
+ - description: The license configurations.
+ hibernationOptions:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateHibernationOptions'
+ - description: 'Indicates whether an instance is configured for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.'
+ metadataOptions:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataOptions'
+ - description: 'The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.'
+ enclaveOptions:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateEnclaveOptions'
+ - description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
+ instanceRequirements:
+ allOf:
+ - $ref: '#/components/schemas/InstanceRequirements'
+ - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
If you specify InstanceRequirements, you can''t specify InstanceTypes.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ GetNetworkInsightsAccessScopeContentRequest:
+ type: object
+ required:
+ - NetworkInsightsAccessScopeId
+ title: GetNetworkInsightsAccessScopeContentRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ GetPasswordDataRequest:
+ type: object
+ required:
+ - InstanceId
+ title: GetPasswordDataRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of the Windows instance.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ GetReservedInstancesExchangeQuoteRequest:
+ type: object
+ required:
+ - ReservedInstanceIds
+ title: GetReservedInstancesExchangeQuoteRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ReservedInstanceId:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstanceIdSet'
+ - description: The IDs of the Convertible Reserved Instances to exchange.
+ TargetConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/TargetConfigurationRequestSet'
+ - description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
+ description: Contains the parameters for GetReservedInstanceExchangeQuote.
+ ReservationValue:
+ type: object
+ properties:
+ hourlyPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The hourly rate of the reservation.
+ remainingTotalValue:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
+ remainingUpfrontValue:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The remaining upfront cost of the reservation.
+ description: The cost associated with the Reserved Instance.
+ ReservedInstanceReservationValueSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstanceReservationValue'
+ - xml:
+ name: item
+ TargetReservationValueSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TargetReservationValue'
+ - xml:
+ name: item
+ GetSerialConsoleAccessStatusRequest:
+ type: object
+ title: GetSerialConsoleAccessStatusRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ GetSpotPlacementScoresRequest:
+ type: object
+ required:
+ - TargetCapacity
+ title: GetSpotPlacementScoresRequest
+ properties:
+ InstanceType:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Specify true so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions.
A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone.
' + RegionName: + allOf: + - $ref: '#/components/schemas/String' + - description: The token for the next set of results. + SpotPlacementScores: + type: array + items: + allOf: + - $ref: '#/components/schemas/SpotPlacementScore' + - xml: + name: item + GetSubnetCidrReservationsMaxResults: + type: integer + minimum: 5 + maximum: 1000 + GetSubnetCidrReservationsRequest: + type: object + required: + - SubnetId + title: GetSubnetCidrReservationsRequest + properties: + Filter: + allOf: + - $ref: '#/components/schemas/GetSubnetCidrReservationsMaxResults' + - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
+ SubnetCidrReservationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SubnetCidrReservation'
+ - xml:
+ name: item
+ GetTransitGatewayAttachmentPropagationsRequest:
+ type: object
+ required:
+ - TransitGatewayAttachmentId
+ title: GetTransitGatewayAttachmentPropagationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentId'
+ - description: The ID of the attachment.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayAttachmentPropagationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentPropagation'
+ - xml:
+ name: item
+ GetTransitGatewayMulticastDomainAssociationsRequest:
+ type: object
+ title: GetTransitGatewayMulticastDomainAssociationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
+ - description: The ID of the transit gateway multicast domain.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayMulticastDomainAssociationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociation'
+ - xml:
+ name: item
+ GetTransitGatewayPrefixListReferencesRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ title: GetTransitGatewayPrefixListReferencesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableId'
+ - description: The ID of the transit gateway route table.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayPrefixListReferenceSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPrefixListReference'
+ - xml:
+ name: item
+ GetTransitGatewayRouteTableAssociationsRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ title: GetTransitGatewayRouteTableAssociationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableId'
+ - description: The ID of the transit gateway route table.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayRouteTableAssociationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableAssociation'
+ - xml:
+ name: item
+ GetTransitGatewayRouteTablePropagationsRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ title: GetTransitGatewayRouteTablePropagationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableId'
+ - description: The ID of the transit gateway route table.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayRouteTablePropagationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTablePropagation'
+ - xml:
+ name: item
+ GetVpnConnectionDeviceSampleConfigurationRequest:
+ type: object
+ required:
+ - VpnConnectionId
+ - VpnConnectionDeviceTypeId
+ title: GetVpnConnectionDeviceSampleConfigurationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ VpnConnectionDeviceSampleConfiguration:
+ type: string
+ format: password
+ GetVpnConnectionDeviceTypesRequest:
+ type: object
+ title: GetVpnConnectionDeviceTypesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ VpnConnectionDeviceTypeList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpnConnectionDeviceType'
+ - xml:
+ name: item
+ GpuDeviceCount:
+ type: integer
+ GpuDeviceName:
+ type: string
+ GpuDeviceManufacturerName:
+ type: string
+ GpuDeviceMemoryInfo:
+ type: object
+ properties:
+ sizeInMiB:
+ allOf:
+ - $ref: '#/components/schemas/GpuDeviceMemorySize'
+ - description: 'The size of the memory available to the GPU accelerator, in MiB.'
+ description: Describes the memory available to the GPU accelerator.
+ GpuDeviceInfo:
+ type: object
+ properties:
+ name:
+ allOf:
+ - $ref: '#/components/schemas/GpuDeviceName'
+ - description: The name of the GPU accelerator.
+ manufacturer:
+ allOf:
+ - $ref: '#/components/schemas/GpuDeviceManufacturerName'
+ - description: The manufacturer of the GPU accelerator.
+ count:
+ allOf:
+ - $ref: '#/components/schemas/GpuDeviceCount'
+ - description: The number of GPUs for the instance type.
+ memoryInfo:
+ allOf:
+ - $ref: '#/components/schemas/GpuDeviceMemoryInfo'
+ - description: Describes the memory available to the GPU accelerator.
+ description: Describes the GPU accelerators for the instance type.
+ GpuDeviceInfoList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/GpuDeviceInfo'
+ - xml:
+ name: item
+ GpuDeviceMemorySize:
+ type: integer
+ totalGpuMemory:
+ type: integer
+ GpuInfo:
+ type: object
+ properties:
+ gpus:
+ allOf:
+ - $ref: '#/components/schemas/GpuDeviceInfoList'
+ - description: Describes the GPU accelerators for the instance type.
+ totalGpuMemoryInMiB:
+ allOf:
+ - $ref: '#/components/schemas/totalGpuMemory'
+ - description: 'The total size of the memory for the GPU accelerators for the instance type, in MiB.'
+ description: Describes the GPU accelerators for the instance type.
+ GroupIdentifier:
+ type: object
+ properties:
+ groupName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the security group.
+ groupId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the security group.
+ description: Describes a security group.
+ SecurityGroupIdentifier:
+ type: object
+ properties:
+ groupId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the security group.
+ groupName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the security group.
+ description: Describes a security group.
+ GroupIdentifierSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupIdentifier'
+ - xml:
+ name: item
+ HibernationFlag:
+ type: boolean
+ HibernationOptions:
+ type: object
+ properties:
+ configured:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If this parameter is set to true, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.'
+ description: 'Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.'
+ HibernationOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If you set this parameter to true, your instance is enabled for hibernation.
Default: false
The event type.
error - An error with the Spot Fleet request.
fleetRequestChange - A change in the status or configuration of the Spot Fleet request.
instanceChange - An instance was launched or terminated.
Information - An informational event.
m5.large. If the host supports multiple instance types, no instanceType is returned.'
+ instanceFamily:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The instance family supported by the Dedicated Host. For example, m5.'
+ sockets:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of sockets on the Dedicated Host.
+ totalVCpus:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The total number of vCPUs on the Dedicated Host.
+ description: Describes the properties of a Dedicated Host.
+ HostInstanceList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/HostInstance'
+ - xml:
+ name: item
+ HostRecovery:
+ type: string
+ enum:
+ - 'on'
+ - 'off'
+ Host:
+ type: object
+ properties:
+ autoPlacement:
+ allOf:
+ - $ref: '#/components/schemas/AutoPlacement'
+ - description: Whether auto-placement is on or off.
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone of the Dedicated Host.
+ availableCapacity:
+ allOf:
+ - $ref: '#/components/schemas/AvailableCapacity'
+ - description: Information about the instances running on the Dedicated Host.
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
+ hostId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Dedicated Host.
+ hostProperties:
+ allOf:
+ - $ref: '#/components/schemas/HostProperties'
+ - description: The hardware specifications of the Dedicated Host.
+ hostReservationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.
+ instances:
+ allOf:
+ - $ref: '#/components/schemas/HostInstanceList'
+ - description: The IDs and instance type that are currently running on the Dedicated Host.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/AllocationState'
+ - description: The Dedicated Host's state.
+ allocationTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time that the Dedicated Host was allocated.
+ releaseTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time that the Dedicated Host was released.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the Dedicated Host.
+ hostRecovery:
+ allOf:
+ - $ref: '#/components/schemas/HostRecovery'
+ - description: Indicates whether host recovery is enabled or disabled for the Dedicated Host.
+ allowsMultipleInstanceTypes:
+ allOf:
+ - $ref: '#/components/schemas/AllowsMultipleInstanceTypes'
+ - description: 'Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.'
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the Dedicated Host.
+ availabilityZoneId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Availability Zone in which the Dedicated Host is allocated.
+ memberOfServiceLinkedResourceGroup:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the host is in a host resource group; otherwise, it is not.'
+ outpostArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.
+ description: Describes the properties of the Dedicated Host.
+ HostInstance:
+ type: object
+ properties:
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of instance that is running on the Dedicated Host.
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The instance type (for example, m3.medium) of the running instance.'
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the instance.
+ description: Describes an instance running on a Dedicated Host.
+ PaymentOption:
+ type: string
+ enum:
+ - AllUpfront
+ - PartialUpfront
+ - NoUpfront
+ HostOffering:
+ type: object
+ properties:
+ currencyCode:
+ allOf:
+ - $ref: '#/components/schemas/CurrencyCodeValues'
+ - description: The currency of the offering.
+ duration:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The duration of the offering (in seconds).
+ hourlyPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The hourly price of the offering.
+ instanceFamily:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The instance family of the offering.
+ offeringId:
+ allOf:
+ - $ref: '#/components/schemas/OfferingId'
+ - description: The ID of the offering.
+ paymentOption:
+ allOf:
+ - $ref: '#/components/schemas/PaymentOption'
+ - description: The available payment option.
+ upfrontPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The upfront price of the offering. Does not apply to No Upfront offerings.
+ description: Details about the Dedicated Host Reservation offering.
+ ResponseHostIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ ReservationState:
+ type: string
+ enum:
+ - payment-pending
+ - payment-failed
+ - active
+ - retired
+ HostReservation:
+ type: object
+ properties:
+ count:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of Dedicated Hosts the reservation is associated with.
+ currencyCode:
+ allOf:
+ - $ref: '#/components/schemas/CurrencyCodeValues'
+ - description: 'The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.'
+ duration:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The length of the reservation''s term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).'
+ end:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The date and time that the reservation ends.
+ hostIdSet:
+ allOf:
+ - $ref: '#/components/schemas/ResponseHostIdSet'
+ - description: The IDs of the Dedicated Hosts associated with the reservation.
+ hostReservationId:
+ allOf:
+ - $ref: '#/components/schemas/HostReservationId'
+ - description: The ID of the reservation that specifies the associated Dedicated Hosts.
+ hourlyPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The hourly price of the reservation.
+ instanceFamily:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.
+ offeringId:
+ allOf:
+ - $ref: '#/components/schemas/OfferingId'
+ - description: The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
+ paymentOption:
+ allOf:
+ - $ref: '#/components/schemas/PaymentOption'
+ - description: The payment option selected for this reservation.
+ start:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The date and time that the reservation started.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/ReservationState'
+ - description: The state of the reservation.
+ upfrontPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The upfront price of the reservation.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the Dedicated Host Reservation.
+ description: Details about the Dedicated Host Reservation and associated Dedicated Hosts.
+ HostReservationIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/HostReservationId'
+ - xml:
+ name: item
+ HostTenancy:
+ type: string
+ enum:
+ - dedicated
+ - host
+ HostnameType:
+ type: string
+ enum:
+ - ip-name
+ - resource-name
+ Hour:
+ type: integer
+ minimum: 0
+ maximum: 23
+ HttpTokensState:
+ type: string
+ enum:
+ - optional
+ - required
+ HypervisorType:
+ type: string
+ enum:
+ - ovm
+ - xen
+ IKEVersionsListValue:
+ type: object
+ properties:
+ value:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IKE version.
+ description: The internet key exchange (IKE) version permitted for the VPN tunnel.
+ IKEVersionsList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IKEVersionsListValue'
+ - xml:
+ name: item
+ IKEVersionsRequestListValue:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IKE version.
+ description: The IKE version that is permitted for the VPN tunnel.
+ IKEVersionsRequestList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IKEVersionsRequestListValue'
+ - xml:
+ name: item
+ IamInstanceProfile:
+ type: object
+ properties:
+ arn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the instance profile.
+ id:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance profile.
+ description: Describes an IAM instance profile.
+ IamInstanceProfileAssociationState:
+ type: string
+ enum:
+ - associating
+ - associated
+ - disassociating
+ - disassociated
+ IdFormat:
+ type: object
+ properties:
+ deadline:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.'
+ resource:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The type of resource.
+ useLongIds:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether longer IDs (17-character IDs) are enabled for the resource.
+ description: Describes the ID format for a resource.
+ Igmpv2SupportValue:
+ type: string
+ enum:
+ - enable
+ - disable
+ ImageTypeValues:
+ type: string
+ enum:
+ - machine
+ - kernel
+ - ramdisk
+ ImageState:
+ type: string
+ enum:
+ - pending
+ - available
+ - invalid
+ - deregistered
+ - transient
+ - failed
+ - error
+ StateReason:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The reason code for the state change.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The message for the state change.
Server.InsufficientInstanceCapacity: There was insufficient capacity available to satisfy the launch request.
Server.InternalError: An internal error caused the instance to terminate during launch.
Server.ScheduledStop: The instance was stopped due to a scheduled retirement.
Server.SpotInstanceShutdown: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
Server.SpotInstanceTermination: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.
Client.InstanceTerminated: The instance was terminated or rebooted during AMI creation.
Client.InternalError: A client error caused the instance to terminate during launch.
Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
Client.UserInitiatedHibernate: Hibernation was initiated on the instance.
Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.
true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
+ kernelId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The kernel associated with the image, if any. Only applicable for machine images.'
+ imageOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the image.
+ platform:
+ allOf:
+ - $ref: '#/components/schemas/PlatformValues'
+ - description: 'This value is set to windows for Windows AMIs; otherwise, it is blank.'
+ platformDetails:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The platform details associated with the billing code of the AMI. For more information, see Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide.'
+ usageOperation:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.'
+ productCodes:
+ allOf:
+ - $ref: '#/components/schemas/ProductCodeList'
+ - description: Any product codes associated with the AMI.
+ ramdiskId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The RAM disk associated with the image, if any. Only applicable for machine images.'
+ imageState:
+ allOf:
+ - $ref: '#/components/schemas/ImageState'
+ - description: 'The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.'
+ blockDeviceMapping:
+ allOf:
+ - $ref: '#/components/schemas/BlockDeviceMappingList'
+ - description: Any block device mapping entries.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the AMI that was provided during image creation.
+ enaSupport:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Specifies whether enhanced networking with ENA is enabled.
+ hypervisor:
+ allOf:
+ - $ref: '#/components/schemas/HypervisorType'
+ - description: The hypervisor type of the image.
+ imageOwnerAlias:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Amazon Web Services account alias (for example, amazon, self) or the Amazon Web Services account ID of the AMI owner.'
+ name:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the AMI that was provided during image creation.
+ rootDeviceName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The device name of the root device volume (for example, /dev/sda1).'
+ rootDeviceType:
+ allOf:
+ - $ref: '#/components/schemas/DeviceType'
+ - description: The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
+ sriovNetSupport:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
+ stateReason:
+ allOf:
+ - $ref: '#/components/schemas/StateReason'
+ - description: The reason for the state change.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the image.
+ virtualizationType:
+ allOf:
+ - $ref: '#/components/schemas/VirtualizationType'
+ - description: The type of virtualization of the AMI.
+ bootMode:
+ allOf:
+ - $ref: '#/components/schemas/BootModeValues'
+ - description: 'The boot mode of the image. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.'
+ tpmSupport:
+ allOf:
+ - $ref: '#/components/schemas/TpmSupportValues'
+ - description: 'If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.'
+ deprecationTime:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.'
+ description: Describes an image.
+ ImageAttributeName:
+ type: string
+ enum:
+ - description
+ - kernel
+ - ramdisk
+ - launchPermission
+ - productCodes
+ - blockDeviceMapping
+ - sriovNetSupport
+ - bootMode
+ - tpmSupport
+ - uefiData
+ - lastLaunchedTime
+ ImageDiskContainerList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImageDiskContainer'
+ - xml:
+ name: item
+ ImageIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImageId'
+ - xml:
+ name: item
+ ImageRecycleBinInfo:
+ type: object
+ properties:
+ imageId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the AMI.
+ name:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the AMI.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the AMI.
+ recycleBinEnterTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The date and time when the AMI entered the Recycle Bin.
+ recycleBinExitTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The date and time when the AMI is to be permanently deleted from the Recycle Bin.
+ description: Information about an AMI that is currently in the Recycle Bin.
+ ImageRecycleBinInfoList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImageRecycleBinInfo'
+ - xml:
+ name: item
+ ImportClientVpnClientCertificateRevocationListRequest:
+ type: object
+ required:
+ - ClientVpnEndpointId
+ - CertificateRevocationList
+ title: ImportClientVpnClientCertificateRevocationListRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ImportImageLicenseConfigurationResponse:
+ type: object
+ properties:
+ licenseConfigurationArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ARN of a license configuration.
+ description: ' The response information for license configurations.'
+ ImportImageLicenseSpecificationListRequest:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImportImageLicenseConfigurationRequest'
+ - xml:
+ name: item
+ ImportImageLicenseSpecificationListResponse:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImportImageLicenseConfigurationResponse'
+ - xml:
+ name: item
+ ImportImageRequest:
+ type: object
+ title: ImportImageRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description string for the import image task.
+ DiskContainer:
+ allOf:
+ - $ref: '#/components/schemas/ImportImageLicenseSpecificationListRequest'
+ - description: The ARNs of the license configurations.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/BootModeValues'
+ - description: The boot mode of the virtual machine.
+ SnapshotDetailList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotDetail'
+ - xml:
+ name: item
+ ImportImageTask:
+ type: object
+ properties:
+ architecture:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The architecture of the virtual machine.
Valid values: i386 | x86_64 | arm64
The target hypervisor for the import task.
Valid values: xen
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ launchSpecification:
+ allOf:
+ - $ref: '#/components/schemas/ImportInstanceLaunchSpecification'
+ - description: The launch specification.
+ platform:
+ allOf:
+ - $ref: '#/components/schemas/PlatformValues'
+ - description: The instance operating system.
+ ImportInstanceVolumeDetailSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImportInstanceVolumeDetailItem'
+ - xml:
+ name: item
+ ImportInstanceVolumeDetailItem:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone where the resulting instance will reside.
+ bytesConverted:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: The number of bytes converted so far.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the task.
+ image:
+ allOf:
+ - $ref: '#/components/schemas/DiskImageDescription'
+ - description: The image.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The status of the import of this particular disk image.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The status information or errors related to the disk image.
+ volume:
+ allOf:
+ - $ref: '#/components/schemas/DiskImageVolumeDescription'
+ - description: The volume.
+ description: Describes an import volume task.
+ ImportKeyPairRequest:
+ type: object
+ required:
+ - KeyName
+ - PublicKeyMaterial
+ title: ImportKeyPairRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ keyName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A unique name for the key pair.
+ publicKeyMaterial:
+ allOf:
+ - $ref: '#/components/schemas/Blob'
+ - description: 'The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to apply to the imported key pair.
+ ImportSnapshotRequest:
+ type: object
+ title: ImportSnapshotRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The name of the role to use when not using the default role, ''vmimport''.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to apply to the import snapshot task during creation.
+ SnapshotTaskDetail:
+ type: object
+ properties:
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the snapshot.
+ diskImageSize:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: 'The size of the disk in the snapshot, in GiB.'
+ encrypted:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the snapshot is encrypted.
+ format:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The format of the disk image from which the snapshot is created.
+ kmsKeyId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The identifier for the KMS key that was used to create the encrypted snapshot.
+ progress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The percentage of completion for the import snapshot task.
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The snapshot ID of the disk being imported.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A brief status for the import snapshot task.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A detailed status message for the import snapshot task.
+ url:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The URL of the disk image from which the snapshot is created.
+ userBucket:
+ allOf:
+ - $ref: '#/components/schemas/UserBucketDetails'
+ - description: The Amazon S3 bucket for the disk image.
+ description: Details about the import snapshot task.
+ ImportSnapshotTask:
+ type: object
+ properties:
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the import snapshot task.
+ importTaskId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the import snapshot task.
+ snapshotTaskDetail:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotTaskDetail'
+ - description: Describes an import snapshot task.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for the import snapshot task.
+ description: Describes an import snapshot task.
+ ImportSnapshotTaskIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImportSnapshotTaskId'
+ - xml:
+ name: ImportTaskId
+ ImportTaskIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ImportImageTaskId'
+ - xml:
+ name: ImportTaskId
+ ImportVolumeRequest:
+ type: object
+ required:
+ - AvailabilityZone
+ - Image
+ - Volume
+ title: ImportVolumeRequest
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone for the resulting EBS volume.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the volume.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ image:
+ allOf:
+ - $ref: '#/components/schemas/DiskImageDetail'
+ - description: The disk image.
+ volume:
+ allOf:
+ - $ref: '#/components/schemas/VolumeDetail'
+ - description: The volume size.
+ InferenceDeviceInfoList:
+ type: array
+ items:
+ $ref: '#/components/schemas/InferenceDeviceInfo'
+ InferenceAcceleratorInfo:
+ type: object
+ properties:
+ accelerators:
+ allOf:
+ - $ref: '#/components/schemas/InferenceDeviceInfoList'
+ - description: Describes the Inference accelerators for the instance type.
+ description: Describes the Inference accelerators for the instance type.
+ InferenceDeviceCount:
+ type: integer
+ InferenceDeviceName:
+ type: string
+ InferenceDeviceManufacturerName:
+ type: string
+ InferenceDeviceInfo:
+ type: object
+ properties:
+ count:
+ allOf:
+ - $ref: '#/components/schemas/InferenceDeviceCount'
+ - description: The number of Inference accelerators for the instance type.
+ name:
+ allOf:
+ - $ref: '#/components/schemas/InferenceDeviceName'
+ - description: The name of the Inference accelerator.
+ manufacturer:
+ allOf:
+ - $ref: '#/components/schemas/InferenceDeviceManufacturerName'
+ - description: The manufacturer of the Inference accelerator.
+ description: Describes the Inference accelerators for the instance type.
+ Monitoring:
+ type: object
+ properties:
+ state:
+ allOf:
+ - $ref: '#/components/schemas/MonitoringState'
+ - description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.'
+ description: Describes the monitoring of an instance.
+ InstanceState:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
' + name: + allOf: + - $ref: '#/components/schemas/InstanceStateName' + - description: The current state of the instance. + description: Describes the current state of an instance. + InstanceBlockDeviceMappingList: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceBlockDeviceMapping' + - xml: + name: item + InstanceLifecycleType: + type: string + enum: + - spot + - scheduled + InstanceNetworkInterfaceList: + type: array + items: + allOf: + - $ref: '#/components/schemas/InstanceNetworkInterface' + - xml: + name: item + LicenseList: + type: array + items: + allOf: + - $ref: '#/components/schemas/LicenseConfiguration' + - xml: + name: item + InstanceMetadataOptionsResponse: + type: object + properties: + state: + allOf: + - $ref: '#/components/schemas/InstanceMetadataOptionsState' + - description:The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
The state of token usage for your instance metadata requests.
If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.
Default: optional
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
' + httpEndpoint: + allOf: + - $ref: '#/components/schemas/InstanceMetadataEndpointState' + - description: 'Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
If the value is disabled, you cannot access your instance metadata.
Windows for Windows instances; otherwise blank.
+ privateDnsName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: '(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you''ve enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
' + privateIpAddress: + allOf: + - $ref: '#/components/schemas/String' + - description: The private IPv4 address assigned to the instance. + productCodes: + allOf: + - $ref: '#/components/schemas/ProductCodeList' + - description: 'The product codes attached to this instance, if applicable.' + dnsName: + allOf: + - $ref: '#/components/schemas/String' + - description: '(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters therunning state. For EC2-VPC, this name is only available if you''ve enabled DNS hostnames for your VPC.'
+ ipAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
' + ramdiskId: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The RAM disk associated with this instance, if applicable.' + instanceState: + allOf: + - $ref: '#/components/schemas/InstanceState' + - description: The current state of the instance. + reason: + allOf: + - $ref: '#/components/schemas/String' + - description: The reason for the most recent state transition. This might be an empty string. + subnetId: + allOf: + - $ref: '#/components/schemas/String' + - description: '[EC2-VPC] The ID of the subnet in which the instance is running.' + vpcId: + allOf: + - $ref: '#/components/schemas/String' + - description: '[EC2-VPC] The ID of the VPC in which the instance is running.' + architecture: + allOf: + - $ref: '#/components/schemas/ArchitectureValues' + - description: The architecture of the image. + blockDeviceMapping: + allOf: + - $ref: '#/components/schemas/InstanceBlockDeviceMappingList' + - description: Any block device mapping entries for the instance. + clientToken: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The idempotency token you provided when you launched the instance, if applicable.' + ebsOptimized: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. + enaSupport: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Specifies whether enhanced networking with ENA is enabled. + hypervisor: + allOf: + - $ref: '#/components/schemas/HypervisorType' + - description: The hypervisor type of the instance. The valuexen is used for both Xen and Nitro hypervisors.
+ iamInstanceProfile:
+ allOf:
+ - $ref: '#/components/schemas/IamInstanceProfile'
+ - description: 'The IAM instance profile associated with the instance, if applicable.'
+ instanceLifecycle:
+ allOf:
+ - $ref: '#/components/schemas/InstanceLifecycleType'
+ - description: Indicates whether this is a Spot Instance or a Scheduled Instance.
+ elasticGpuAssociationSet:
+ allOf:
+ - $ref: '#/components/schemas/ElasticGpuAssociationList'
+ - description: The Elastic GPU associated with the instance.
+ elasticInferenceAcceleratorAssociationSet:
+ allOf:
+ - $ref: '#/components/schemas/ElasticInferenceAcceleratorAssociationList'
+ - description: ' The elastic inference accelerator associated with the instance.'
+ networkInterfaceSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceNetworkInterfaceList'
+ - description: '[EC2-VPC] The network interfaces for the instance.'
+ outpostArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the Outpost.
+ rootDeviceName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The device name of the root device volume (for example, /dev/sda1).'
+ rootDeviceType:
+ allOf:
+ - $ref: '#/components/schemas/DeviceType'
+ - description: The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
+ groupSet:
+ allOf:
+ - $ref: '#/components/schemas/GroupIdentifierList'
+ - description: The security groups for the instance.
+ sourceDestCheck:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether source/destination checking is enabled.
+ spotInstanceRequestId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'If the request is a Spot Instance request, the ID of the request.'
+ sriovNetSupport:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
+ stateReason:
+ allOf:
+ - $ref: '#/components/schemas/StateReason'
+ - description: The reason for the most recent state transition.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the instance.
+ virtualizationType:
+ allOf:
+ - $ref: '#/components/schemas/VirtualizationType'
+ - description: The virtualization type of the instance.
+ cpuOptions:
+ allOf:
+ - $ref: '#/components/schemas/CpuOptions'
+ - description: The CPU options for the instance.
+ capacityReservationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Capacity Reservation.
+ capacityReservationSpecification:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationSpecificationResponse'
+ - description: Information about the Capacity Reservation targeting option.
+ hibernationOptions:
+ allOf:
+ - $ref: '#/components/schemas/HibernationOptions'
+ - description: Indicates whether the instance is enabled for hibernation.
+ licenseSet:
+ allOf:
+ - $ref: '#/components/schemas/LicenseList'
+ - description: The license configurations for the instance.
+ metadataOptions:
+ allOf:
+ - $ref: '#/components/schemas/InstanceMetadataOptionsResponse'
+ - description: The metadata options for the instance.
+ enclaveOptions:
+ allOf:
+ - $ref: '#/components/schemas/EnclaveOptions'
+ - description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
+ bootMode:
+ allOf:
+ - $ref: '#/components/schemas/BootModeValues'
+ - description: 'The boot mode of the instance. For more information, see Boot modes in the Amazon EC2 User Guide.'
+ platformDetails:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.'
+ usageOperation:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.'
+ usageOperationUpdateTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time that the usage operation was last updated.
+ privateDnsNameOptions:
+ allOf:
+ - $ref: '#/components/schemas/PrivateDnsNameOptionsResponse'
+ - description: The options for the instance hostname.
+ ipv6Address:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 address assigned to the instance.
+ tpmSupport:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'If the instance is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.'
+ maintenanceOptions:
+ allOf:
+ - $ref: '#/components/schemas/InstanceMaintenanceOptions'
+ - description: Provides information on the recovery and maintenance options of your instance.
+ description: Describes an instance.
+ InstanceBlockDeviceMapping:
+ type: object
+ properties:
+ deviceName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The device name (for example, /dev/sdh or xvdh).'
+ ebs:
+ allOf:
+ - $ref: '#/components/schemas/EbsInstanceBlockDevice'
+ - description: Parameters used to automatically set up EBS volumes when the instance is launched.
+ description: Describes a block device mapping.
+ InstanceBlockDeviceMappingSpecificationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceBlockDeviceMappingSpecification'
+ - xml:
+ name: item
+ ListingState:
+ type: string
+ enum:
+ - available
+ - sold
+ - cancelled
+ - pending
+ InstanceCount:
+ type: object
+ properties:
+ instanceCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of listed Reserved Instances in the state specified by the state.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/ListingState'
+ - description: The states of the listed Reserved Instances.
+ description: Describes a Reserved Instance listing state.
+ InstanceCountList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceCount'
+ - xml:
+ name: item
+ InstanceCreditSpecification:
+ type: object
+ properties:
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance.
+ cpuCredits:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The credit option for CPU usage of the instance. Valid values are standard and unlimited.
+ description: 'Describes the credit option for CPU usage of a burstable performance instance. '
+ InstanceCreditSpecificationListRequest:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceCreditSpecificationRequest'
+ - xml:
+ name: item
+ InstanceEventId:
+ type: string
+ InstanceEventWindowTimeRangeList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowTimeRange'
+ - xml:
+ name: item
+ InstanceEventWindowAssociationTarget:
+ type: object
+ properties:
+ instanceIdSet:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdList'
+ - description: The IDs of the instances associated with the event window.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window.
+ dedicatedHostIdSet:
+ allOf:
+ - $ref: '#/components/schemas/DedicatedHostIdList'
+ - description: The IDs of the Dedicated Hosts associated with the event window.
+ description: One or more targets associated with the event window.
+ InstanceEventWindowState:
+ type: string
+ enum:
+ - creating
+ - deleting
+ - active
+ - deleted
+ WeekDay:
+ type: string
+ enum:
+ - sunday
+ - monday
+ - tuesday
+ - wednesday
+ - thursday
+ - friday
+ - saturday
+ InstanceEventWindowTimeRange:
+ type: object
+ properties:
+ startWeekDay:
+ allOf:
+ - $ref: '#/components/schemas/WeekDay'
+ - description: The day on which the time range begins.
+ startHour:
+ allOf:
+ - $ref: '#/components/schemas/Hour'
+ - description: The hour when the time range begins.
+ endWeekDay:
+ allOf:
+ - $ref: '#/components/schemas/WeekDay'
+ - description: The day on which the time range ends.
+ endHour:
+ allOf:
+ - $ref: '#/components/schemas/Hour'
+ - description: The hour when the time range ends.
+ description: 'The start day and time and the end day and time of the time range, in UTC.'
+ InstanceEventWindowTimeRangeRequestSet:
+ type: array
+ items:
+ $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest'
+ InstanceGeneration:
+ type: string
+ enum:
+ - current
+ - previous
+ InstanceGenerationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceGeneration'
+ - xml:
+ name: item
+ InstanceIdSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - xml:
+ name: item
+ InstanceIpv4Prefix:
+ type: object
+ properties:
+ ipv4Prefix:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: One or more IPv4 prefixes assigned to the network interface.
+ description: Information about an IPv4 prefix.
+ InstanceIpv4PrefixList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIpv4Prefix'
+ - xml:
+ name: item
+ InstanceIpv6AddressRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 address.
+ description: Describes an IPv6 address.
+ InstanceIpv6AddressListRequest:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIpv6AddressRequest'
+ - xml:
+ name: InstanceIpv6Address
+ InstanceIpv6Prefix:
+ type: object
+ properties:
+ ipv6Prefix:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: One or more IPv6 prefixes assigned to the network interface.
+ description: Information about an IPv6 prefix.
+ InstanceIpv6PrefixList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIpv6Prefix'
+ - xml:
+ name: item
+ InstanceList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Instance'
+ - xml:
+ name: item
+ InstanceMaintenanceOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/InstanceAutoRecoveryState'
+ - description: 'Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.'
+ description: The maintenance options for the instance.
+ InstanceMarketOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/SpotMarketOptions'
+ - description: The options for Spot Instances.
+ description: Describes the market (purchasing) option for the instances.
+ InstanceMetadataEndpointState:
+ type: string
+ enum:
+ - disabled
+ - enabled
+ InstanceMetadataOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/InstanceMetadataTagsState'
+ - description: 'Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
The type of network interface.
Valid values: interface | efa | trunk
0, there is no minimum limit.'
+ max:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.'
+ description: The minimum and maximum number of vCPUs.
+ MemoryMiB:
+ type: object
+ properties:
+ min:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.'
+ max:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.'
+ description: 'The minimum and maximum amount of memory, in MiB.'
+ MemoryGiBPerVCpu:
+ type: object
+ properties:
+ min:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: 'The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.'
+ max:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: 'The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.'
+ description: 'The minimum and maximum amount of memory per vCPU, in GiB.
' + NetworkInterfaceCount: + type: object + properties: + min: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.' + max: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.' + description: The minimum and maximum number of network interfaces. + LocalStorageTypeSet: + type: array + items: + allOf: + - $ref: '#/components/schemas/LocalStorageType' + - xml: + name: item + TotalLocalStorageGB: + type: object + properties: + min: + allOf: + - $ref: '#/components/schemas/Double' + - description: 'The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.' + max: + allOf: + - $ref: '#/components/schemas/Double' + - description: 'The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.' + description: 'The minimum and maximum amount of total local storage, in GB.' + InstanceRequirementsWithMetadataRequest: + type: object + properties: + ArchitectureType: + allOf: + - $ref: '#/components/schemas/ArchitectureTypeSet' + - description: The architecture type. + VirtualizationType: + allOf: + - $ref: '#/components/schemas/InstanceRequirementsRequest' + - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.' + description: 'The architecture type, virtualization type, and other attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadataRequest, you can''t specify InstanceTypes.
running state.
+ instanceStatus:
+ allOf:
+ - $ref: '#/components/schemas/InstanceStatusSummary'
+ - description: 'Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.'
+ systemStatus:
+ allOf:
+ - $ref: '#/components/schemas/InstanceStatusSummary'
+ - description: 'Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.'
+ description: Describes the status of an instance.
+ StatusName:
+ type: string
+ enum:
+ - reachability
+ StatusType:
+ type: string
+ enum:
+ - passed
+ - failed
+ - insufficient-data
+ - initializing
+ InstanceStatusDetails:
+ type: object
+ properties:
+ impairedSince:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.'
+ name:
+ allOf:
+ - $ref: '#/components/schemas/StatusName'
+ - description: The type of instance status.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/StatusType'
+ - description: The status.
+ description: Describes the instance status.
+ InstanceStatusDetailsList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InstanceStatusDetails'
+ - xml:
+ name: item
+ InstanceStatusEvent:
+ type: object
+ properties:
+ instanceEventId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventId'
+ - description: The ID of the event.
+ code:
+ allOf:
+ - $ref: '#/components/schemas/EventCode'
+ - description: The event code.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A description of the event.
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
' + notAfter: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: The latest scheduled end time for the event. + notBefore: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: The earliest scheduled start time for the event. + notBeforeDeadline: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: The deadline for starting the event. + description: Describes a scheduled event for an instance. + SummaryStatus: + type: string + enum: + - ok + - impaired + - insufficient-data + - not-applicable + - initializing + InstanceStorageEncryptionSupport: + type: string + enum: + - unsupported + - required + InstanceStorageFlag: + type: boolean + InstanceStorageInfo: + type: object + properties: + totalSizeInGB: + allOf: + - $ref: '#/components/schemas/DiskSize' + - description: 'The total size of the disks, in GB.' + disks: + allOf: + - $ref: '#/components/schemas/DiskInfoList' + - description: Describes the disks that are available for the instance type. + nvmeSupport: + allOf: + - $ref: '#/components/schemas/EphemeralNvmeSupport' + - description: Indicates whether non-volatile memory express (NVMe) is supported. + encryptionSupport: + allOf: + - $ref: '#/components/schemas/InstanceStorageEncryptionSupport' + - description: Indicates whether data is encrypted at rest. + description: Describes the instance store features that are supported by the instance type. + InstanceTypeHypervisor: + type: string + enum: + - nitro + - xen + UsageClassTypeList: + type: array + items: + allOf: + - $ref: '#/components/schemas/UsageClassType' + - xml: + name: item + RootDeviceTypeList: + type: array + items: + allOf: + - $ref: '#/components/schemas/RootDeviceType' + - xml: + name: item + VirtualizationTypeList: + type: array + items: + allOf: + - $ref: '#/components/schemas/VirtualizationType' + - xml: + name: item + ProcessorInfo: + type: object + properties: + supportedArchitectures: + allOf: + - $ref: '#/components/schemas/ArchitectureTypeList' + - description: The architectures supported by the instance type. + sustainedClockSpeedInGhz: + allOf: + - $ref: '#/components/schemas/ProcessorSustainedClockSpeed' + - description: 'The speed of the processor, in GHz.' + description: Describes the processor used by the instance type. + VCpuInfo: + type: object + properties: + defaultVCpus: + allOf: + - $ref: '#/components/schemas/VCpuCount' + - description: The default number of vCPUs for the instance type. + defaultCores: + allOf: + - $ref: '#/components/schemas/CoreCount' + - description: The default number of cores for the instance type. + defaultThreadsPerCore: + allOf: + - $ref: '#/components/schemas/ThreadsPerCore' + - description: The default number of threads per core for the instance type. + validCores: + allOf: + - $ref: '#/components/schemas/CoreCountList' + - description: The valid number of cores that can be configured for the instance type. + validThreadsPerCore: + allOf: + - $ref: '#/components/schemas/ThreadsPerCoreList' + - description: 'The valid number of threads per core that can be configured for the instance type. ' + description: Describes the vCPU configurations for the instance type. + MemoryInfo: + type: object + properties: + sizeInMiB: + allOf: + - $ref: '#/components/schemas/MemorySize' + - description: 'The size of the memory, in MiB.' + description: Describes the memory for the instance type. + NetworkInfo: + type: object + properties: + networkPerformance: + allOf: + - $ref: '#/components/schemas/NetworkPerformance' + - description: The network performance. + maximumNetworkInterfaces: + allOf: + - $ref: '#/components/schemas/MaxNetworkInterfaces' + - description: The maximum number of network interfaces for the instance type. + maximumNetworkCards: + allOf: + - $ref: '#/components/schemas/MaximumNetworkCards' + - description: The maximum number of physical network cards that can be allocated to the instance. + defaultNetworkCardIndex: + allOf: + - $ref: '#/components/schemas/DefaultNetworkCardIndex' + - description: 'The index of the default network card, starting at 0.' + networkCards: + allOf: + - $ref: '#/components/schemas/NetworkCardInfoList' + - description: Describes the network cards for the instance type. + ipv4AddressesPerInterface: + allOf: + - $ref: '#/components/schemas/MaxIpv4AddrPerInterface' + - description: The maximum number of IPv4 addresses per network interface. + ipv6AddressesPerInterface: + allOf: + - $ref: '#/components/schemas/MaxIpv6AddrPerInterface' + - description: The maximum number of IPv6 addresses per network interface. + ipv6Supported: + allOf: + - $ref: '#/components/schemas/Ipv6Flag' + - description: Indicates whether IPv6 is supported. + enaSupport: + allOf: + - $ref: '#/components/schemas/EnaSupport' + - description: Indicates whether Elastic Network Adapter (ENA) is supported. + efaSupported: + allOf: + - $ref: '#/components/schemas/EfaSupportedFlag' + - description: Indicates whether Elastic Fabric Adapter (EFA) is supported. + efaInfo: + allOf: + - $ref: '#/components/schemas/EfaInfo' + - description: Describes the Elastic Fabric Adapters for the instance type. + encryptionInTransitSupported: + allOf: + - $ref: '#/components/schemas/EncryptionInTransitSupported' + - description: Indicates whether the instance type automatically encrypts in-transit traffic between instances. + description: Describes the networking features of the instance type. + PlacementGroupInfo: + type: object + properties: + supportedStrategies: + allOf: + - $ref: '#/components/schemas/PlacementGroupStrategyList' + - description: The supported placement group types. + description: Describes the placement group support of the instance type. + InstanceTypeInfo: + type: object + properties: + instanceType: + allOf: + - $ref: '#/components/schemas/InstanceType' + - description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.' + currentGeneration: + allOf: + - $ref: '#/components/schemas/CurrentGenerationFlag' + - description: Indicates whether the instance type is current generation. + freeTierEligible: + allOf: + - $ref: '#/components/schemas/FreeTierEligibleFlag' + - description: Indicates whether the instance type is eligible for the free tier. + supportedUsageClasses: + allOf: + - $ref: '#/components/schemas/UsageClassTypeList' + - description: Indicates whether the instance type is offered for spot or On-Demand. + supportedRootDeviceTypes: + allOf: + - $ref: '#/components/schemas/RootDeviceTypeList' + - description: The supported root device types. + supportedVirtualizationTypes: + allOf: + - $ref: '#/components/schemas/VirtualizationTypeList' + - description: The supported virtualization types. + bareMetal: + allOf: + - $ref: '#/components/schemas/BareMetalFlag' + - description: Indicates whether the instance is a bare metal instance type. + hypervisor: + allOf: + - $ref: '#/components/schemas/InstanceTypeHypervisor' + - description: The hypervisor for the instance type. + processorInfo: + allOf: + - $ref: '#/components/schemas/ProcessorInfo' + - description: Describes the processor. + vCpuInfo: + allOf: + - $ref: '#/components/schemas/VCpuInfo' + - description: Describes the vCPU configurations for the instance type. + memoryInfo: + allOf: + - $ref: '#/components/schemas/MemoryInfo' + - description: Describes the memory for the instance type. + instanceStorageSupported: + allOf: + - $ref: '#/components/schemas/InstanceStorageFlag' + - description: Indicates whether instance storage is supported. + instanceStorageInfo: + allOf: + - $ref: '#/components/schemas/InstanceStorageInfo' + - description: Describes the instance storage for the instance type. + ebsInfo: + allOf: + - $ref: '#/components/schemas/EbsInfo' + - description: Describes the Amazon EBS settings for the instance type. + networkInfo: + allOf: + - $ref: '#/components/schemas/NetworkInfo' + - description: Describes the network settings for the instance type. + gpuInfo: + allOf: + - $ref: '#/components/schemas/GpuInfo' + - description: Describes the GPU accelerator settings for the instance type. + fpgaInfo: + allOf: + - $ref: '#/components/schemas/FpgaInfo' + - description: Describes the FPGA accelerator settings for the instance type. + placementGroupInfo: + allOf: + - $ref: '#/components/schemas/PlacementGroupInfo' + - description: Describes the placement group settings for the instance type. + inferenceAcceleratorInfo: + allOf: + - $ref: '#/components/schemas/InferenceAcceleratorInfo' + - description: Describes the Inference accelerator settings for the instance type. + hibernationSupported: + allOf: + - $ref: '#/components/schemas/HibernationFlag' + - description: Indicates whether On-Demand hibernation is supported. + burstablePerformanceSupported: + allOf: + - $ref: '#/components/schemas/BurstablePerformanceFlag' + - description: Indicates whether the instance type is a burstable performance instance type. + dedicatedHostsSupported: + allOf: + - $ref: '#/components/schemas/DedicatedHostFlag' + - description: Indicates whether Dedicated Hosts are supported on the instance type. + autoRecoverySupported: + allOf: + - $ref: '#/components/schemas/AutoRecoveryFlag' + - description: Indicates whether auto recovery is supported. + supportedBootModes: + allOf: + - $ref: '#/components/schemas/BootModeTypeList' + - description: 'The supported boot modes. For more information, see Boot modes in the Amazon EC2 User Guide.' + description: Describes the instance type. + InstanceTypeInfoFromInstanceRequirements: + type: object + properties: + instanceType: + allOf: + - $ref: '#/components/schemas/String' + - description: The matching instance type. + description: The list of instance types with the specified instance attributes. + Location: + type: string + InstanceTypeOffering: + type: object + properties: + instanceType: + allOf: + - $ref: '#/components/schemas/InstanceType' + - description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.' + locationType: + allOf: + - $ref: '#/components/schemas/LocationType' + - description: The location type. + location: + allOf: + - $ref: '#/components/schemas/Location' + - description: 'The identifier for the location. This depends on the location type. For example, if the location type isregion, the location is the Region code (for example, us-east-2.)'
+ description: The instance types offered.
+ InstanceTypes:
+ type: array
+ items:
+ $ref: '#/components/schemas/String'
+ minItems: 0
+ maxItems: 1000
+ InstanceUsage:
+ type: object
+ properties:
+ accountId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that is making use of the Capacity Reservation.
+ usedInstanceCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of instances the Amazon Web Services account currently has in the Capacity Reservation.
+ description: Information about the Capacity Reservation usage.
+ InterfacePermissionType:
+ type: string
+ enum:
+ - INSTANCE-ATTACH
+ - EIP-ASSOCIATE
+ InterfaceProtocolType:
+ type: string
+ enum:
+ - VLAN
+ - GRE
+ InternetGatewayAttachment:
+ type: object
+ properties:
+ state:
+ allOf:
+ - $ref: '#/components/schemas/AttachmentStatus'
+ - description: 'The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.'
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ description: Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
+ InternetGatewayIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/InternetGatewayId'
+ - xml:
+ name: item
+ IpAddressType:
+ type: string
+ enum:
+ - ipv4
+ - dualstack
+ - ipv6
+ IpRangeList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/IpRange'
+ - xml:
+ name: item
+ Ipv6RangeList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6Range'
+ - xml:
+ name: item
+ PrefixListIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListId'
+ - xml:
+ name: item
+ UserIdGroupPairList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/UserIdGroupPair'
+ - xml:
+ name: item
+ IpRange:
+ type: object
+ properties:
+ cidrIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.'
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' + description: Describes an IPv4 range. + IpRanges: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + IpamId: + type: string + IpamOperatingRegionSet: + type: array + items: + allOf: + - $ref: '#/components/schemas/IpamOperatingRegion' + - xml: + name: item + IpamState: + type: string + enum: + - create-in-progress + - create-complete + - create-failed + - modify-in-progress + - modify-complete + - modify-failed + - delete-in-progress + - delete-complete + - delete-failed + - isolate-in-progress + - isolate-complete + - restore-in-progress + IpamAddressHistoryMaxResults: + type: integer + minimum: 1 + maximum: 1000 + IpamAddressHistoryResourceType: + type: string + enum: + - eip + - vpc + - subnet + - network-interface + - instance + IpamComplianceStatus: + type: string + enum: + - compliant + - noncompliant + - unmanaged + - ignored + IpamOverlapStatus: + type: string + enum: + - overlapping + - nonoverlapping + - ignored + IpamAddressHistoryRecord: + type: object + properties: + resourceOwnerId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the resource owner. + resourceRegion: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Web Services Region of the resource. + resourceType: + allOf: + - $ref: '#/components/schemas/IpamAddressHistoryResourceType' + - description: The type of the resource. + resourceId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the resource. + resourceCidr: + allOf: + - $ref: '#/components/schemas/String' + - description: The CIDR of the resource. + resourceName: + allOf: + - $ref: '#/components/schemas/String' + - description: The name of the resource. + resourceComplianceStatus: + allOf: + - $ref: '#/components/schemas/IpamComplianceStatus' + - description: 'The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' + resourceOverlapStatus: + allOf: + - $ref: '#/components/schemas/IpamOverlapStatus' + - description: 'The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' + vpcId: + allOf: + - $ref: '#/components/schemas/String' + - description: The VPC ID of the resource. + sampledStartTime: + allOf: + - $ref: '#/components/schemas/MillisecondDateTime' + - description: 'Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.' + sampledEndTime: + allOf: + - $ref: '#/components/schemas/MillisecondDateTime' + - description: 'Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.' + description: 'The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide. ' + IpamCidrAuthorizationContext: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The signed authorization message for the prefix and account. + description: A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. + IpamManagementState: + type: string + enum: + - managed + - unmanaged + - ignored + IpamMaxResults: + type: integer + minimum: 5 + maximum: 1000 + IpamOperatingRegion: + type: object + properties: + regionName: + allOf: + - $ref: '#/components/schemas/String' + - description: The name of the operating Region. + description: 'The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' + IpamScopeType: + type: string + enum: + - public + - private + IpamPoolState: + type: string + enum: + - create-in-progress + - create-complete + - create-failed + - modify-in-progress + - modify-complete + - modify-failed + - delete-in-progress + - delete-complete + - delete-failed + - isolate-in-progress + - isolate-complete + - restore-in-progress + IpamResourceTagList: + type: array + items: + allOf: + - $ref: '#/components/schemas/IpamResourceTag' + - xml: + name: item + IpamPoolAllocationResourceType: + type: string + enum: + - ipam-pool + - vpc + - ec2-public-ipv4-pool + - custom + IpamPoolCidrState: + type: string + enum: + - pending-provision + - provisioned + - failed-provision + - pending-deprovision + - deprovisioned + - failed-deprovision + - pending-import + - failed-import + IpamPoolCidrFailureReason: + type: object + properties: + code: + allOf: + - $ref: '#/components/schemas/IpamPoolCidrFailureCode' + - description: An error code related to why an IPAM pool CIDR failed to be provisioned. + message: + allOf: + - $ref: '#/components/schemas/String' + - description: A message related to why an IPAM pool CIDR failed to be provisioned. + description: Details related to why an IPAM pool CIDR failed to be provisioned. + IpamPoolCidrFailureCode: + type: string + enum: + - cidr-not-available + IpamResourceType: + type: string + enum: + - vpc + - subnet + - eip + - public-ipv4-pool + - ipv6-pool + IpamResourceCidr: + type: object + properties: + ipamId: + allOf: + - $ref: '#/components/schemas/IpamId' + - description: The IPAM ID for an IPAM resource. + ipamScopeId: + allOf: + - $ref: '#/components/schemas/IpamScopeId' + - description: The scope ID for an IPAM resource. + ipamPoolId: + allOf: + - $ref: '#/components/schemas/IpamPoolId' + - description: The pool ID for an IPAM resource. + resourceRegion: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Web Services Region for an IPAM resource. + resourceOwnerId: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Web Services account number of the owner of an IPAM resource. + resourceId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of an IPAM resource. + resourceName: + allOf: + - $ref: '#/components/schemas/String' + - description: The name of an IPAM resource. + resourceCidr: + allOf: + - $ref: '#/components/schemas/String' + - description: The CIDR for an IPAM resource. + resourceType: + allOf: + - $ref: '#/components/schemas/IpamResourceType' + - description: The type of IPAM resource. + resourceTagSet: + allOf: + - $ref: '#/components/schemas/IpamResourceTagList' + - description: The tags for an IPAM resource. + ipUsage: + allOf: + - $ref: '#/components/schemas/BoxedDouble' + - description: 'The IP address space in the IPAM pool that is allocated to this resource. To convert the decimal to a percentage, multiply the decimal by 100.' + complianceStatus: + allOf: + - $ref: '#/components/schemas/IpamComplianceStatus' + - description: 'The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' + managementState: + allOf: + - $ref: '#/components/schemas/IpamManagementState' + - description: 'The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' + overlapStatus: + allOf: + - $ref: '#/components/schemas/IpamOverlapStatus' + - description: 'The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' + vpcId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of a VPC. + description: The CIDR for an IPAM resource. + IpamResourceTag: + type: object + properties: + key: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.' + value: + allOf: + - $ref: '#/components/schemas/String' + - description: The value of the tag. + description: 'The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
+ IpamScopeState:
+ type: string
+ enum:
+ - create-in-progress
+ - create-complete
+ - create-failed
+ - modify-in-progress
+ - modify-complete
+ - modify-failed
+ - delete-in-progress
+ - delete-complete
+ - delete-failed
+ - isolate-in-progress
+ - isolate-complete
+ - restore-in-progress
+ Ipv4PrefixList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PrefixSpecificationRequest'
+ - xml:
+ name: item
+ Ipv4PrefixSpecificationResponse:
+ type: object
+ properties:
+ ipv4Prefix:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: One or more IPv4 delegated prefixes assigned to the network interface.
+ description: Information about the IPv4 delegated prefixes assigned to a network interface.
+ Ipv4PrefixListResponse:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PrefixSpecificationResponse'
+ - xml:
+ name: item
+ Ipv4PrefixSpecification:
+ type: object
+ properties:
+ ipv4Prefix:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.'
+ description: Describes an IPv4 prefix.
+ Ipv6Address:
+ type: string
+ Ipv6CidrAssociation:
+ type: object
+ properties:
+ ipv6Cidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 CIDR block.
+ associatedResource:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The resource that's associated with the IPv6 CIDR block.
+ description: Describes an IPv6 CIDR block association.
+ Ipv6CidrBlock:
+ type: object
+ properties:
+ ipv6CidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 CIDR block.
+ description: Describes an IPv6 CIDR block.
+ Ipv6CidrBlockSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6CidrBlock'
+ - xml:
+ name: item
+ Ipv6Flag:
+ type: boolean
+ PoolCidrBlocksSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PoolCidrBlock'
+ - xml:
+ name: item
+ Ipv6Pool:
+ type: object
+ properties:
+ poolId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the address pool.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description for the address pool.
+ poolCidrBlockSet:
+ allOf:
+ - $ref: '#/components/schemas/PoolCidrBlocksSet'
+ - description: The CIDR blocks for the address pool.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags for the address pool.
+ description: Describes an IPv6 address pool.
+ Ipv6PoolIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6PoolEc2Id'
+ - xml:
+ name: item
+ Ipv6PoolMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ Ipv6PrefixList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6PrefixSpecificationRequest'
+ - xml:
+ name: item
+ Ipv6PrefixSpecificationResponse:
+ type: object
+ properties:
+ ipv6Prefix:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: One or more IPv6 delegated prefixes assigned to the network interface.
+ description: Information about the IPv6 delegated prefixes assigned to a network interface.
+ Ipv6PrefixListResponse:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6PrefixSpecificationResponse'
+ - xml:
+ name: item
+ Ipv6PrefixSpecification:
+ type: object
+ properties:
+ ipv6Prefix:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 prefix.
+ description: Describes the IPv6 prefix.
+ Ipv6PrefixesList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6PrefixSpecification'
+ - xml:
+ name: item
+ Ipv6Range:
+ type: object
+ properties:
+ cidrIpv6:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.'
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' + description: '[EC2-VPC only] Describes an IPv6 range.' + Ipv6SupportValue: + type: string + enum: + - enable + - disable + SensitiveUserData: + type: string + format: password + KeyPairInfo: + type: object + properties: + keyPairId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the key pair. + keyFingerprint: + allOf: + - $ref: '#/components/schemas/String' + - description: 'If you used CreateKeyPair to create the key pair:
For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
If you used ImportKeyPair to provide Amazon Web Services the public key:
For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone.
If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone.
' + description: Describes a key pair. + LastError: + type: object + properties: + message: + allOf: + - $ref: '#/components/schemas/String' + - description: The error message for the VPC endpoint error. + code: + allOf: + - $ref: '#/components/schemas/String' + - description: The error code for the VPC endpoint error. + description: The last error that occurred for a VPC endpoint. + LaunchPermission: + type: object + properties: + group: + allOf: + - $ref: '#/components/schemas/PermissionGroup' + - description: The name of the group. + userId: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The Amazon Web Services account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
' + organizationArn: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Resource Name (ARN) of an organization. + organizationalUnitArn: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Resource Name (ARN) of an organizational unit (OU). + description: Describes a launch permission. + LaunchPermissionModifications: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/LaunchPermissionList' + - description: 'The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.' + description: Describes a launch permission modification. + LaunchSpecification: + type: object + properties: + userData: + allOf: + - $ref: '#/components/schemas/String' + - description: The Base64-encoded user data for the instance. + groupSet: + allOf: + - $ref: '#/components/schemas/GroupIdentifierList' + - description: 'One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.' + addressingType: + allOf: + - $ref: '#/components/schemas/String' + - description: Deprecated. + blockDeviceMapping: + allOf: + - $ref: '#/components/schemas/BlockDeviceMappingList' + - description: One or more block device mapping entries. + ebsOptimized: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.
WeightedCapacity.'
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - description: 'The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".'
+ userData:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Base64-encoded user data that instances use when starting up.
+ weightedCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: 'The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
' + tagSpecificationSet: + allOf: + - $ref: '#/components/schemas/SpotFleetTagSpecificationList' + - description: The tags to apply during creation. + instanceRequirements: + allOf: + - $ref: '#/components/schemas/InstanceRequirements' + - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can''t specify InstanceTypes.
SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.'
+ LaunchTemplateAutoRecoveryState:
+ type: string
+ enum:
+ - default
+ - disabled
+ LaunchTemplateEbsBlockDevice:
+ type: object
+ properties:
+ encrypted:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the EBS volume is encrypted.
+ deleteOnTermination:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the EBS volume is deleted on instance termination.
+ iops:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The number of I/O operations per second (IOPS) that the volume supports. '
+ kmsKeyId:
+ allOf:
+ - $ref: '#/components/schemas/KmsKeyId'
+ - description: The ARN of the Key Management Service (KMS) CMK used for encryption.
+ snapshotId:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotId'
+ - description: The ID of the snapshot.
+ volumeSize:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The size of the volume, in GiB.'
+ volumeType:
+ allOf:
+ - $ref: '#/components/schemas/VolumeType'
+ - description: The volume type.
+ throughput:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The throughput that the volume supports, in MiB/s.'
+ description: Describes a block device for an EBS volume.
+ LaunchTemplateBlockDeviceMapping:
+ type: object
+ properties:
+ deviceName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The device name.
+ virtualName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The virtual device name (ephemeralN).
+ ebs:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateEbsBlockDevice'
+ - description: Information about the block device for an EBS volume.
+ noDevice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'To omit the device from the block device mapping, specify an empty string.'
+ description: Describes a block device mapping.
+ LaunchTemplateBlockDeviceMappingList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMapping'
+ - xml:
+ name: item
+ LaunchTemplateBlockDeviceMappingRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'To omit the device from the block device mapping, specify an empty string.'
+ description: Describes a block device mapping.
+ LaunchTemplateCapacityReservationSpecificationResponse:
+ type: object
+ properties:
+ capacityReservationPreference:
+ allOf:
+ - $ref: '#/components/schemas/CapacityReservationPreference'
+ - description: 'Indicates the instance''s Capacity Reservation preferences. Possible preferences include:
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
' + description: The parameters for a block device for an EBS volume. + LaunchTemplateElasticInferenceAcceleratorCount: + type: integer + minimum: 1 + LaunchTemplateElasticInferenceAccelerator: + type: object + required: + - Type + properties: + undefined: + allOf: + - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorCount' + - description: 'The number of elastic inference accelerators to attach to the instance.
Default: 1
' + description: ' Describes an elastic inference accelerator. ' + LaunchTemplateElasticInferenceAcceleratorResponse: + type: object + properties: + type: + allOf: + - $ref: '#/components/schemas/String' + - description: ' The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. ' + count: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The number of elastic inference accelerators to attach to the instance.
Default: 1
' + description: ' Describes an elastic inference accelerator. ' + LaunchTemplateElasticInferenceAcceleratorResponseList: + type: array + items: + allOf: + - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorResponse' + - xml: + name: item + LaunchTemplateEnclaveOptions: + type: object + properties: + enabled: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'If this parameter is set totrue, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.'
+ description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
+ LaunchTemplateEnclaveOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.'
+ description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.'
+ LaunchTemplateErrorCode:
+ type: string
+ enum:
+ - launchTemplateIdDoesNotExist
+ - launchTemplateIdMalformed
+ - launchTemplateNameDoesNotExist
+ - launchTemplateNameMalformed
+ - launchTemplateVersionDoesNotExist
+ - unexpectedError
+ LaunchTemplateHibernationOptions:
+ type: object
+ properties:
+ configured:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.'
+ description: Indicates whether an instance is configured for hibernation.
+ LaunchTemplateHibernationOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If you set this parameter to true, the instance is enabled for hibernation.
Default: false
terminate.
+ description: The options for Spot Instances.
+ LaunchTemplateInstanceMarketOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateSpotMarketOptionsRequest'
+ - description: The options for Spot Instances.
+ description: The market (purchasing) option for the instances.
+ LaunchTemplateInstanceMetadataEndpointState:
+ type: string
+ enum:
+ - disabled
+ - enabled
+ LaunchTemplateInstanceMetadataOptionsState:
+ type: string
+ enum:
+ - pending
+ - applied
+ LaunchTemplateInstanceMetadataProtocolIpv6:
+ type: string
+ enum:
+ - disabled
+ - enabled
+ LaunchTemplateInstanceMetadataTagsState:
+ type: string
+ enum:
+ - disabled
+ - enabled
+ LaunchTemplateInstanceMetadataOptions:
+ type: object
+ properties:
+ state:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataOptionsState'
+ - description: The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
' + httpEndpoint: + allOf: + - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataEndpointState' + - description: 'Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
Enables or disables the IPv6 endpoint for the instance metadata service.
Default: disabled
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide.
' + associatePublicIpAddress: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Indicates whether to associate a public IPv4 address with eth0 for a new network interface. + deleteOnTermination: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Indicates whether the network interface is deleted when the instance is terminated. + description: + allOf: + - $ref: '#/components/schemas/String' + - description: A description for the network interface. + deviceIndex: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The device index for the network interface attachment. + groupSet: + allOf: + - $ref: '#/components/schemas/GroupIdStringList' + - description: The IDs of one or more security groups. + interfaceType: + allOf: + - $ref: '#/components/schemas/String' + - description: The type of network interface. + ipv6AddressCount: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The number of IPv6 addresses for the network interface. + ipv6AddressesSet: + allOf: + - $ref: '#/components/schemas/InstanceIpv6AddressList' + - description: The IPv6 addresses for the network interface. + networkInterfaceId: + allOf: + - $ref: '#/components/schemas/NetworkInterfaceId' + - description: The ID of the network interface. + privateIpAddress: + allOf: + - $ref: '#/components/schemas/String' + - description: The primary private IPv4 address of the network interface. + privateIpAddressesSet: + allOf: + - $ref: '#/components/schemas/PrivateIpAddressSpecificationList' + - description: One or more private IPv4 addresses. + secondaryPrivateIpAddressCount: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The number of secondary private IPv4 addresses for the network interface. + subnetId: + allOf: + - $ref: '#/components/schemas/SubnetId' + - description: The ID of the subnet for the network interface. + networkCardIndex: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The index of the network card. + ipv4PrefixSet: + allOf: + - $ref: '#/components/schemas/Ipv4PrefixListResponse' + - description: One or more IPv4 prefixes assigned to the network interface. + ipv4PrefixCount: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface. + ipv6PrefixSet: + allOf: + - $ref: '#/components/schemas/Ipv6PrefixListResponse' + - description: One or more IPv6 prefixes assigned to the network interface. + ipv6PrefixCount: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface. + description: Describes a network interface. + LaunchTemplateInstanceNetworkInterfaceSpecificationList: + type: array + items: + allOf: + - $ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecification' + - xml: + name: item + LaunchTemplateInstanceNetworkInterfaceSpecificationRequest: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The device index for the network interface attachment. + SecurityGroupId: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0. + Ipv4Prefix: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use theIpv4Prefix option.
+ Ipv6Prefix:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
+ description: The parameters for a network interface.
+ LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecificationRequest'
+ - xml:
+ name: InstanceNetworkInterfaceSpecification
+ LaunchTemplateLicenseConfiguration:
+ type: object
+ properties:
+ licenseConfigurationArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the license configuration.
+ description: Describes a license configuration.
+ LaunchTemplateLicenseConfigurationRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the license configuration.
+ description: Describes a license configuration.
+ LaunchTemplateLicenseList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateLicenseConfiguration'
+ - xml:
+ name: item
+ LaunchTemplateLicenseSpecificationListRequest:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateLicenseConfigurationRequest'
+ - xml:
+ name: item
+ LaunchTemplateOverrides:
+ type: object
+ properties:
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/InstanceType'
+ - description: The instance type.
+ spotPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The maximum price per unit hour that you are willing to pay for a Spot Instance.
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - description: The ID of the subnet in which to launch the instances.
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone in which to launch the instances.
+ weightedCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: The number of units provided by the specified instance type.
+ priority:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: 'The priority for the launch template override. The highest priority is launched first.
If OnDemandAllocationStrategy is set to prioritized, Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types.
If you specify InstanceRequirements, you can''t specify InstanceTypes.
dedicated runs on single-tenant hardware. '
+ spreadDomain:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Reserved for future use.
+ hostResourceGroupArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ARN of the host resource group in which to launch the instances. '
+ partitionNumber:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
+ description: Describes the placement of an instance.
+ LaunchTemplatePlacementRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
+ description: Describes the placement of an instance.
+ LaunchTemplatePrivateDnsNameOptions:
+ type: object
+ properties:
+ hostnameType:
+ allOf:
+ - $ref: '#/components/schemas/HostnameType'
+ - description: The type of hostname to assign to an instance.
+ enableResourceNameDnsARecord:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
+ enableResourceNameDnsAAAARecord:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
+ description: Describes the options for instance hostnames.
+ LaunchTemplatePrivateDnsNameOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
+ description: Describes the options for instance hostnames.
+ LaunchTemplateSpecification:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The version number of the launch template.
Default: The default version for the launch template.
' + description: 'The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.' + SpotInstanceType: + type: string + enum: + - one-time + - persistent + ResourceType: + type: string + enum: + - capacity-reservation + - client-vpn-endpoint + - customer-gateway + - carrier-gateway + - dedicated-host + - dhcp-options + - egress-only-internet-gateway + - elastic-ip + - elastic-gpu + - export-image-task + - export-instance-task + - fleet + - fpga-image + - host-reservation + - image + - import-image-task + - import-snapshot-task + - instance + - instance-event-window + - internet-gateway + - ipam + - ipam-pool + - ipam-scope + - ipv4pool-ec2 + - ipv6pool-ec2 + - key-pair + - launch-template + - local-gateway + - local-gateway-route-table + - local-gateway-virtual-interface + - local-gateway-virtual-interface-group + - local-gateway-route-table-vpc-association + - local-gateway-route-table-virtual-interface-group-association + - natgateway + - network-acl + - network-interface + - network-insights-analysis + - network-insights-path + - network-insights-access-scope + - network-insights-access-scope-analysis + - placement-group + - prefix-list + - replace-root-volume-task + - reserved-instances + - route-table + - security-group + - security-group-rule + - snapshot + - spot-fleet-request + - spot-instances-request + - subnet + - subnet-cidr-reservation + - traffic-mirror-filter + - traffic-mirror-session + - traffic-mirror-target + - transit-gateway + - transit-gateway-attachment + - transit-gateway-connect-peer + - transit-gateway-multicast-domain + - transit-gateway-route-table + - volume + - vpc + - vpc-endpoint + - vpc-endpoint-service + - vpc-peering-connection + - vpn-connection + - vpn-gateway + - vpc-flow-log + LaunchTemplateTagSpecification: + type: object + properties: + resourceType: + allOf: + - $ref: '#/components/schemas/ResourceType' + - description: The type of resource. + tagSet: + allOf: + - $ref: '#/components/schemas/TagList' + - description: The tags for the resource. + description: The tag specification for the launch template. + LaunchTemplateTagSpecificationList: + type: array + items: + allOf: + - $ref: '#/components/schemas/LaunchTemplateTagSpecification' + - xml: + name: item + LaunchTemplateTagSpecificationRequest: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/ResourceType' + - description: 'The type of resource to tag. Currently, the resource types that support tagging on creation areinstance, volume, elastic-gpu, network-interface, and spot-instances-request. To tag a resource after it has been created, see CreateTags.'
+ Tag:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags to apply to the resource.
+ description: The tags specification for the launch template.
+ VersionDescription:
+ type: string
+ minLength: 0
+ maxLength: 255
+ LaunchTemplatesMonitoring:
+ type: object
+ properties:
+ enabled:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.'
+ description: Describes the monitoring for the instance.
+ LaunchTemplatesMonitoringRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.'
+ description: Describes the monitoring for the instance.
+ LicenseConfiguration:
+ type: object
+ properties:
+ licenseConfigurationArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the license configuration.
+ description: Describes a license configuration.
+ LicenseSpecificationListRequest:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LicenseConfigurationRequest'
+ - xml:
+ name: item
+ ListImagesInRecycleBinMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ ListImagesInRecycleBinRequest:
+ type: object
+ title: ListImagesInRecycleBinRequest
+ properties:
+ ImageId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ListSnapshotsInRecycleBinMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ ListSnapshotsInRecycleBinRequest:
+ type: object
+ title: ListSnapshotsInRecycleBinRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The token for the next page of results.
+ SnapshotId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SnapshotRecycleBinInfoList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotRecycleBinInfo'
+ - xml:
+ name: item
+ ListingStatus:
+ type: string
+ enum:
+ - active
+ - pending
+ - cancelled
+ - closed
+ TargetGroupsConfig:
+ type: object
+ properties:
+ targetGroups:
+ allOf:
+ - $ref: '#/components/schemas/TargetGroups'
+ - description: One or more target groups.
+ description: Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups.
+ LoadPermission:
+ type: object
+ properties:
+ userId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID.
+ group:
+ allOf:
+ - $ref: '#/components/schemas/PermissionGroup'
+ - description: The name of the group.
+ description: Describes a load permission.
+ LoadPermissionRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID.
+ description: Describes a load permission.
+ LoadPermissionModifications:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/LoadPermissionListRequest'
+ - description: The load permissions to remove.
+ description: Describes modifications to the load permissions of an Amazon FPGA image (AFI).
+ LocalGateway:
+ type: object
+ properties:
+ localGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayId'
+ - description: The ID of the local gateway.
+ outpostArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the Outpost.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the local gateway.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The state of the local gateway.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the local gateway.
+ description: Describes a local gateway.
+ LocalGatewayMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ LocalGatewayRouteType:
+ type: string
+ enum:
+ - static
+ - propagated
+ LocalGatewayRouteState:
+ type: string
+ enum:
+ - pending
+ - active
+ - blackhole
+ - deleting
+ - deleted
+ LocalGatewayRouteList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRoute'
+ - xml:
+ name: item
+ LocalGatewayRouteTable:
+ type: object
+ properties:
+ localGatewayRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the local gateway route table.
+ localGatewayRouteTableArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The Amazon Resource Name (ARN) of the local gateway route table.
+ localGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayId'
+ - description: The ID of the local gateway.
+ outpostArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the Outpost.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the local gateway route table.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The state of the local gateway route table.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the local gateway route table.
+ description: Describes a local gateway route table.
+ LocalGatewayRouteTableVirtualInterfaceGroupAssociation:
+ type: object
+ properties:
+ localGatewayRouteTableVirtualInterfaceGroupAssociationId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId'
+ - description: The ID of the association.
+ localGatewayVirtualInterfaceGroupId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
+ - description: The ID of the virtual interface group.
+ localGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the local gateway.
+ localGatewayRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayId'
+ - description: The ID of the local gateway route table.
+ localGatewayRouteTableArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The state of the association.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the association.
+ description: Describes an association between a local gateway route table and a virtual interface group.
+ LocalGatewayVirtualInterface:
+ type: object
+ properties:
+ localGatewayVirtualInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceId'
+ - description: The ID of the virtual interface.
+ localGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the local gateway.
+ vlan:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The ID of the VLAN.
+ localAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The local address.
+ peerAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The peer address.
+ localBgpAsn:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
+ peerBgpAsn:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The peer BGP ASN.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the local gateway virtual interface.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the virtual interface.
+ description: Describes a local gateway virtual interface.
+ LocalGatewayVirtualInterfaceGroup:
+ type: object
+ properties:
+ localGatewayVirtualInterfaceGroupId:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
+ - description: The ID of the virtual interface group.
+ localGatewayVirtualInterfaceIdSet:
+ allOf:
+ - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceIdSet'
+ - description: The IDs of the virtual interfaces.
+ localGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the local gateway.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags assigned to the virtual interface group.
+ description: Describes a local gateway virtual interface group.
+ LocalStorageType:
+ type: string
+ enum:
+ - hdd
+ - ssd
+ PrefixListState:
+ type: string
+ enum:
+ - create-in-progress
+ - create-complete
+ - create-failed
+ - modify-in-progress
+ - modify-complete
+ - modify-failed
+ - restore-in-progress
+ - restore-complete
+ - restore-failed
+ - delete-in-progress
+ - delete-complete
+ - delete-failed
+ MaxIpv4AddrPerInterface:
+ type: integer
+ MaxIpv6AddrPerInterface:
+ type: integer
+ MaxNetworkInterfaces:
+ type: integer
+ MaxResults:
+ type: integer
+ MaximumNetworkCards:
+ type: integer
+ MembershipType:
+ type: string
+ enum:
+ - static
+ - igmp
+ MemorySize:
+ type: integer
+ ModifyAddressAttributeRequest:
+ type: object
+ required:
+ - AllocationId
+ title: ModifyAddressAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyAvailabilityZoneGroupRequest:
+ type: object
+ required:
+ - GroupName
+ - OptInStatus
+ title: ModifyAvailabilityZoneGroupRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyAvailabilityZoneOptInStatus:
+ type: string
+ enum:
+ - opted-in
+ - not-opted-in
+ ModifyCapacityReservationFleetRequest:
+ type: object
+ required:
+ - CapacityReservationFleetId
+ title: ModifyCapacityReservationFleetRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the CancelCapacityReservationFleet action.
You can''t specify RemoveEndDate and EndDate in the same request.
' + ModifyCapacityReservationRequest: + type: object + required: + - CapacityReservationId + title: ModifyCapacityReservationRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: Reserved for future use. + ModifyClientVpnEndpointRequest: + type: object + required: + - ClientVpnEndpointId + title: ModifyClientVpnEndpointRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SecurityGroupId:
+ allOf:
+ - $ref: '#/components/schemas/ClientLoginBannerOptions'
+ - description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
+ ModifyDefaultCreditSpecificationRequest:
+ type: object
+ required:
+ - InstanceFamily
+ - CpuCredits
+ title: ModifyDefaultCreditSpecificationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The credit option for CPU usage of the instance family.
Valid Values: standard | unlimited
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyFleetRequest:
+ type: object
+ required:
+ - FleetId
+ title: ModifyFleetRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/FleetExcessCapacityTerminationPolicy'
+ - description: Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
+ LaunchTemplateConfig:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Reserved.
+ OperationType:
+ type: string
+ enum:
+ - add
+ - remove
+ UserIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: UserId
+ UserGroupStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: UserGroup
+ ModifyFpgaImageAttributeRequest:
+ type: object
+ required:
+ - FpgaImageId
+ title: ModifyFpgaImageAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/OperationType'
+ - description: The operation type.
+ UserId:
+ allOf:
+ - $ref: '#/components/schemas/UserIdStringList'
+ - description: The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.
+ UserGroup:
+ allOf:
+ - $ref: '#/components/schemas/UserGroupStringList'
+ - description: The user groups. This parameter is valid only when modifying the loadPermission attribute.
+ ProductCode:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A name for the AFI.
+ ModifyHostsRequest:
+ type: object
+ required:
+ - HostIds
+ title: ModifyHostsRequest
+ properties:
+ autoPlacement:
+ allOf:
+ - $ref: '#/components/schemas/AutoPlacement'
+ - description: Specify whether to enable or disable auto-placement.
+ hostId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.
If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
' + UnsuccessfulItemList: + type: array + items: + allOf: + - $ref: '#/components/schemas/UnsuccessfulItem' + - xml: + name: item + ModifyIdFormatRequest: + type: object + required: + - Resource + - UseLongIds + title: ModifyIdFormatRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Indicate whether the resource should use longer IDs (17-character IDs). + ModifyIdentityIdFormatRequest: + type: object + required: + - PrincipalArn + - Resource + - UseLongIds + title: ModifyIdentityIdFormatRequest + properties: + principalArn: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specifyall to modify the ID format for all IAM users, IAM roles, and the root user of the account.'
+ resource:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
Attribute parameter is launchPermission.
+ ProductCode:
+ allOf:
+ - $ref: '#/components/schemas/ProductCodeStringList'
+ - description: Not supported.
+ UserGroup:
+ allOf:
+ - $ref: '#/components/schemas/UserGroupStringList'
+ - description: The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
+ UserId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ OrganizationArn:
+ allOf:
+ - $ref: '#/components/schemas/OrganizationArnStringList'
+ - description: The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
+ OrganizationalUnitArn:
+ allOf:
+ - $ref: '#/components/schemas/OrganizationalUnitArnStringList'
+ - description: The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
+ description: Contains the parameters for ModifyImageAttribute.
+ ModifyInstanceAttributeRequest:
+ type: object
+ required:
+ - InstanceId
+ title: ModifyInstanceAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
+ attribute:
+ allOf:
+ - $ref: '#/components/schemas/InstanceAttributeName'
+ - description: The name of the attribute.
+ blockDeviceMapping:
+ allOf:
+ - $ref: '#/components/schemas/InstanceBlockDeviceMappingSpecificationList'
+ - description: 'Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.
' + disableApiTermination: + allOf: + - $ref: '#/components/schemas/AttributeBooleanValue' + - description: 'If the value istrue, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.'
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ebsOptimized:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
+ enaSupport:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: Set to true to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
+ GroupId: + allOf: + - $ref: '#/components/schemas/GroupIdStringList' + - description: '[EC2-VPC] Replaces the security groups of the instance with the specified security groups. You must specify at least one security group, even if it''s just the default security group for the VPC. You must specify the security group ID, not the security group name.' + instanceId: + allOf: + - $ref: '#/components/schemas/InstanceId' + - description: The ID of the instance. + instanceInitiatedShutdownBehavior: + allOf: + - $ref: '#/components/schemas/AttributeValue' + - description: Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). + instanceType: + allOf: + - $ref: '#/components/schemas/AttributeValue' + - description: 'Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned isInvalidInstanceAttributeValue.'
+ kernel:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: 'Changes the instance''s kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.'
+ ramdisk:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: 'Changes the instance''s RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.'
+ sriovNetSupport:
+ allOf:
+ - $ref: '#/components/schemas/AttributeValue'
+ - description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
+ userData: + allOf: + - $ref: '#/components/schemas/BlobAttributeValue' + - description: 'Changes the instance''s user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.' + value: + allOf: + - $ref: '#/components/schemas/String' + - description: 'A new value for the attribute. Use only with thekernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.'
+ ModifyInstanceCapacityReservationAttributesRequest:
+ type: object
+ required:
+ - InstanceId
+ - CapacityReservationSpecification
+ title: ModifyInstanceCapacityReservationAttributesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyInstanceCreditSpecificationRequest:
+ type: object
+ required:
+ - InstanceCreditSpecifications
+ title: ModifyInstanceCreditSpecificationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
+ InstanceCreditSpecification:
+ allOf:
+ - $ref: '#/components/schemas/InstanceCreditSpecificationListRequest'
+ - description: Information about the credit option for CPU usage.
+ SuccessfulInstanceCreditSpecificationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SuccessfulInstanceCreditSpecificationItem'
+ - xml:
+ name: item
+ UnsuccessfulInstanceCreditSpecificationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationItem'
+ - xml:
+ name: item
+ ModifyInstanceEventStartTimeRequest:
+ type: object
+ required:
+ - InstanceId
+ - InstanceEventId
+ - NotBefore
+ title: ModifyInstanceEventStartTimeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The new date and time when the event will take place.
+ ModifyInstanceEventWindowRequest:
+ type: object
+ required:
+ - InstanceEventWindowId
+ title: ModifyInstanceEventWindowRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowId'
+ - description: The ID of the event window.
+ TimeRange:
+ allOf:
+ - $ref: '#/components/schemas/InstanceEventWindowCronExpression'
+ - description: 'The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.
Constraints:
Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
' + ModifyInstanceMaintenanceOptionsRequest: + type: object + required: + - InstanceId + title: ModifyInstanceMaintenanceOptionsRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyInstanceMetadataOptionsRequest:
+ type: object
+ required:
+ - InstanceId
+ title: ModifyInstanceMetadataOptionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/InstanceMetadataTagsState'
+ - description: 'Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.
To remove an instance from a placement group, specify an empty string ("").
' + hostId: + allOf: + - $ref: '#/components/schemas/DedicatedHostId' + - description: The ID of the Dedicated Host with which to associate the instance. + instanceId: + allOf: + - $ref: '#/components/schemas/InstanceId' + - description: The ID of the instance that you are modifying. + tenancy: + allOf: + - $ref: '#/components/schemas/String' + - description: The ARN of the host resource group in which to place the instance. + ModifyIpamPoolRequest: + type: object + required: + - IpamPoolId + title: ModifyIpamPoolRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Clear the default netmask length allocation rule for this pool. + AddAllocationResourceTag: + allOf: + - $ref: '#/components/schemas/RequestIpamResourceTagList' + - description: 'Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.' + RemoveAllocationResourceTag: + allOf: + - $ref: '#/components/schemas/RequestIpamResourceTagList' + - description: Remove tag allocation rules from a pool. + RemoveIpamOperatingRegionSet: + type: array + items: + $ref: '#/components/schemas/RemoveIpamOperatingRegion' + minItems: 0 + maxItems: 50 + ModifyIpamRequest: + type: object + required: + - IpamId + title: ModifyIpamRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The description of the IPAM you want to modify. + AddOperatingRegion: + allOf: + - $ref: '#/components/schemas/AddIpamOperatingRegionSet' + - description: 'Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' + RemoveOperatingRegion: + allOf: + - $ref: '#/components/schemas/RemoveIpamOperatingRegionSet' + - description: The operating Regions to remove. + ModifyIpamResourceCidrRequest: + type: object + required: + - ResourceId + - ResourceCidr + - ResourceRegion + - CurrentIpamScopeId + - Monitored + title: ModifyIpamResourceCidrRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.' + ModifyIpamScopeRequest: + type: object + required: + - IpamScopeId + title: ModifyIpamScopeRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The description of the scope you want to modify. + ModifyLaunchTemplateRequest: + type: object + title: ModifyLaunchTemplateRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/LaunchTemplateName' + - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. + SetDefaultVersion: + allOf: + - $ref: '#/components/schemas/String' + - description: The version number of the launch template to set as the default version. + ModifyManagedPrefixListRequest: + type: object + required: + - PrefixListId + title: ModifyManagedPrefixListRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: A name for the prefix list. + AddEntry: + allOf: + - $ref: '#/components/schemas/AddPrefixListEntries' + - description: One or more entries to add to the prefix list. + RemoveEntry: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.
If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.
' + NetworkInterfaceAttachmentChanges: + type: object + properties: + attachmentId: + allOf: + - $ref: '#/components/schemas/NetworkInterfaceAttachmentId' + - description: The ID of the network interface attachment. + deleteOnTermination: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Indicates whether the network interface is deleted when the instance is terminated. + description: Describes an attachment change. + ModifyNetworkInterfaceAttributeRequest: + type: object + required: + - NetworkInterfaceId + title: ModifyNetworkInterfaceAttributeRequest + properties: + attachment: + allOf: + - $ref: '#/components/schemas/NetworkInterfaceAttachmentChanges' + - description: 'Information about the interface attachment. If modifying the ''delete on termination'' attribute, you must specify the ID of the interface attachment.' + description: + allOf: + - $ref: '#/components/schemas/AttributeValue' + - description: A description for the network interface. + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SecurityGroupId:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupIdStringList'
+ - description: 'Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it''s just the default security group in the VPC. You must specify the ID of the security group, not the name.'
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - description: The ID of the network interface.
+ sourceDestCheck:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
+ description: Contains the parameters for ModifyNetworkInterfaceAttribute.
+ ModifyPrivateDnsNameOptionsRequest:
+ type: object
+ title: ModifyPrivateDnsNameOptionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
+ ReservedInstancesConfigurationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesConfiguration'
+ - xml:
+ name: item
+ ModifyReservedInstancesRequest:
+ type: object
+ required:
+ - ReservedInstancesIds
+ - TargetConfigurations
+ title: ModifyReservedInstancesRequest
+ properties:
+ ReservedInstancesId:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesIdStringList'
+ - description: The IDs of the Reserved Instances to modify.
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
+ ReservedInstancesConfigurationSetItemType:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesConfigurationList'
+ - description: The configuration settings for the Reserved Instances to modify.
+ description: Contains the parameters for ModifyReservedInstances.
+ ModifySecurityGroupRulesRequest:
+ type: object
+ required:
+ - GroupId
+ - SecurityGroupRules
+ title: ModifySecurityGroupRulesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - description: The ID of the security group.
+ SecurityGroupRule:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifySnapshotAttributeRequest:
+ type: object
+ required:
+ - SnapshotId
+ title: ModifySnapshotAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/CreateVolumePermissionModifications'
+ - description: A JSON representation of the snapshot attribute modification.
+ UserGroup:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotId'
+ - description: The ID of the snapshot.
+ UserId:
+ allOf:
+ - $ref: '#/components/schemas/UserIdStringList'
+ - description: The account ID to modify for the snapshot.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifySnapshotTierRequest:
+ type: object
+ required:
+ - SnapshotId
+ title: ModifySnapshotTierRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifySpotFleetRequestRequest:
+ type: object
+ required:
+ - SpotFleetRequestId
+ title: ModifySpotFleetRequestRequest
+ properties:
+ excessCapacityTerminationPolicy:
+ allOf:
+ - $ref: '#/components/schemas/ExcessCapacityTerminationPolicy'
+ - description: Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
+ LaunchTemplateConfig:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateConfigList'
+ - description: 'The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.'
+ spotFleetRequestId:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetRequestId'
+ - description: The ID of the Spot Fleet request.
+ targetCapacity:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Reserved.
+ description: Contains the parameters for ModifySpotFleetRequest.
+ ModifySubnetAttributeRequest:
+ type: object
+ required:
+ - SubnetId
+ title: ModifySubnetAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address.
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/AttributeBooleanValue'
+ - description: ' Specify true to indicate that local network interfaces at the current position should be disabled. '
+ TrafficMirrorNetworkServiceList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorNetworkService'
+ - xml:
+ name: item
+ ModifyTrafficMirrorFilterNetworkServicesRequest:
+ type: object
+ required:
+ - TrafficMirrorFilterId
+ title: ModifyTrafficMirrorFilterNetworkServicesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorFilterId'
+ - description: The ID of the Traffic Mirror filter.
+ AddNetworkService:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorNetworkServiceList'
+ - description: 'The network service, for example Amazon DNS, that you want to mirror.'
+ RemoveNetworkService:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyTrafficMirrorFilterRuleRequest:
+ type: object
+ required:
+ - TrafficMirrorFilterRuleId
+ title: ModifyTrafficMirrorFilterRuleRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description to assign to the Traffic Mirror rule.
+ RemoveField:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyTrafficMirrorSessionRequest:
+ type: object
+ required:
+ - TrafficMirrorSessionId
+ title: ModifyTrafficMirrorSessionRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description to assign to the Traffic Mirror session.
+ RemoveField:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyTransitGatewayOptions:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableId'
+ - description: The ID of the default propagation route table.
+ description: The transit gateway options.
+ ModifyTransitGatewayPrefixListReferenceRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ - PrefixListId
+ title: ModifyTransitGatewayPrefixListReferenceRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyTransitGatewayRequest:
+ type: object
+ required:
+ - TransitGatewayId
+ title: ModifyTransitGatewayRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyTransitGatewayVpcAttachmentRequest:
+ type: object
+ required:
+ - TransitGatewayAttachmentId
+ title: ModifyTransitGatewayVpcAttachmentRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyTransitGatewayVpcAttachmentRequestOptions:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ApplianceModeSupportValue'
+ - description: 'Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.'
+ description: Describes the options for a VPC attachment.
+ ModifyVolumeAttributeRequest:
+ type: object
+ required:
+ - VolumeId
+ title: ModifyVolumeAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VolumeId'
+ - description: The ID of the volume.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyVolumeRequest:
+ type: object
+ required:
+ - VolumeId
+ title: ModifyVolumeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.'
+ VolumeModification:
+ type: object
+ properties:
+ volumeId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the volume.
+ modificationState:
+ allOf:
+ - $ref: '#/components/schemas/VolumeModificationState'
+ - description: The current modification state. The modification state is null for unmodified volumes.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A status message about the modification progress or failure.
+ targetSize:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The target size of the volume, in GiB.'
+ targetIops:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The target IOPS rate of the volume.
+ targetVolumeType:
+ allOf:
+ - $ref: '#/components/schemas/VolumeType'
+ - description: The target EBS volume type of the volume.
+ targetThroughput:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The target throughput of the volume, in MiB/s.'
+ targetMultiAttachEnabled:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The target setting for Amazon EBS Multi-Attach.
+ originalSize:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The original size of the volume, in GiB.'
+ originalIops:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The original IOPS rate of the volume.
+ originalVolumeType:
+ allOf:
+ - $ref: '#/components/schemas/VolumeType'
+ - description: The original EBS volume type of the volume.
+ originalThroughput:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The original throughput of the volume, in MiB/s.'
+ originalMultiAttachEnabled:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: The original setting for Amazon EBS Multi-Attach.
+ progress:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: 'The modification progress, from 0 to 100 percent complete.'
+ startTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The modification start time.
+ endTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The modification completion or failure time.
+ description: 'Describes the modification status of an EBS volume.
If the volume has never been modified, some element values will be null.
' + ModifyVpcAttributeRequest: + type: object + required: + - VpcId + title: ModifyVpcAttributeRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/AttributeBooleanValue' + - description: 'Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
' + vpcId: + allOf: + - $ref: '#/components/schemas/VpcId' + - description: The ID of the VPC. + ModifyVpcEndpointConnectionNotificationRequest: + type: object + required: + - ConnectionNotificationId + title: ModifyVpcEndpointConnectionNotificationRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: 'One or more events for the endpoint. Valid values areAccept, Connect, Delete, and Reject.'
+ VpcEndpointSecurityGroupIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - xml:
+ name: item
+ ModifyVpcEndpointRequest:
+ type: object
+ required:
+ - VpcEndpointId
+ title: ModifyVpcEndpointRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.
+ AddRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointRouteTableIdList'
+ - description: (Gateway endpoint) One or more route tables IDs to associate with the endpoint.
+ RemoveRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointRouteTableIdList'
+ - description: (Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
+ AddSubnetId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointSubnetIdList'
+ - description: '(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.'
+ RemoveSubnetId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointSubnetIdList'
+ - description: (Interface endpoint) One or more subnets IDs in which to remove the endpoint.
+ AddSecurityGroupId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointSecurityGroupIdList'
+ - description: (Interface endpoint) One or more security group IDs to associate with the network interface.
+ RemoveSecurityGroupId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
+ description: Contains the parameters for ModifyVpcEndpoint.
+ ModifyVpcEndpointServiceConfigurationRequest:
+ type: object
+ required:
+ - ServiceId
+ title: ModifyVpcEndpointServiceConfigurationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether requests to create an endpoint to your service must be accepted.
+ AddNetworkLoadBalancerArn:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
+ RemoveNetworkLoadBalancerArn:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
+ AddGatewayLoadBalancerArn:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.
+ RemoveGatewayLoadBalancerArn:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.
+ AddSupportedIpAddressType:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The IP address types to add to your service configuration.
+ RemoveSupportedIpAddressType:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The IP address types to remove from your service configuration.
+ PayerResponsibility:
+ type: string
+ enum:
+ - ServiceOwner
+ ModifyVpcEndpointServicePayerResponsibilityRequest:
+ type: object
+ required:
+ - ServiceId
+ - PayerResponsibility
+ title: ModifyVpcEndpointServicePayerResponsibilityRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/PayerResponsibility'
+ - description: 'The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.'
+ ModifyVpcEndpointServicePermissionsRequest:
+ type: object
+ required:
+ - ServiceId
+ title: ModifyVpcEndpointServicePermissionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.
+ ModifyVpcPeeringConnectionOptionsRequest:
+ type: object
+ required:
+ - VpcPeeringConnectionId
+ title: ModifyVpcPeeringConnectionOptionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnectionId'
+ - description: The ID of the VPC peering connection.
+ PeeringConnectionOptions:
+ type: object
+ properties:
+ allowDnsResolutionFromRemoteVpc:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.'
+ allowEgressFromLocalClassicLinkToRemoteVpc:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If true, enables outbound communication from an EC2-Classic instance that''s linked to a local VPC using ClassicLink to instances in a peer VPC.'
+ allowEgressFromLocalVpcToRemoteClassicLink:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that''s linked to a peer VPC using ClassicLink.'
+ description: Describes the VPC peering connection options.
+ ModifyVpcTenancyRequest:
+ type: object
+ required:
+ - VpcId
+ - InstanceTenancy
+ title: ModifyVpcTenancyRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyVpnConnectionOptionsRequest:
+ type: object
+ required:
+ - VpnConnectionId
+ title: ModifyVpnConnectionOptionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyVpnConnectionRequest:
+ type: object
+ required:
+ - VpnConnectionId
+ title: ModifyVpnConnectionRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyVpnTunnelCertificateRequest:
+ type: object
+ required:
+ - VpnConnectionId
+ - VpnTunnelOutsideIpAddress
+ title: ModifyVpnTunnelCertificateRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyVpnTunnelOptionsRequest:
+ type: object
+ required:
+ - VpnConnectionId
+ - VpnTunnelOutsideIpAddress
+ - TunnelOptions
+ title: ModifyVpnTunnelOptionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ModifyVpnTunnelOptionsSpecification:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ MonitoringState:
+ type: string
+ enum:
+ - disabled
+ - disabling
+ - enabled
+ - pending
+ MoveAddressToVpcRequest:
+ type: object
+ required:
+ - PublicIp
+ title: MoveAddressToVpcRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ publicIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Elastic IP address.
+ Status:
+ type: string
+ enum:
+ - MoveInProgress
+ - InVpc
+ - InClassic
+ MoveByoipCidrToIpamRequest:
+ type: object
+ required:
+ - Cidr
+ - IpamPoolId
+ - IpamPoolOwner
+ title: MoveByoipCidrToIpamRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID of the owner of the IPAM pool.
+ MoveStatus:
+ type: string
+ enum:
+ - movingToVpc
+ - restoringToClassic
+ MovingAddressStatus:
+ type: object
+ properties:
+ moveStatus:
+ allOf:
+ - $ref: '#/components/schemas/MoveStatus'
+ - description: 'The status of the Elastic IP address that''s being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.'
+ publicIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Elastic IP address.
+ description: Describes the status of a moving Elastic IP address.
+ MulticastSupportValue:
+ type: string
+ enum:
+ - enable
+ - disable
+ NatGatewayAddressList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NatGatewayAddress'
+ - xml:
+ name: item
+ ProvisionedBandwidth:
+ type: object
+ properties:
+ provisionTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.'
+ provisioned:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.'
+ requestTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.'
+ requested:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.'
+ status:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.'
+ description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.'
+ NatGatewayState:
+ type: string
+ enum:
+ - pending
+ - failed
+ - available
+ - deleting
+ - deleted
+ NatGatewayAddress:
+ type: object
+ properties:
+ allocationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: '[Public NAT gateway only] The allocation ID of the Elastic IP address that''s associated with the NAT gateway.'
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network interface associated with the NAT gateway.
+ privateIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The private IP address associated with the NAT gateway.
+ publicIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: '[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.'
+ description: Describes the IP addresses and network interface associated with a NAT gateway.
+ NatGatewayIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NatGatewayId'
+ - xml:
+ name: item
+ NetworkAclAssociationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAclAssociation'
+ - xml:
+ name: item
+ NetworkAclEntryList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAclEntry'
+ - xml:
+ name: item
+ NetworkAclAssociation:
+ type: object
+ properties:
+ networkAclAssociationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the association between a network ACL and a subnet.
+ networkAclId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network ACL.
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the subnet.
+ description: Describes an association between a network ACL and a subnet.
+ NetworkAclAssociationId:
+ type: string
+ NetworkAclEntry:
+ type: object
+ properties:
+ cidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IPv4 network range to allow or deny, in CIDR notation.'
+ egress:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
+ icmpTypeCode:
+ allOf:
+ - $ref: '#/components/schemas/IcmpTypeCode'
+ - description: 'ICMP protocol: The ICMP type and code.'
+ ipv6CidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IPv6 network range to allow or deny, in CIDR notation.'
+ portRange:
+ allOf:
+ - $ref: '#/components/schemas/PortRange'
+ - description: 'TCP or UDP protocols: The range of ports the rule applies to.'
+ protocol:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The protocol number. A value of "-1" means all protocols.
+ ruleAction:
+ allOf:
+ - $ref: '#/components/schemas/RuleAction'
+ - description: Indicates whether to allow or deny the traffic that matches the rule.
+ ruleNumber:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The rule number for the entry. ACL entries are processed in ascending order by rule number.
+ description: Describes an entry in a network ACL.
+ NetworkAclIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAclId'
+ - xml:
+ name: item
+ NetworkCardIndex:
+ type: integer
+ NetworkPerformance:
+ type: string
+ NetworkCardInfo:
+ type: object
+ properties:
+ networkCardIndex:
+ allOf:
+ - $ref: '#/components/schemas/NetworkCardIndex'
+ - description: The index of the network card.
+ networkPerformance:
+ allOf:
+ - $ref: '#/components/schemas/NetworkPerformance'
+ - description: The network performance of the network card.
+ maximumNetworkInterfaces:
+ allOf:
+ - $ref: '#/components/schemas/MaxNetworkInterfaces'
+ - description: The maximum number of network interfaces for the network card.
+ description: Describes the network card support of the instance type.
+ NetworkCardInfoList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkCardInfo'
+ - xml:
+ name: item
+ NetworkInsightsAccessScopeAnalysis:
+ type: object
+ properties:
+ networkInsightsAccessScopeAnalysisId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
+ - description: The ID of the Network Access Scope analysis.
+ networkInsightsAccessScopeAnalysisArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The Amazon Resource Name (ARN) of the Network Access Scope analysis.
+ networkInsightsAccessScopeId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
+ - description: The ID of the Network Access Scope.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/AnalysisStatus'
+ - description: The status.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The status message.
+ warningMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The warning message.
+ startDate:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The analysis start date.
+ endDate:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The analysis end date.
+ findingsFound:
+ allOf:
+ - $ref: '#/components/schemas/FindingsFound'
+ - description: Indicates whether there are findings.
+ analyzedEniCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of network interfaces analyzed.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags.
+ description: Describes a Network Access Scope analysis.
+ NetworkInsightsAccessScopeAnalysisIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
+ - xml:
+ name: item
+ NetworkInsightsAnalysis:
+ type: object
+ properties:
+ networkInsightsAnalysisId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAnalysisId'
+ - description: The ID of the network insights analysis.
+ networkInsightsAnalysisArn:
+ allOf:
+ - $ref: '#/components/schemas/ResourceArn'
+ - description: The Amazon Resource Name (ARN) of the network insights analysis.
+ networkInsightsPathId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsPathId'
+ - description: The ID of the path.
+ filterInArnSet:
+ allOf:
+ - $ref: '#/components/schemas/ArnList'
+ - description: The Amazon Resource Names (ARN) of the Amazon Web Services resources that the path must traverse.
+ startDate:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The time the analysis started.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/AnalysisStatus'
+ - description: The status of the network insights analysis.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The status message, if the status is failed.'
+ warningMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The warning message.
+ networkPathFound:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the destination is reachable from the source.
+ forwardPathComponentSet:
+ allOf:
+ - $ref: '#/components/schemas/PathComponentList'
+ - description: The components in the path from source to destination.
+ returnPathComponentSet:
+ allOf:
+ - $ref: '#/components/schemas/PathComponentList'
+ - description: The components in the path from destination to source.
+ explanationSet:
+ allOf:
+ - $ref: '#/components/schemas/ExplanationList'
+ - description: 'The explanations. For more information, see Reachability Analyzer explanation codes.'
+ alternatePathHintSet:
+ allOf:
+ - $ref: '#/components/schemas/AlternatePathHintList'
+ - description: Potential intermediate components.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags.
+ description: Describes a network insights analysis.
+ NetworkInsightsAnalysisIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsAnalysisId'
+ - xml:
+ name: item
+ NetworkInsightsMaxResults:
+ type: integer
+ minimum: 1
+ maximum: 100
+ Protocol:
+ type: string
+ enum:
+ - tcp
+ - udp
+ NetworkInsightsResourceId:
+ type: string
+ NetworkInterfaceAssociation:
+ type: object
+ properties:
+ allocationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The allocation ID.
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The association ID.
+ ipOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Elastic IP address owner.
+ publicDnsName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The public DNS name.
+ publicIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The address of the Elastic IP address bound to the network interface.
+ customerOwnedIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The customer-owned IP address associated with the network interface.
+ carrierIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The carrier IP address associated with the network interface.
This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
+ description: 'Describes association information for an Elastic IP address (IPv4 only), or a Carrier IP address (for a network interface which resides in a subnet in a Wavelength Zone).' + NetworkInterfaceType: + type: string + enum: + - interface + - natGateway + - efa + - trunk + - load_balancer + - network_load_balancer + - vpc_endpoint + - branch + - transit_gateway + - lambda + - quicksight + - global_accelerator_managed + - api_gateway_managed + - gateway_load_balancer + - gateway_load_balancer_endpoint + - iot_rules_managed + - aws_codestar_connections_managed + NetworkInterfaceIpv6AddressesList: + type: array + items: + allOf: + - $ref: '#/components/schemas/NetworkInterfaceIpv6Address' + - xml: + name: item + NetworkInterfacePrivateIpAddressList: + type: array + items: + allOf: + - $ref: '#/components/schemas/NetworkInterfacePrivateIpAddress' + - xml: + name: item + NetworkInterfaceCountRequest: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The maximum number of network interfaces. To specify no maximum limit, omit this parameter.' + description: The minimum and maximum number of network interfaces. + NetworkInterfaceIdList: + type: array + items: + allOf: + - $ref: '#/components/schemas/NetworkInterfaceId' + - xml: + name: item + NetworkInterfaceIpv6Address: + type: object + properties: + ipv6Address: + allOf: + - $ref: '#/components/schemas/String' + - description: The IPv6 address. + description: Describes an IPv6 address associated with a network interface. + NetworkInterfacePermissionState: + type: object + properties: + state: + allOf: + - $ref: '#/components/schemas/NetworkInterfacePermissionStateCode' + - description: The state of the permission. + statusMessage: + allOf: + - $ref: '#/components/schemas/String' + - description: 'A status message, if applicable.' + description: Describes the state of a network interface permission. + NetworkInterfacePermissionStateCode: + type: string + enum: + - pending + - granted + - revoking + - revoked + NetworkInterfacePrivateIpAddress: + type: object + properties: + association: + allOf: + - $ref: '#/components/schemas/NetworkInterfaceAssociation' + - description: The association information for an Elastic IP address (IPv4) associated with the network interface. + primary: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Indicates whether this IPv4 address is the primary private IPv4 address of the network interface. + privateDnsName: + allOf: + - $ref: '#/components/schemas/String' + - description: The private DNS name. + privateIpAddress: + allOf: + - $ref: '#/components/schemas/String' + - description: The private IPv4 address. + description: Describes the private IPv4 address of a network interface. + OccurrenceDayRequestSet: + type: array + items: + allOf: + - $ref: '#/components/schemas/Integer' + - xml: + name: OccurenceDay + OccurrenceDaySet: + type: array + items: + allOf: + - $ref: '#/components/schemas/Integer' + - xml: + name: item + OnDemandOptionsRequest: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The maximum amount per hour for On-Demand Instances that you're willing to pay. + description: Describes the configuration of On-Demand Instances in an EC2 Fleet. + ProtocolList: + type: array + items: + allOf: + - $ref: '#/components/schemas/Protocol' + - xml: + name: item + PacketHeaderStatement: + type: object + properties: + sourceAddressSet: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The source addresses. + destinationAddressSet: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The destination addresses. + sourcePortSet: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The source ports. + destinationPortSet: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The destination ports. + sourcePrefixListSet: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The source prefix lists. + destinationPrefixListSet: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The destination prefix lists. + protocolSet: + allOf: + - $ref: '#/components/schemas/ProtocolList' + - description: The protocols. + description: Describes a packet header statement. + PacketHeaderStatementRequest: + type: object + properties: + SourceAddress: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The source addresses. + DestinationAddress: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The destination addresses. + SourcePort: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The source ports. + DestinationPort: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The destination ports. + SourcePrefixList: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The source prefix lists. + DestinationPrefixList: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The destination prefix lists. + Protocol: + allOf: + - $ref: '#/components/schemas/ProtocolList' + - description: The protocols. + description: Describes a packet header statement. + PartitionLoadFrequency: + type: string + enum: + - none + - daily + - weekly + - monthly + PathComponent: + type: object + properties: + sequenceNumber: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The sequence number. + aclRule: + allOf: + - $ref: '#/components/schemas/AnalysisAclRule' + - description: The network ACL rule. + attachedTo: + allOf: + - $ref: '#/components/schemas/AnalysisComponent' + - description: The resource to which the path component is attached. + component: + allOf: + - $ref: '#/components/schemas/AnalysisComponent' + - description: The component. + destinationVpc: + allOf: + - $ref: '#/components/schemas/AnalysisComponent' + - description: The destination VPC. + outboundHeader: + allOf: + - $ref: '#/components/schemas/AnalysisPacketHeader' + - description: The outbound header. + inboundHeader: + allOf: + - $ref: '#/components/schemas/AnalysisPacketHeader' + - description: The inbound header. + routeTableRoute: + allOf: + - $ref: '#/components/schemas/AnalysisRouteTableRoute' + - description: The route table route. + securityGroupRule: + allOf: + - $ref: '#/components/schemas/AnalysisSecurityGroupRule' + - description: The security group rule. + sourceVpc: + allOf: + - $ref: '#/components/schemas/AnalysisComponent' + - description: The source VPC. + subnet: + allOf: + - $ref: '#/components/schemas/AnalysisComponent' + - description: The subnet. + vpc: + allOf: + - $ref: '#/components/schemas/AnalysisComponent' + - description: The component VPC. + additionalDetailSet: + allOf: + - $ref: '#/components/schemas/AdditionalDetailList' + - description: The additional details. + transitGateway: + $ref: '#/components/schemas/AnalysisComponent' + transitGatewayRouteTableRoute: + allOf: + - $ref: '#/components/schemas/TransitGatewayRouteTableRoute' + - description: The route in a transit gateway route table. + description: Describes a path component. + ResourceStatement: + type: object + properties: + resourceSet: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The resources. + resourceTypeSet: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The resource types. + description: Describes a resource statement. + ResourceStatementRequest: + type: object + properties: + Resource: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The resources. + ResourceType: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The resource types. + description: Describes a resource statement. + PeeringAttachmentStatus: + type: object + properties: + code: + allOf: + - $ref: '#/components/schemas/String' + - description: The status code. + message: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The status message, if applicable.' + description: The status of the transit gateway peering attachment. + PeeringConnectionOptionsRequest: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that''s linked to a peer VPC using ClassicLink.' + description: The VPC peering connection options. + PeeringTgwInfo: + type: object + properties: + transitGatewayId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the transit gateway. + ownerId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the Amazon Web Services account that owns the transit gateway. + region: + allOf: + - $ref: '#/components/schemas/String' + - description: The Region of the transit gateway. + description: Information about the transit gateway in the peering attachment. + Phase1DHGroupNumbersListValue: + type: object + properties: + value: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The Diffie-Hellmann group number. + description: The Diffie-Hellmann group number for phase 1 IKE negotiations. + Phase1DHGroupNumbersList: + type: array + items: + allOf: + - $ref: '#/components/schemas/Phase1DHGroupNumbersListValue' + - xml: + name: item + Phase1DHGroupNumbersRequestListValue: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The Diffie-Hellmann group number. + description: Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations. + Phase1EncryptionAlgorithmsListValue: + type: object + properties: + value: + allOf: + - $ref: '#/components/schemas/String' + - description: The value for the encryption algorithm. + description: The encryption algorithm for phase 1 IKE negotiations. + Phase1EncryptionAlgorithmsList: + type: array + items: + allOf: + - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsListValue' + - xml: + name: item + Phase1EncryptionAlgorithmsRequestListValue: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The value for the encryption algorithm. + description: Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations. + Phase1IntegrityAlgorithmsListValue: + type: object + properties: + value: + allOf: + - $ref: '#/components/schemas/String' + - description: The value for the integrity algorithm. + description: The integrity algorithm for phase 1 IKE negotiations. + Phase1IntegrityAlgorithmsList: + type: array + items: + allOf: + - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsListValue' + - xml: + name: item + Phase1IntegrityAlgorithmsRequestListValue: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The value for the integrity algorithm. + description: Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations. + Phase2DHGroupNumbersListValue: + type: object + properties: + value: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The Diffie-Hellmann group number. + description: The Diffie-Hellmann group number for phase 2 IKE negotiations. + Phase2DHGroupNumbersList: + type: array + items: + allOf: + - $ref: '#/components/schemas/Phase2DHGroupNumbersListValue' + - xml: + name: item + Phase2DHGroupNumbersRequestListValue: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The Diffie-Hellmann group number. + description: Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations. + Phase2EncryptionAlgorithmsListValue: + type: object + properties: + value: + allOf: + - $ref: '#/components/schemas/String' + - description: The encryption algorithm. + description: The encryption algorithm for phase 2 IKE negotiations. + Phase2EncryptionAlgorithmsList: + type: array + items: + allOf: + - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsListValue' + - xml: + name: item + Phase2EncryptionAlgorithmsRequestListValue: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The encryption algorithm. + description: Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations. + Phase2IntegrityAlgorithmsListValue: + type: object + properties: + value: + allOf: + - $ref: '#/components/schemas/String' + - description: The integrity algorithm. + description: The integrity algorithm for phase 2 IKE negotiations. + Phase2IntegrityAlgorithmsList: + type: array + items: + allOf: + - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsListValue' + - xml: + name: item + Phase2IntegrityAlgorithmsRequestListValue: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: The integrity algorithm. + description: Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations. + PlacementGroupState: + type: string + enum: + - pending + - available + - deleting + - deleted + PlacementStrategy: + type: string + enum: + - cluster + - spread + - partition + PlacementGroupStrategyList: + type: array + items: + allOf: + - $ref: '#/components/schemas/PlacementGroupStrategy' + - xml: + name: item + PlacementGroupStrategy: + type: string + enum: + - cluster + - partition + - spread + PoolCidrBlock: + type: object + properties: + poolCidrBlock: + allOf: + - $ref: '#/components/schemas/String' + - description: The CIDR block. + description: Describes a CIDR block for an address pool. + PrefixList: + type: object + properties: + cidrSet: + allOf: + - $ref: '#/components/schemas/ValueStringList' + - description: The IP address range of the Amazon Web Service. + prefixListId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the prefix. + prefixListName: + allOf: + - $ref: '#/components/schemas/String' + - description: The name of the prefix. + description: Describes prefixes for Amazon Web Services services. + PrefixListAssociation: + type: object + properties: + resourceId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the resource. + resourceOwner: + allOf: + - $ref: '#/components/schemas/String' + - description: The owner of the resource. + description: Describes the resource with which a prefix list is associated. + PrefixListEntry: + type: object + properties: + cidr: + allOf: + - $ref: '#/components/schemas/String' + - description: The CIDR block. + description: + allOf: + - $ref: '#/components/schemas/String' + - description: The description. + description: Describes a prefix list entry. + PrefixListId: + type: object + properties: + description: + allOf: + - $ref: '#/components/schemas/String' + - description: 'A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
' + prefixListId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the prefix. + description: Describes a prefix list ID. + PrefixListIdSet: + type: array + items: + allOf: + - $ref: '#/components/schemas/String' + - xml: + name: item + PrefixListMaxResults: + type: integer + minimum: 1 + maximum: 100 + PriceSchedule: + type: object + properties: + active: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
' + currencyCode: + allOf: + - $ref: '#/components/schemas/CurrencyCodeValues' + - description: 'The currency for transacting the Reserved Instance resale. At this time, the only supported currency isUSD.'
+ price:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: The fixed price for the term.
+ term:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: 'The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.'
+ description: Describes the price for a Reserved Instance.
+ PriceScheduleList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PriceSchedule'
+ - xml:
+ name: item
+ PricingDetail:
+ type: object
+ properties:
+ count:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of reservations available for the price.
+ price:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: The price per instance.
+ description: Describes a Reserved Instance offering.
+ PricingDetailsList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PricingDetail'
+ - xml:
+ name: item
+ PrincipalIdFormat:
+ type: object
+ properties:
+ arn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: PrincipalIdFormatARN description
+ statusSet:
+ allOf:
+ - $ref: '#/components/schemas/IdFormatList'
+ - description: PrincipalIdFormatStatuses description
+ description: PrincipalIdFormat description
+ PrivateDnsDetails:
+ type: object
+ properties:
+ privateDnsName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The private DNS name assigned to the VPC endpoint service.
+ description: Information about the Private DNS name for interface endpoints.
+ PrivateDnsDetailsSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PrivateDnsDetails'
+ - xml:
+ name: item
+ PrivateDnsNameConfiguration:
+ type: object
+ properties:
+ state:
+ allOf:
+ - $ref: '#/components/schemas/DnsNameState'
+ - description: The verification state of the VPC endpoint service.
>Consumers of the endpoint service can use the private name only when the state is verified.
value text to the name.
+ description: Information about the private DNS name for the service endpoint.
+ PrivateDnsNameOptionsOnLaunch:
+ type: object
+ properties:
+ hostnameType:
+ allOf:
+ - $ref: '#/components/schemas/HostnameType'
+ - description: 'The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.'
+ enableResourceNameDnsARecord:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
+ enableResourceNameDnsAAAARecord:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
+ description: Describes the options for instance hostnames.
+ PrivateDnsNameOptionsRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
+ description: Describes the options for instance hostnames.
+ ScheduledInstancesPrivateIpAddressConfig:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv4 address.
+ description: Describes a private IPv4 address for a Scheduled Instance.
+ PrivateIpAddressConfigSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ScheduledInstancesPrivateIpAddressConfig'
+ - xml:
+ name: PrivateIpAddressConfigSet
+ ProcessorSustainedClockSpeed:
+ type: number
+ format: double
+ ProductCodeValues:
+ type: string
+ enum:
+ - devpay
+ - marketplace
+ ProductCode:
+ type: object
+ properties:
+ productCode:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The product code.
+ type:
+ allOf:
+ - $ref: '#/components/schemas/ProductCodeValues'
+ - description: The type of product code.
+ description: Describes a product code.
+ PropagatingVgw:
+ type: object
+ properties:
+ gatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the virtual private gateway.
+ description: Describes a virtual private gateway propagating route.
+ PropagatingVgwList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PropagatingVgw'
+ - xml:
+ name: item
+ ProvisionByoipCidrRequest:
+ type: object
+ required:
+ - Cidr
+ title: ProvisionByoipCidrRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ PoolTagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Reserved.
+ ProvisionIpamPoolCidrRequest:
+ type: object
+ required:
+ - IpamPoolId
+ title: ProvisionIpamPoolCidrRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/IpamCidrAuthorizationContext'
+ - description: A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.
+ ProvisionPublicIpv4PoolCidrRequest:
+ type: object
+ required:
+ - IpamPoolId
+ - PoolId
+ - NetmaskLength
+ title: ProvisionPublicIpv4PoolCidrRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The netmask length of the CIDR you would like to allocate to the public IPv4 pool.
+ PublicIpv4PoolRange:
+ type: object
+ properties:
+ firstAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The first IP address in the range.
+ lastAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The last IP address in the range.
+ addressCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of addresses in the range.
+ availableAddressCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of available addresses in the range.
+ description: Describes an address range of an IPv4 address pool.
+ PublicIpv4PoolRangeSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PublicIpv4PoolRange'
+ - xml:
+ name: item
+ PublicIpv4Pool:
+ type: object
+ properties:
+ poolId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the address pool.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the address pool.
+ poolAddressRangeSet:
+ allOf:
+ - $ref: '#/components/schemas/PublicIpv4PoolRangeSet'
+ - description: The address ranges.
+ totalAddressCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The total number of addresses.
+ totalAvailableAddressCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The total number of available addresses.
+ networkBorderGroup:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags for the address pool.
+ description: Describes an IPv4 address pool.
+ PublicIpv4PoolIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Ipv4PoolEc2Id'
+ - xml:
+ name: item
+ Purchase:
+ type: object
+ properties:
+ currencyCode:
+ allOf:
+ - $ref: '#/components/schemas/CurrencyCodeValues'
+ - description: 'The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.'
+ duration:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The duration of the reservation's term in seconds.
+ hostIdSet:
+ allOf:
+ - $ref: '#/components/schemas/ResponseHostIdSet'
+ - description: The IDs of the Dedicated Hosts associated with the reservation.
+ hostReservationId:
+ allOf:
+ - $ref: '#/components/schemas/HostReservationId'
+ - description: The ID of the reservation.
+ hourlyPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The hourly price of the reservation per hour.
+ instanceFamily:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The instance family on the Dedicated Host that the reservation can be associated with.
+ paymentOption:
+ allOf:
+ - $ref: '#/components/schemas/PaymentOption'
+ - description: The payment option for the reservation.
+ upfrontPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The upfront price of the reservation.
+ description: Describes the result of the purchase.
+ PurchaseHostReservationRequest:
+ type: object
+ required:
+ - HostIdSet
+ - OfferingId
+ title: PurchaseHostReservationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/OfferingId'
+ - description: The ID of the offering.
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/TagSpecificationList'
+ - description: The tags to apply to the Dedicated Host Reservation during purchase.
+ PurchaseRequestSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/PurchaseRequest'
+ - xml:
+ name: PurchaseRequest
+ minItems: 1
+ PurchaseReservedInstancesOfferingRequest:
+ type: object
+ required:
+ - InstanceCount
+ - ReservedInstancesOfferingId
+ title: PurchaseReservedInstancesOfferingRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesOfferingId'
+ - description: The ID of the Reserved Instance offering to purchase.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ limitPrice:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ description: Contains the parameters for PurchaseReservedInstancesOffering.
+ PurchaseScheduledInstancesRequest:
+ type: object
+ required:
+ - PurchaseRequests
+ title: PurchaseScheduledInstancesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ PurchaseRequest:
+ allOf:
+ - $ref: '#/components/schemas/PurchaseRequestSet'
+ - description: The purchase requests.
+ description: Contains the parameters for PurchaseScheduledInstances.
+ PurchasedScheduledInstanceSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ScheduledInstance'
+ - xml:
+ name: item
+ ScheduledInstance:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone.
+ createDate:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The date when the Scheduled Instance was purchased.
+ hourlyPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The hourly price for a single instance.
+ instanceCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of instances.
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The instance type.
+ networkPlatform:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The network platform (EC2-Classic or EC2-VPC).
+ nextSlotStartTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time for the next schedule to start.
+ platform:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The platform (Linux/UNIX or Windows).
+ previousSlotEndTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time that the previous schedule ended or will end.
+ recurrence:
+ allOf:
+ - $ref: '#/components/schemas/ScheduledInstanceRecurrence'
+ - description: The schedule recurrence.
+ scheduledInstanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Scheduled Instance ID.
+ slotDurationInHours:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of hours in the schedule.
+ termEndDate:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The end date for the Scheduled Instance.
+ termStartDate:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The start date for the Scheduled Instance.
+ totalScheduledInstanceHours:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The total number of hours for a single instance for the entire term.
+ description: Describes a Scheduled Instance.
+ ReasonCodesList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReportInstanceReasonCodes'
+ - xml:
+ name: item
+ RebootInstancesRequest:
+ type: object
+ required:
+ - InstanceIds
+ title: RebootInstancesRequest
+ properties:
+ InstanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdStringList'
+ - description: The instance IDs.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ RecurringChargeFrequency:
+ type: string
+ enum:
+ - Hourly
+ RecurringCharge:
+ type: object
+ properties:
+ amount:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: The amount of the recurring charge.
+ frequency:
+ allOf:
+ - $ref: '#/components/schemas/RecurringChargeFrequency'
+ - description: The frequency of the recurring charge.
+ description: Describes a recurring charge.
+ RecurringChargesList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/RecurringCharge'
+ - xml:
+ name: item
+ ReferencedSecurityGroup:
+ type: object
+ properties:
+ groupId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the security group.
+ peeringStatus:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The status of a VPC peering connection, if applicable.'
+ userId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ vpcPeeringConnectionId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC peering connection.
+ description: ' Describes the security group that is referenced in the security group rule.'
+ Region:
+ type: object
+ properties:
+ regionEndpoint:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Region service endpoint.
+ regionName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the Region.
+ optInStatus:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Region opt-in status. The possible values are opt-in-not-required, opted-in, and not-opted-in.'
+ description: Describes a Region.
+ RegionNames:
+ type: array
+ items:
+ $ref: '#/components/schemas/String'
+ minItems: 0
+ maxItems: 10
+ StringType:
+ type: string
+ minLength: 0
+ maxLength: 64000
+ RegisterImageRequest:
+ type: object
+ required:
+ - Name
+ title: RegisterImageRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.'
+ architecture:
+ allOf:
+ - $ref: '#/components/schemas/ArchitectureValues'
+ - description: 'The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
The block device mapping entries.
If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can''t specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
' + description: + allOf: + - $ref: '#/components/schemas/String' + - description: A description for your AMI. + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ enaSupport:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
+ kernelId: + allOf: + - $ref: '#/components/schemas/KernelId' + - description: The ID of the kernel. + name: + allOf: + - $ref: '#/components/schemas/String' + - description: 'A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)
' + BillingProduct: + allOf: + - $ref: '#/components/schemas/BillingProductList' + - description: 'The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the Amazon Web Services Marketplace to bill for the use of an AMI.' + ramdiskId: + allOf: + - $ref: '#/components/schemas/RamdiskId' + - description: The ID of the RAM disk. + rootDeviceName: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The device name of the root device volume (for example,/dev/sda1).'
+ sriovNetSupport:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
+ virtualizationType: + allOf: + - $ref: '#/components/schemas/StringType' + - description: 'Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.' + description: Contains the parameters for RegisterImage. + RegisterInstanceTagAttributeRequest: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: Indicates whether to register all tag keys in the current Region. Specifytrue to register all tag keys.
+ InstanceTagKey:
+ allOf:
+ - $ref: '#/components/schemas/InstanceTagKeySet'
+ - description: The tag keys to register.
+ description: Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
+ RegisterInstanceEventNotificationAttributesRequest:
+ type: object
+ title: RegisterInstanceEventNotificationAttributesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/RegisterInstanceTagAttributeRequest'
+ - description: Information about the tag keys to register.
+ RegisterTransitGatewayMulticastGroupMembersRequest:
+ type: object
+ title: RegisterTransitGatewayMulticastGroupMembersRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayMulticastRegisteredGroupMembers:
+ type: object
+ properties:
+ transitGatewayMulticastDomainId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway multicast domain.
+ registeredNetworkInterfaceIds:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The ID of the registered network interfaces.
+ groupIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IP address assigned to the transit gateway multicast group.
+ description: Describes the registered transit gateway multicast group members.
+ RegisterTransitGatewayMulticastGroupSourcesRequest:
+ type: object
+ title: RegisterTransitGatewayMulticastGroupSourcesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayMulticastRegisteredGroupSources:
+ type: object
+ properties:
+ transitGatewayMulticastDomainId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway multicast domain.
+ registeredNetworkInterfaceIds:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The IDs of the network interfaces members registered with the transit gateway multicast group.
+ groupIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IP address assigned to the transit gateway multicast group.
+ description: Describes the members registered with the transit gateway multicast group.
+ RejectTransitGatewayMulticastDomainAssociationsRequest:
+ type: object
+ title: RejectTransitGatewayMulticastDomainAssociationsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ RejectTransitGatewayPeeringAttachmentRequest:
+ type: object
+ required:
+ - TransitGatewayAttachmentId
+ title: RejectTransitGatewayPeeringAttachmentRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ RejectTransitGatewayVpcAttachmentRequest:
+ type: object
+ required:
+ - TransitGatewayAttachmentId
+ title: RejectTransitGatewayVpcAttachmentRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ RejectVpcEndpointConnectionsRequest:
+ type: object
+ required:
+ - ServiceId
+ - VpcEndpointIds
+ title: RejectVpcEndpointConnectionsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointServiceId'
+ - description: The ID of the service.
+ VpcEndpointId:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointIdList'
+ - description: The IDs of one or more VPC endpoints.
+ RejectVpcPeeringConnectionRequest:
+ type: object
+ required:
+ - VpcPeeringConnectionId
+ title: RejectVpcPeeringConnectionRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ vpcPeeringConnectionId:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnectionId'
+ - description: The ID of the VPC peering connection.
+ ReleaseAddressRequest:
+ type: object
+ title: ReleaseAddressRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you receive an InvalidParameterCombination error.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ReleaseHostsRequest:
+ type: object
+ required:
+ - HostIds
+ title: ReleaseHostsRequest
+ properties:
+ hostId:
+ allOf:
+ - $ref: '#/components/schemas/RequestHostIdList'
+ - description: The IDs of the Dedicated Hosts to release.
+ ReleaseIpamPoolAllocationRequest:
+ type: object
+ required:
+ - IpamPoolId
+ - Cidr
+ - IpamPoolAllocationId
+ title: ReleaseIpamPoolAllocationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/IpamPoolAllocationId'
+ - description: The ID of the allocation.
+ RemovePrefixListEntries:
+ type: array
+ items:
+ $ref: '#/components/schemas/RemovePrefixListEntry'
+ minItems: 0
+ maxItems: 100
+ ReplaceIamInstanceProfileAssociationRequest:
+ type: object
+ required:
+ - IamInstanceProfile
+ - AssociationId
+ title: ReplaceIamInstanceProfileAssociationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/IamInstanceProfileAssociationId'
+ - description: The ID of the existing IAM instance profile association.
+ ReplaceNetworkAclAssociationRequest:
+ type: object
+ required:
+ - AssociationId
+ - NetworkAclId
+ title: ReplaceNetworkAclAssociationRequest
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAclAssociationId'
+ - description: The ID of the current association between the original network ACL and the subnet.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ networkAclId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAclId'
+ - description: The ID of the new network ACL to associate with the subnet.
+ ReplaceNetworkAclEntryRequest:
+ type: object
+ required:
+ - Egress
+ - NetworkAclId
+ - Protocol
+ - RuleAction
+ - RuleNumber
+ title: ReplaceNetworkAclEntryRequest
+ properties:
+ cidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).'
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ egress:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
' + Icmp: + allOf: + - $ref: '#/components/schemas/IcmpTypeCode' + - description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.' + ipv6CidrBlock: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The IPv6 network range to allow or deny, in CIDR notation (for example2001:bd8:1234:1a00::/64).'
+ networkAclId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkAclId'
+ - description: The ID of the ACL.
+ portRange:
+ allOf:
+ - $ref: '#/components/schemas/PortRange'
+ - description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).'
+ protocol:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.'
+ ruleAction:
+ allOf:
+ - $ref: '#/components/schemas/RuleAction'
+ - description: Indicates whether to allow or deny the traffic that matches the rule.
+ ruleNumber:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The rule number of the entry to replace.
+ ReplaceRootVolumeTaskState:
+ type: string
+ enum:
+ - pending
+ - in-progress
+ - failing
+ - succeeded
+ - failed
+ - failed-detached
+ ReplaceRouteRequest:
+ type: object
+ required:
+ - RouteTableId
+ title: ReplaceRouteRequest
+ properties:
+ destinationCidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
+ destinationIpv6CidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListResourceId'
+ - description: The ID of the prefix list for the route.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointId'
+ - description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
+ egressOnlyInternetGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
+ - description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
+ gatewayId:
+ allOf:
+ - $ref: '#/components/schemas/RouteGatewayId'
+ - description: The ID of an internet gateway or virtual private gateway.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Specifies whether to reset the local route to its default target (local).
+ natGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/CarrierGatewayId'
+ - description: '[IPv4 traffic only] The ID of a carrier gateway.'
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - description: The ID of a network interface.
+ routeTableId:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableId'
+ - description: The ID of the route table.
+ vpcPeeringConnectionId:
+ allOf:
+ - $ref: '#/components/schemas/CoreNetworkArn'
+ - description: The Amazon Resource Name (ARN) of the core network.
+ ReplaceRouteTableAssociationRequest:
+ type: object
+ required:
+ - AssociationId
+ - RouteTableId
+ title: ReplaceRouteTableAssociationRequest
+ properties:
+ associationId:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableAssociationId'
+ - description: The association ID.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ routeTableId:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableId'
+ - description: The ID of the new route table to associate with the subnet.
+ ReplaceTransitGatewayRouteRequest:
+ type: object
+ required:
+ - DestinationCidrBlock
+ - TransitGatewayRouteTableId
+ title: ReplaceTransitGatewayRouteRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ReplacementStrategy:
+ type: string
+ enum:
+ - launch
+ - launch-before-terminate
+ ReportStatusType:
+ type: string
+ enum:
+ - ok
+ - impaired
+ ReportInstanceStatusRequest:
+ type: object
+ required:
+ - Instances
+ - ReasonCodes
+ - Status
+ title: ReportInstanceStatusRequest
+ properties:
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Descriptive text about the health state of your instance.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ endTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time at which the reported instance health state ended.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdStringList'
+ - description: The instances.
+ reasonCode:
+ allOf:
+ - $ref: '#/components/schemas/ReasonCodesList'
+ - description: 'The reason codes that describe the health state of your instance.
instance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems that I believe are network related.
performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.
If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.'
+ spotMaintenanceStrategies:
+ allOf:
+ - $ref: '#/components/schemas/SpotMaintenanceStrategies'
+ - description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.'
+ excessCapacityTerminationPolicy:
+ allOf:
+ - $ref: '#/components/schemas/ExcessCapacityTerminationPolicy'
+ - description: Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
+ fulfilledCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
+ onDemandFulfilledCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
+ iamFleetRole:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.'
+ launchSpecifications:
+ allOf:
+ - $ref: '#/components/schemas/LaunchSpecsList'
+ - description: 'The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can''t specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.'
+ launchTemplateConfigs:
+ allOf:
+ - $ref: '#/components/schemas/LaunchTemplateConfigList'
+ - description: 'The launch template and overrides. If you specify LaunchTemplateConfigs, you can''t specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.'
+ spotPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
+ targetCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.'
+ onDemandTargetCapacity:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.'
+ onDemandMaxTotalPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The maximum amount per hour for On-Demand Instances that you''re willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.'
+ spotMaxTotalPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The maximum amount per hour for Spot Instances that you''re willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.'
+ terminateInstancesWithExpiration:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
+ type:
+ allOf:
+ - $ref: '#/components/schemas/FleetType'
+ - description: 'The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.'
+ validFrom:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.'
+ validUntil:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.'
+ replaceUnhealthyInstances:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether Spot Fleet should replace unhealthy instances.
+ instanceInterruptionBehavior:
+ allOf:
+ - $ref: '#/components/schemas/InstanceInterruptionBehavior'
+ - description: The behavior when a Spot Instance is interrupted. The default is terminate.
+ loadBalancersConfig:
+ allOf:
+ - $ref: '#/components/schemas/LoadBalancersConfig'
+ - description: 'One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
' + instancePoolsToUseCount: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
' + context: + allOf: + - $ref: '#/components/schemas/String' + - description: Reserved. + targetCapacityUnitType: + allOf: + - $ref: '#/components/schemas/TargetCapacityUnitType' + - description: 'The unit for the target capacity.
Default: units (translates to number of instances)
ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.'
+ description: Describes the configuration of a Spot Fleet request.
+ RequestSpotFleetRequest:
+ type: object
+ required:
+ - SpotFleetRequestConfig
+ title: RequestSpotFleetRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ spotFleetRequestConfig:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetRequestConfigData'
+ - description: The configuration for the Spot Fleet request.
+ description: Contains the parameters for RequestSpotFleet.
+ RequestSpotLaunchSpecification:
+ type: object
+ properties:
+ SecurityGroupId:
+ allOf:
+ - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupIdList'
+ - description: One or more security group IDs.
+ SecurityGroup:
+ allOf:
+ - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupList'
+ - description: 'One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.'
+ addressingType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Deprecated.
+ blockDeviceMapping:
+ allOf:
+ - $ref: '#/components/schemas/BlockDeviceMappingList'
+ - description: 'One or more block device mapping entries. You can''t specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.'
+ ebsOptimized:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Indicates whether basic or detailed monitoring is enabled for the instance.
Default: Disabled
' + NetworkInterface: + allOf: + - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecificationList' + - description: 'One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.' + placement: + allOf: + - $ref: '#/components/schemas/SpotPlacement' + - description: The placement information for the instance. + ramdiskId: + allOf: + - $ref: '#/components/schemas/RamdiskId' + - description: The ID of the RAM disk. + subnetId: + allOf: + - $ref: '#/components/schemas/SubnetId' + - description: The ID of the subnet in which to launch the instance. + userData: + allOf: + - $ref: '#/components/schemas/String' + - description: The Base64-encoded user data for the instance. User data is limited to 16 KB. + description: Describes the launch specification for an instance. + RequestSpotInstancesRequest: + type: object + title: RequestSpotInstancesRequest + properties: + availabilityZoneGroup: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
' + blockDurationMinutes: + allOf: + - $ref: '#/components/schemas/Integer' + - description: Deprecated. + clientToken: + allOf: + - $ref: '#/components/schemas/String' + - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ instanceCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The maximum number of Spot Instances to launch.
Default: 1
' + launchGroup: + allOf: + - $ref: '#/components/schemas/RequestSpotLaunchSpecification' + - description: The launch specification. + spotPrice: + allOf: + - $ref: '#/components/schemas/String' + - description: The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. + type: + allOf: + - $ref: '#/components/schemas/SpotInstanceType' + - description: 'The Spot Instance request type.
Default: one-time
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.
' + validUntil: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: 'The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
terminate.
+ description: Contains the parameters for RequestSpotInstances.
+ ReservationFleetInstanceSpecificationList:
+ type: array
+ items:
+ $ref: '#/components/schemas/ReservationFleetInstanceSpecification'
+ ReservedInstanceLimitPrice:
+ type: object
+ properties:
+ amount:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
+ currencyCode:
+ allOf:
+ - $ref: '#/components/schemas/CurrencyCodeValues'
+ - description: 'The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.'
+ description: Describes the limit price of a Reserved Instance offering.
+ ReservedInstanceReservationValue:
+ type: object
+ properties:
+ reservationValue:
+ allOf:
+ - $ref: '#/components/schemas/ReservationValue'
+ - description: The total value of the Convertible Reserved Instance that you are exchanging.
+ reservedInstanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Convertible Reserved Instance that you are exchanging.
+ description: The total value of the Convertible Reserved Instance.
+ ReservedInstanceState:
+ type: string
+ enum:
+ - payment-pending
+ - active
+ - payment-failed
+ - retired
+ - queued
+ - queued-deleted
+ scope:
+ type: string
+ enum:
+ - Availability Zone
+ - Region
+ ReservedInstances:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone in which the Reserved Instance can be used.
+ duration:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: 'The duration of the Reserved Instance, in seconds.'
+ end:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time when the Reserved Instance expires.
+ fixedPrice:
+ allOf:
+ - $ref: '#/components/schemas/Float'
+ - description: The purchase price of the Reserved Instance.
+ instanceCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of reservations purchased.
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/InstanceType'
+ - description: The instance type on which the Reserved Instance can be used.
+ productDescription:
+ allOf:
+ - $ref: '#/components/schemas/RIProductDescription'
+ - description: The Reserved Instance product platform description.
+ reservedInstancesId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Reserved Instance.
+ start:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The date and time the Reserved Instance started.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstanceState'
+ - description: The state of the Reserved Instance purchase.
+ usagePrice:
+ allOf:
+ - $ref: '#/components/schemas/Float'
+ - description: 'The usage price of the Reserved Instance, per hour.'
+ currencyCode:
+ allOf:
+ - $ref: '#/components/schemas/CurrencyCodeValues'
+ - description: 'The currency of the Reserved Instance. It''s specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.'
+ instanceTenancy:
+ allOf:
+ - $ref: '#/components/schemas/Tenancy'
+ - description: The tenancy of the instance.
+ offeringClass:
+ allOf:
+ - $ref: '#/components/schemas/OfferingClassType'
+ - description: The offering class of the Reserved Instance.
+ offeringType:
+ allOf:
+ - $ref: '#/components/schemas/OfferingTypeValues'
+ - description: The Reserved Instance offering type.
+ recurringCharges:
+ allOf:
+ - $ref: '#/components/schemas/RecurringChargesList'
+ - description: The recurring charge tag assigned to the resource.
+ scope:
+ allOf:
+ - $ref: '#/components/schemas/scope'
+ - description: The scope of the Reserved Instance.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the resource.
+ description: Describes a Reserved Instance.
+ ReservedInstancesId:
+ type: object
+ properties:
+ reservedInstancesId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Reserved Instance.
+ description: Describes the ID of a Reserved Instance.
+ ReservedInstancesListing:
+ type: object
+ properties:
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.'
+ createDate:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time the listing was created.
+ instanceCounts:
+ allOf:
+ - $ref: '#/components/schemas/InstanceCountList'
+ - description: The number of instances in this state.
+ priceSchedules:
+ allOf:
+ - $ref: '#/components/schemas/PriceScheduleList'
+ - description: The price of the Reserved Instance listing.
+ reservedInstancesId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Reserved Instance.
+ reservedInstancesListingId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Reserved Instance listing.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/ListingStatus'
+ - description: The status of the Reserved Instance listing.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The reason for the current status of the Reserved Instance listing. The response can be blank.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the resource.
+ updateDate:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The last modified timestamp of the listing.
+ description: Describes a Reserved Instance listing.
+ ReservedInstancesModificationResultList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesModificationResult'
+ - xml:
+ name: item
+ ReservedIntancesIds:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesId'
+ - xml:
+ name: item
+ ReservedInstancesModification:
+ type: object
+ properties:
+ clientToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.'
+ createDate:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time when the modification request was created.
+ effectiveDate:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time for the modification to become effective.
+ modificationResultSet:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesModificationResultList'
+ - description: Contains target configurations along with their corresponding new Reserved Instance IDs.
+ reservedInstancesSet:
+ allOf:
+ - $ref: '#/components/schemas/ReservedIntancesIds'
+ - description: The IDs of one or more Reserved Instances.
+ reservedInstancesModificationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A unique ID for the Reserved Instance modification.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The status of the Reserved Instances modification request.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The reason for the status.
+ updateDate:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time when the modification request was last updated.
+ description: Describes a Reserved Instance modification.
+ ReservedInstancesModificationResult:
+ type: object
+ properties:
+ reservedInstancesId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
+ targetConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/ReservedInstancesConfiguration'
+ - description: The target Reserved Instances configurations supplied as part of the modification request.
+ description: Describes the modification request/s.
+ ReservedInstancesOffering:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone in which the Reserved Instance can be used.
+ duration:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: 'The duration of the Reserved Instance, in seconds.'
+ fixedPrice:
+ allOf:
+ - $ref: '#/components/schemas/Float'
+ - description: The purchase price of the Reserved Instance.
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/InstanceType'
+ - description: The instance type on which the Reserved Instance can be used.
+ productDescription:
+ allOf:
+ - $ref: '#/components/schemas/RIProductDescription'
+ - description: The Reserved Instance product platform description.
+ reservedInstancesOfferingId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
+ usagePrice:
+ allOf:
+ - $ref: '#/components/schemas/Float'
+ - description: 'The usage price of the Reserved Instance, per hour.'
+ currencyCode:
+ allOf:
+ - $ref: '#/components/schemas/CurrencyCodeValues'
+ - description: 'The currency of the Reserved Instance offering you are purchasing. It''s specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.'
+ instanceTenancy:
+ allOf:
+ - $ref: '#/components/schemas/Tenancy'
+ - description: The tenancy of the instance.
+ marketplace:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it''s a Reserved Instance Marketplace offering, this is true.'
+ offeringClass:
+ allOf:
+ - $ref: '#/components/schemas/OfferingClassType'
+ - description: 'If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, it is not possible to perform an exchange.'
+ offeringType:
+ allOf:
+ - $ref: '#/components/schemas/OfferingTypeValues'
+ - description: The Reserved Instance offering type.
+ pricingDetailsSet:
+ allOf:
+ - $ref: '#/components/schemas/PricingDetailsList'
+ - description: The pricing details of the Reserved Instance offering.
+ recurringCharges:
+ allOf:
+ - $ref: '#/components/schemas/RecurringChargesList'
+ - description: The recurring charge tag assigned to the resource.
+ scope:
+ allOf:
+ - $ref: '#/components/schemas/scope'
+ - description: Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
+ description: Describes a Reserved Instance offering.
+ ResetAddressAttributeRequest:
+ type: object
+ required:
+ - AllocationId
+ - Attribute
+ title: ResetAddressAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ResetEbsDefaultKmsKeyIdRequest:
+ type: object
+ title: ResetEbsDefaultKmsKeyIdRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ResetFpgaImageAttributeName:
+ type: string
+ enum:
+ - loadPermission
+ ResetFpgaImageAttributeRequest:
+ type: object
+ required:
+ - FpgaImageId
+ title: ResetFpgaImageAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ResetFpgaImageAttributeName'
+ - description: The attribute.
+ ResetImageAttributeName:
+ type: string
+ enum:
+ - launchPermission
+ ResetImageAttributeRequest:
+ type: object
+ required:
+ - Attribute
+ - ImageId
+ title: ResetImageAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ImageId'
+ - description: The ID of the AMI.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ description: Contains the parameters for ResetImageAttribute.
+ ResetInstanceAttributeRequest:
+ type: object
+ required:
+ - Attribute
+ - InstanceId
+ title: ResetInstanceAttributeRequest
+ properties:
+ attribute:
+ allOf:
+ - $ref: '#/components/schemas/InstanceAttributeName'
+ - description: 'The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: The ID of the instance.
+ ResetNetworkInterfaceAttributeRequest:
+ type: object
+ required:
+ - NetworkInterfaceId
+ title: ResetNetworkInterfaceAttributeRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - description: The ID of the network interface.
+ sourceDestCheck:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The source/destination checking attribute. Resets the value to true.
+ description: Contains the parameters for ResetNetworkInterfaceAttribute.
+ ResetSnapshotAttributeRequest:
+ type: object
+ required:
+ - Attribute
+ - SnapshotId
+ title: ResetSnapshotAttributeRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/SnapshotId'
+ - description: The ID of the snapshot.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ResourceList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ RestoreAddressToClassicRequest:
+ type: object
+ required:
+ - PublicIp
+ title: RestoreAddressToClassicRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ publicIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Elastic IP address.
+ RestoreImageFromRecycleBinRequest:
+ type: object
+ required:
+ - ImageId
+ title: RestoreImageFromRecycleBinRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ RestoreManagedPrefixListVersionRequest:
+ type: object
+ required:
+ - PrefixListId
+ - PreviousVersion
+ - CurrentVersion
+ title: RestoreManagedPrefixListVersionRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: The current version number for the prefix list.
+ RestoreSnapshotFromRecycleBinRequest:
+ type: object
+ required:
+ - SnapshotId
+ title: RestoreSnapshotFromRecycleBinRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SnapshotState:
+ type: string
+ enum:
+ - pending
+ - completed
+ - error
+ - recoverable
+ - recovering
+ RestoreSnapshotTierRequest:
+ type: object
+ required:
+ - SnapshotId
+ title: RestoreSnapshotTierRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ RestoreSnapshotTierRequestTemporaryRestoreDays:
+ type: integer
+ ResultRange:
+ type: integer
+ minimum: 20
+ maximum: 500
+ RevokeClientVpnIngressRequest:
+ type: object
+ required:
+ - ClientVpnEndpointId
+ - TargetNetworkCidr
+ title: RevokeClientVpnIngressRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SecurityGroupRuleIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: item
+ RevokeSecurityGroupEgressRequest:
+ type: object
+ required:
+ - GroupId
+ title: RevokeSecurityGroupEgressRequest
+ properties:
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ groupId:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - description: The ID of the security group.
+ ipPermissions:
+ allOf:
+ - $ref: '#/components/schemas/IpPermissionList'
+ - description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
+ SecurityGroupRuleId:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRuleIdList'
+ - description: The IDs of the security group rules.
+ cidrIp:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Not supported. Use a set of IP permissions to specify the CIDR.
+ fromPort:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: Not supported. Use a set of IP permissions to specify the port.
+ ipProtocol:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Not supported. Use a set of IP permissions to specify the protocol name or number.
+ toPort:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: Not supported. Use a set of IP permissions to specify the port.
+ sourceSecurityGroupName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Not supported. Use a set of IP permissions to specify a destination security group.
+ sourceSecurityGroupOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Not supported. Use a set of IP permissions to specify a destination security group.
+ RevokeSecurityGroupIngressRequest:
+ type: object
+ title: RevokeSecurityGroupIngressRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.'
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SecurityGroupRuleId:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRuleIdList'
+ - description: The IDs of the security group rules.
+ RootDeviceType:
+ type: string
+ enum:
+ - ebs
+ - instance-store
+ RouteOrigin:
+ type: string
+ enum:
+ - CreateRouteTable
+ - CreateRoute
+ - EnableVgwRoutePropagation
+ RouteState:
+ type: string
+ enum:
+ - active
+ - blackhole
+ Route:
+ type: object
+ properties:
+ destinationCidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv4 CIDR block used for the destination match.
+ destinationIpv6CidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 CIDR block used for the destination match.
+ destinationPrefixListId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The prefix of the Amazon Web Service.
+ egressOnlyInternetGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the egress-only internet gateway.
+ gatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of a gateway attached to your VPC.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of a NAT instance in your VPC.
+ instanceOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of Amazon Web Services account that owns the instance.
+ natGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of a NAT gateway.
+ transitGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of a transit gateway.
+ localGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the local gateway.
+ carrierGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/CarrierGatewayId'
+ - description: The ID of the carrier gateway.
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the network interface.
+ origin:
+ allOf:
+ - $ref: '#/components/schemas/RouteOrigin'
+ - description: Describes how the route was created.
CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.
blackhole state indicates that the route''s target isn''t available (for example, the specified gateway isn''t attached to the VPC, or the specified NAT instance has been terminated).'
+ vpcPeeringConnectionId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of a VPC peering connection.
+ coreNetworkArn:
+ allOf:
+ - $ref: '#/components/schemas/CoreNetworkArn'
+ - description: The Amazon Resource Name (ARN) of the core network.
+ description: Describes a route in a route table.
+ RouteList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/Route'
+ - xml:
+ name: item
+ RouteTableAssociationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableAssociation'
+ - xml:
+ name: item
+ RouteTableAssociation:
+ type: object
+ properties:
+ main:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether this is the main route table.
+ routeTableAssociationId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the association.
+ routeTableId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the route table.
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the subnet. A subnet ID is not returned for an implicit association.
+ gatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the internet gateway or virtual private gateway.
+ associationState:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableAssociationState'
+ - description: The state of the association.
+ description: Describes an association between a route table and a subnet or gateway.
+ RouteTableAssociationStateCode:
+ type: string
+ enum:
+ - associating
+ - associated
+ - disassociating
+ - disassociated
+ - failed
+ RouteTableIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/RouteTableId'
+ - xml:
+ name: item
+ RunInstancesUserData:
+ type: string
+ format: password
+ RunInstancesRequest:
+ type: object
+ required:
+ - MaxCount
+ - MinCount
+ title: RunInstancesRequest
+ properties:
+ BlockDeviceMapping:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: '[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you''ve specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
' + Ipv6Address: + allOf: + - $ref: '#/components/schemas/RamdiskId' + - description: 'The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface.
' + SecurityGroup: + allOf: + - $ref: '#/components/schemas/RunInstancesUserData' + - description: 'The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.' + additionalInfo: + allOf: + - $ref: '#/components/schemas/String' + - description: Reserved. + clientToken: + allOf: + - $ref: '#/components/schemas/String' + - description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
' + disableApiTermination: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'If you set this parameter to true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ebsOptimized:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
+ TagSpecification: + allOf: + - $ref: '#/components/schemas/HibernationOptionsRequest' + - description: 'Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
You can''t enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
' + LicenseSpecification: + allOf: + - $ref: '#/components/schemas/InstanceMaintenanceOptionsRequest' + - description: The maintenance and recovery options for the instance. + RunScheduledInstancesRequest: + type: object + required: + - LaunchSpecification + - ScheduledInstanceId + title: RunScheduledInstancesRequest + properties: + undefined: + allOf: + - $ref: '#/components/schemas/ScheduledInstanceId' + - description: The Scheduled Instance ID. + description: Contains the parameters for RunScheduledInstances. + S3ObjectTagList: + type: array + items: + allOf: + - $ref: '#/components/schemas/S3ObjectTag' + - xml: + name: item + ScheduledInstanceRecurrence: + type: object + properties: + frequency: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The frequency (Daily, Weekly, or Monthly).'
+ interval:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.'
+ occurrenceDaySet:
+ allOf:
+ - $ref: '#/components/schemas/OccurrenceDaySet'
+ - description: 'The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).'
+ occurrenceRelativeToEnd:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the occurrence is relative to the end of the specified week or month.
+ occurrenceUnit:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).
+ description: Describes the recurring schedule for a Scheduled Instance.
+ ScheduledInstanceAvailability:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone.
+ availableInstanceCount:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of available instances.
+ firstSlotStartTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The time period for the first schedule to start.
+ hourlyPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The hourly price for a single instance.
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The instance type. You can specify one of the C3, C4, M4, or R3 instance types.'
+ maxTermDurationInDays:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The maximum term. The only possible value is 365 days.
+ minTermDurationInDays:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The minimum term. The only possible value is 365 days.
+ networkPlatform:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The network platform (EC2-Classic or EC2-VPC).
+ platform:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The platform (Linux/UNIX or Windows).
+ purchaseToken:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The purchase token. This token expires in two hours.
+ recurrence:
+ allOf:
+ - $ref: '#/components/schemas/ScheduledInstanceRecurrence'
+ - description: The schedule recurrence.
+ slotDurationInHours:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of hours in the schedule.
+ totalScheduledInstanceHours:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The total number of hours for a single instance for the entire term.
+ description: Describes a schedule that is available for your Scheduled Instances.
+ ScheduledInstanceIdRequestSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ScheduledInstanceId'
+ - xml:
+ name: ScheduledInstanceId
+ ScheduledInstancesBlockDeviceMapping:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
' + description: Describes a block device mapping for a Scheduled Instance. + ScheduledInstancesBlockDeviceMappingSet: + type: array + items: + allOf: + - $ref: '#/components/schemas/ScheduledInstancesBlockDeviceMapping' + - xml: + name: BlockDeviceMapping + ScheduledInstancesEbs: + type: object + properties: + undefined: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The volume type. gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.
Default: gp2
Describes the launch specification for a Scheduled Instance.
If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ SearchTransitGatewayMulticastGroupsRequest:
+ type: object
+ title: SearchTransitGatewayMulticastGroupsRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
+ - description: The ID of the transit gateway multicast domain.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayMulticastGroupList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulticastGroup'
+ - xml:
+ name: item
+ SearchTransitGatewayRoutesRequest:
+ type: object
+ required:
+ - TransitGatewayRouteTableId
+ - Filters
+ title: SearchTransitGatewayRoutesRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteTableId'
+ - description: The ID of the transit gateway route table.
+ Filter:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TransitGatewayRouteList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRoute'
+ - xml:
+ name: item
+ SecurityGroup:
+ type: object
+ properties:
+ groupDescription:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the security group.
+ groupName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the security group.
+ ipPermissions:
+ allOf:
+ - $ref: '#/components/schemas/IpPermissionList'
+ - description: The inbound rules associated with the security group.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID of the owner of the security group.
+ groupId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the security group.
+ ipPermissionsEgress:
+ allOf:
+ - $ref: '#/components/schemas/IpPermissionList'
+ - description: '[VPC only] The outbound rules associated with the security group.'
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the security group.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: '[VPC only] The ID of the VPC for the security group.'
+ description: Describes a security group.
+ SecurityGroupReference:
+ type: object
+ properties:
+ groupId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of your security group.
+ referencingVpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC with the referencing security group.
+ vpcPeeringConnectionId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC peering connection.
+ description: Describes a VPC with a security group that references your security group.
+ SecurityGroupRuleId:
+ type: string
+ SecurityGroupRule:
+ type: object
+ properties:
+ securityGroupRuleId:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRuleId'
+ - description: The ID of the security group rule.
+ groupId:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupId'
+ - description: The ID of the security group.
+ groupOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The ID of the Amazon Web Services account that owns the security group. '
+ isEgress:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the security group rule is an outbound rule.
+ ipProtocol:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
-1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes. '
+ cidrIpv4:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv4 CIDR range.
+ cidrIpv6:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 CIDR range.
+ prefixListId:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListResourceId'
+ - description: The ID of the prefix list.
+ referencedGroupInfo:
+ allOf:
+ - $ref: '#/components/schemas/ReferencedSecurityGroup'
+ - description: Describes the security group that is referenced in the rule.
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The security group rule description.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags applied to the security group rule.
+ description: Describes a security group rule.
+ SecurityGroupRuleDescriptionList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRuleDescription'
+ - xml:
+ name: item
+ SecurityGroupRuleRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the security group rule.
+ description: 'Describes a security group rule.
You must specify exactly one of the following parameters, based on the rule type:
CidrIpv4
CidrIpv6
PrefixListId
ReferencedGroupId
When you modify a rule, you cannot change the rule type. For example, if the rule uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 address range.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ServiceTypeDetailSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ServiceTypeDetail'
+ - xml:
+ name: item
+ ServiceState:
+ type: string
+ enum:
+ - Pending
+ - Available
+ - Deleting
+ - Deleted
+ - Failed
+ SupportedIpAddressTypes:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ServiceConnectivityType'
+ - xml:
+ name: item
+ minItems: 0
+ maxItems: 2
+ ServiceConnectivityType:
+ type: string
+ enum:
+ - ipv4
+ - ipv6
+ ServiceDetail:
+ type: object
+ properties:
+ serviceName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the service.
+ serviceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the endpoint service.
+ serviceType:
+ allOf:
+ - $ref: '#/components/schemas/ServiceTypeDetailSet'
+ - description: The type of service.
+ availabilityZoneSet:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The Availability Zones in which the service is available.
+ owner:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Web Services account ID of the service owner.
+ baseEndpointDnsNameSet:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The DNS names for the service.
+ privateDnsName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The private DNS name for the service.
+ privateDnsNameSet:
+ allOf:
+ - $ref: '#/components/schemas/PrivateDnsDetailsSet'
+ - description: 'The private DNS names assigned to the VPC endpoint service. '
+ vpcEndpointPolicySupported:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the service supports endpoint policies.
+ acceptanceRequired:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
+ managesVpcEndpoints:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
+ payerResponsibility:
+ allOf:
+ - $ref: '#/components/schemas/PayerResponsibility'
+ - description: The payer responsibility.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the service.
+ privateDnsNameVerificationState:
+ allOf:
+ - $ref: '#/components/schemas/DnsNameState'
+ - description: The verification state of the VPC endpoint service.
Consumers of the endpoint service cannot use the private name when the state is not verified.
standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
+ lastTieringStartTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The date and time when the last archive or restore process was started.
+ lastTieringProgress:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The progress of the last archive or restore process, as a percentage.'
+ lastTieringOperationStatus:
+ allOf:
+ - $ref: '#/components/schemas/TieringOperationStatus'
+ - description: The status of the last archive or restore process.
+ lastTieringOperationStatusDetail:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A message describing the status of the last archive or restore process.
+ archivalCompleteTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The date and time when the last archive process was completed.
+ restoreExpiryTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
+ description: Provides information about a snapshot's storage tier.
+ SpotAllocationStrategy:
+ type: string
+ enum:
+ - lowest-price
+ - diversified
+ - capacity-optimized
+ - capacity-optimized-prioritized
+ SpotCapacityRebalance:
+ type: object
+ properties:
+ replacementStrategy:
+ allOf:
+ - $ref: '#/components/schemas/ReplacementStrategy'
+ - description: 'The replacement strategy to use. Only available for fleets of type maintain.
launch - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay), terminates the instances that received a rebalance notification.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
Enables monitoring for the instance.
Default: false
error. After all requests are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating.'
+ createTime:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The creation date and time of the request.
+ spotFleetRequestConfig:
+ allOf:
+ - $ref: '#/components/schemas/SpotFleetRequestConfigData'
+ - description: The configuration of the Spot Fleet request.
+ spotFleetRequestId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Spot Fleet request.
+ spotFleetRequestState:
+ allOf:
+ - $ref: '#/components/schemas/BatchState'
+ - description: The state of the Spot Fleet request.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for a Spot Fleet resource.
+ description: Describes a Spot Fleet request.
+ SpotFleetTagSpecification:
+ type: object
+ properties:
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/ResourceType'
+ - description: 'The type of resource. Currently, the only resource type that is supported is instance. To tag the Spot Fleet request on creation, use the TagSpecifications parameter in SpotFleetRequestConfigData .'
+ tag:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags.
+ description: The tags for a Spot Fleet resource.
+ SpotInstanceInterruptionBehavior:
+ type: string
+ enum:
+ - hibernate
+ - stop
+ - terminate
+ SpotInstanceState:
+ type: string
+ enum:
+ - open
+ - active
+ - closed
+ - cancelled
+ - failed
+ SpotInstanceStatus:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide for Linux Instances.'
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description for the status code.
+ updateTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ description: Describes the status of a Spot Instance request.
+ SpotInstanceRequest:
+ type: object
+ properties:
+ actualBlockHourlyPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Deprecated.
+ availabilityZoneGroup:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.'
+ blockDurationMinutes:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: Deprecated.
+ createTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ fault:
+ allOf:
+ - $ref: '#/components/schemas/SpotInstanceStateFault'
+ - description: 'The fault codes for the Spot Instance request, if any.'
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceId'
+ - description: 'The instance ID, if an instance has been launched to fulfill the Spot Instance request.'
+ launchGroup:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
+ launchSpecification:
+ allOf:
+ - $ref: '#/components/schemas/LaunchSpecification'
+ - description: Additional information for launching instances.
+ launchedAvailabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone in which the request is launched.
+ productDescription:
+ allOf:
+ - $ref: '#/components/schemas/RIProductDescription'
+ - description: The product description associated with the Spot Instance.
+ spotInstanceRequestId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Spot Instance request.
+ spotPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The maximum price per hour that you are willing to pay for a Spot Instance.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/SpotInstanceState'
+ - description: 'The state of the Spot Instance request. Spot request status information helps track your Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.'
+ status:
+ allOf:
+ - $ref: '#/components/schemas/SpotInstanceStatus'
+ - description: The status code and status message describing the Spot Instance request.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the resource.
+ type:
+ allOf:
+ - $ref: '#/components/schemas/SpotInstanceType'
+ - description: The Spot Instance request type.
+ validFrom:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.'
+ validUntil:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the validUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the validUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
1 to 10. A score of 10 indicates that your Spot request is highly likely to succeed in this Region or Availability Zone. A score of 1 indicates that your Spot request is not likely to succeed. '
+ description: The Spot placement score for this Region or Availability Zone. The score is calculated based on the assumption that the capacity-optimized allocation strategy is used and that all of the Availability Zones in the Region can be used.
+ SpotPlacementScoresMaxResults:
+ type: integer
+ minimum: 10
+ maximum: 1000
+ SpotPlacementScoresTargetCapacity:
+ type: integer
+ minimum: 1
+ maximum: 2000000000
+ SpotPrice:
+ type: object
+ properties:
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone.
+ instanceType:
+ allOf:
+ - $ref: '#/components/schemas/InstanceType'
+ - description: The instance type.
+ productDescription:
+ allOf:
+ - $ref: '#/components/schemas/RIProductDescription'
+ - description: A general description of the AMI.
+ spotPrice:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The maximum price per hour that you are willing to pay for a Spot Instance.
+ timestamp:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: 'The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
+ description: Describes the maximum price per hour that you are willing to pay for a Spot Instance.
+ UserIdGroupPairSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/UserIdGroupPair'
+ - xml:
+ name: item
+ StaleIpPermission:
+ type: object
+ properties:
+ fromPort:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types. '
+ ipProtocol:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).'
+ ipRanges:
+ allOf:
+ - $ref: '#/components/schemas/IpRanges'
+ - description: The IP ranges. Not applicable for stale security group rules.
+ prefixListIds:
+ allOf:
+ - $ref: '#/components/schemas/PrefixListIdSet'
+ - description: The prefix list IDs. Not applicable for stale security group rules.
+ toPort:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types. '
+ groups:
+ allOf:
+ - $ref: '#/components/schemas/UserIdGroupPairSet'
+ - description: 'The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.'
+ description: Describes a stale rule in a security group.
+ StaleIpPermissionSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/StaleIpPermission'
+ - xml:
+ name: item
+ StaleSecurityGroup:
+ type: object
+ properties:
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The description of the security group.
+ groupId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the security group.
+ groupName:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The name of the security group.
+ staleIpPermissions:
+ allOf:
+ - $ref: '#/components/schemas/StaleIpPermissionSet'
+ - description: Information about the stale inbound rules in the security group.
+ staleIpPermissionsEgress:
+ allOf:
+ - $ref: '#/components/schemas/StaleIpPermissionSet'
+ - description: Information about the stale outbound rules in the security group.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC for the security group.
+ description: Describes a stale security group (a security group that contains stale rules).
+ StartInstancesRequest:
+ type: object
+ required:
+ - InstanceIds
+ title: StartInstancesRequest
+ properties:
+ InstanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdStringList'
+ - description: The IDs of the instances.
+ additionalInfo:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Reserved.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ StartNetworkInsightsAccessScopeAnalysisRequest:
+ type: object
+ required:
+ - NetworkInsightsAccessScopeId
+ - ClientToken
+ title: StartNetworkInsightsAccessScopeAnalysisRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ StartNetworkInsightsAnalysisRequest:
+ type: object
+ required:
+ - NetworkInsightsPathId
+ - ClientToken
+ title: StartNetworkInsightsAnalysisRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInsightsPathId'
+ - description: The ID of the path.
+ FilterInArn:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TagSpecification:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
+ StartVpcEndpointServicePrivateDnsVerificationRequest:
+ type: object
+ required:
+ - ServiceId
+ title: StartVpcEndpointServicePrivateDnsVerificationRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/VpcEndpointServiceId'
+ - description: The ID of the endpoint service.
+ State:
+ type: string
+ enum:
+ - PendingAcceptance
+ - Pending
+ - Available
+ - Deleting
+ - Deleted
+ - Rejected
+ - Failed
+ - Expired
+ StaticSourcesSupportValue:
+ type: string
+ enum:
+ - enable
+ - disable
+ StopInstancesRequest:
+ type: object
+ required:
+ - InstanceIds
+ title: StopInstancesRequest
+ properties:
+ InstanceId:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ force:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
InProgress, Completed, or Failed).'
+ storeTaskFailureReason:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'If the tasks fails, the reason for the failure is returned. If the task succeeds, null is returned.'
+ description: 'The information about the AMI store task, including the progress of the task.'
+ SubnetState:
+ type: string
+ enum:
+ - pending
+ - available
+ SubnetIpv6CidrBlockAssociationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation'
+ - xml:
+ name: item
+ TransitGatewayMulitcastDomainAssociationState:
+ type: string
+ enum:
+ - pendingAcceptance
+ - associating
+ - associated
+ - disassociating
+ - disassociated
+ - rejected
+ - failed
+ SubnetAssociation:
+ type: object
+ properties:
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the subnet.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayMulitcastDomainAssociationState'
+ - description: The state of the subnet association.
+ description: Describes the subnet association with the transit gateway multicast domain.
+ SubnetAssociationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SubnetAssociation'
+ - xml:
+ name: item
+ SubnetCidrBlockStateCode:
+ type: string
+ enum:
+ - associating
+ - associated
+ - disassociating
+ - disassociated
+ - failing
+ - failed
+ SubnetCidrBlockState:
+ type: object
+ properties:
+ state:
+ allOf:
+ - $ref: '#/components/schemas/SubnetCidrBlockStateCode'
+ - description: The state of a CIDR block.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A message about the status of the CIDR block, if applicable.'
+ description: Describes the state of a CIDR block.
+ SubnetCidrReservationId:
+ type: string
+ SubnetCidrReservationType:
+ type: string
+ enum:
+ - prefix
+ - explicit
+ SuccessfulInstanceCreditSpecificationItem:
+ type: object
+ properties:
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance.
+ description: Describes the burstable performance instance whose credit option for CPU usage was successfully modified.
+ SuccessfulQueuedPurchaseDeletion:
+ type: object
+ properties:
+ reservedInstancesId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Reserved Instance.
+ description: Describes a Reserved Instance whose queued purchase was successfully deleted.
+ TagDescription:
+ type: object
+ properties:
+ key:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The tag key.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/ResourceType'
+ - description: The resource type.
+ value:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The tag value.
+ description: Describes a tag.
+ TargetCapacitySpecificationRequest:
+ type: object
+ required:
+ - TotalTargetCapacity
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/TargetCapacityUnitType'
+ - description: 'The unit for the target capacity.
Default: units (translates to number of instances)
The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ TerminateConnectionStatusSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TerminateConnectionStatus'
+ - xml:
+ name: item
+ TerminateConnectionStatus:
+ type: object
+ properties:
+ connectionId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the client connection.
+ previousStatus:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnConnectionStatus'
+ - description: The state of the client connection.
+ currentStatus:
+ allOf:
+ - $ref: '#/components/schemas/ClientVpnConnectionStatus'
+ - description: 'A message about the status of the client connection, if applicable.'
+ description: Information about a terminated Client VPN endpoint client connection.
+ TerminateInstancesRequest:
+ type: object
+ required:
+ - InstanceIds
+ title: TerminateInstancesRequest
+ properties:
+ InstanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdStringList'
+ - description: 'The IDs of the instances.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
' + dryRun: + allOf: + - $ref: '#/components/schemas/Boolean' + - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ThreadsPerCore:
+ type: integer
+ ThreadsPerCoreList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ThreadsPerCore'
+ - xml:
+ name: item
+ ThroughResourcesStatement:
+ type: object
+ properties:
+ resourceStatement:
+ allOf:
+ - $ref: '#/components/schemas/ResourceStatement'
+ - description: The resource statement.
+ description: Describes a through resource statement.
+ ThroughResourcesStatementRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/ResourceStatementRequest'
+ - description: The resource statement.
+ description: Describes a through resource statement.
+ TotalLocalStorageGBRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Double'
+ - description: 'The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.'
+ description: 'The minimum and maximum amount of total local storage, in GB.'
+ TrafficDirection:
+ type: string
+ enum:
+ - ingress
+ - egress
+ TrafficMirrorFilterRuleList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorFilterRule'
+ - xml:
+ name: item
+ TrafficMirrorFilterIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorFilterId'
+ - xml:
+ name: item
+ TrafficMirrorRuleAction:
+ type: string
+ enum:
+ - accept
+ - reject
+ TrafficMirrorPortRange:
+ type: object
+ properties:
+ fromPort:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
+ toPort:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
+ description: Describes the Traffic Mirror port range.
+ TrafficMirrorFilterRuleFieldList:
+ type: array
+ items:
+ $ref: '#/components/schemas/TrafficMirrorFilterRuleField'
+ TrafficMirrorFilterRuleId:
+ type: string
+ TrafficMirrorPortRangeRequest:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
+ description: Information about the Traffic Mirror filter rule port range.
+ TrafficMirrorSessionFieldList:
+ type: array
+ items:
+ $ref: '#/components/schemas/TrafficMirrorSessionField'
+ TrafficMirrorSessionIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorSessionId'
+ - xml:
+ name: item
+ TrafficMirrorTargetType:
+ type: string
+ enum:
+ - network-interface
+ - network-load-balancer
+ - gateway-load-balancer-endpoint
+ TrafficMirrorTargetIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TrafficMirrorTargetId'
+ - xml:
+ name: item
+ TrafficMirroringMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ TransitAssociationGatewayId:
+ type: string
+ TransitGatewayState:
+ type: string
+ enum:
+ - pending
+ - available
+ - modifying
+ - deleting
+ - deleted
+ TransitGatewayOptions:
+ type: object
+ properties:
+ amazonSideAsn:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
+ transitGatewayCidrBlocks:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The transit gateway CIDR blocks.
+ autoAcceptSharedAttachments:
+ allOf:
+ - $ref: '#/components/schemas/AutoAcceptSharedAttachmentsValue'
+ - description: Indicates whether attachment requests are automatically accepted.
+ defaultRouteTableAssociation:
+ allOf:
+ - $ref: '#/components/schemas/DefaultRouteTableAssociationValue'
+ - description: Indicates whether resource attachments are automatically associated with the default association route table.
+ associationDefaultRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the default association route table.
+ defaultRouteTablePropagation:
+ allOf:
+ - $ref: '#/components/schemas/DefaultRouteTablePropagationValue'
+ - description: Indicates whether resource attachments automatically propagate routes to the default propagation route table.
+ propagationDefaultRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the default propagation route table.
+ vpnEcmpSupport:
+ allOf:
+ - $ref: '#/components/schemas/VpnEcmpSupportValue'
+ - description: Indicates whether Equal Cost Multipath Protocol support is enabled.
+ dnsSupport:
+ allOf:
+ - $ref: '#/components/schemas/DnsSupportValue'
+ - description: Indicates whether DNS support is enabled.
+ multicastSupport:
+ allOf:
+ - $ref: '#/components/schemas/MulticastSupportValue'
+ - description: Indicates whether multicast is enabled on the transit gateway
+ description: Describes the options for a transit gateway.
+ TransitGatewayAttachmentResourceType:
+ type: string
+ enum:
+ - vpc
+ - vpn
+ - direct-connect-gateway
+ - connect
+ - peering
+ - tgw-peering
+ TransitGatewayAssociationState:
+ type: string
+ enum:
+ - associating
+ - associated
+ - disassociating
+ - disassociated
+ TransitGatewayAttachmentState:
+ type: string
+ enum:
+ - initiating
+ - initiatingRequest
+ - pendingAcceptance
+ - rollingBack
+ - pending
+ - available
+ - modifying
+ - deleting
+ - deleted
+ - failed
+ - rejected
+ - rejecting
+ - failing
+ TransitGatewayAttachmentAssociation:
+ type: object
+ properties:
+ transitGatewayRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the route table for the transit gateway.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAssociationState'
+ - description: The state of the association.
+ description: Describes an association.
+ TransitGatewayAttachment:
+ type: object
+ properties:
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the attachment.
+ transitGatewayId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway.
+ transitGatewayOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the transit gateway.
+ resourceOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the resource.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
+ - description: The resource type. Note that the tgw-peering resource type has been deprecated.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentState'
+ - description: The attachment state. Note that the initiating state has been deprecated.
+ association:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentAssociation'
+ - description: The association.
+ creationTime:
+ allOf:
+ - $ref: '#/components/schemas/DateTime'
+ - description: The creation time.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: The tags for the attachment.
+ description: Describes an attachment between a resource and a transit gateway.
+ TransitGatewayAttachmentBgpConfiguration:
+ type: object
+ properties:
+ transitGatewayAsn:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: The transit gateway Autonomous System Number (ASN).
+ peerAsn:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: The peer Autonomous System Number (ASN).
+ transitGatewayAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The interior BGP peer IP address for the transit gateway.
+ peerAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The interior BGP peer IP address for the appliance.
+ bgpStatus:
+ allOf:
+ - $ref: '#/components/schemas/BgpStatus'
+ - description: The BGP status.
+ description: The BGP configuration information.
+ TransitGatewayAttachmentBgpConfigurationList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentBgpConfiguration'
+ - xml:
+ name: item
+ TransitGatewayPropagationState:
+ type: string
+ enum:
+ - enabling
+ - enabled
+ - disabling
+ - disabled
+ TransitGatewayAttachmentPropagation:
+ type: object
+ properties:
+ transitGatewayRouteTableId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the propagation route table.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPropagationState'
+ - description: The state of the propagation route table.
+ description: Describes a propagation route table.
+ TransitGatewayConnectOptions:
+ type: object
+ properties:
+ protocol:
+ allOf:
+ - $ref: '#/components/schemas/ProtocolValue'
+ - description: The tunnel protocol.
+ description: Describes the Connect attachment options.
+ TransitGatewayConnectPeerState:
+ type: string
+ enum:
+ - pending
+ - available
+ - deleting
+ - deleted
+ TransitGatewayConnectPeerConfiguration:
+ type: object
+ properties:
+ transitGatewayAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Connect peer IP address on the transit gateway side of the tunnel.
+ peerAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Connect peer IP address on the appliance side of the tunnel.
+ insideCidrBlocks:
+ allOf:
+ - $ref: '#/components/schemas/InsideCidrBlocksStringList'
+ - description: The range of interior BGP peer IP addresses.
+ protocol:
+ allOf:
+ - $ref: '#/components/schemas/ProtocolValue'
+ - description: The tunnel protocol.
+ bgpConfigurations:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentBgpConfigurationList'
+ - description: The BGP configuration details.
+ description: Describes the Connect peer details.
+ TransitGatewayConnectRequestBgpOptions:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/Long'
+ - description: The peer Autonomous System Number (ASN).
+ description: The BGP options for the Connect attachment.
+ TransitGatewayMaxResults:
+ type: integer
+ minimum: 5
+ maximum: 1000
+ TransitGatewayMulticastDomainOptions:
+ type: object
+ properties:
+ igmpv2Support:
+ allOf:
+ - $ref: '#/components/schemas/Igmpv2SupportValue'
+ - description: Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
+ staticSourcesSupport:
+ allOf:
+ - $ref: '#/components/schemas/StaticSourcesSupportValue'
+ - description: Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
+ autoAcceptSharedAssociations:
+ allOf:
+ - $ref: '#/components/schemas/AutoAcceptSharedAssociationsValue'
+ - description: Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
+ description: Describes the options for a transit gateway multicast domain.
+ TransitGatewayMulticastDomainState:
+ type: string
+ enum:
+ - pending
+ - available
+ - deleting
+ - deleted
+ TransitGatewayMulticastDomainAssociation:
+ type: object
+ properties:
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway attachment.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
+ - description: 'The type of resource, for example a VPC attachment.'
+ resourceOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: ' The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.'
+ subnet:
+ allOf:
+ - $ref: '#/components/schemas/SubnetAssociation'
+ - description: The subnet associated with the transit gateway multicast domain.
+ description: Describes the resources associated with the transit gateway multicast domain.
+ TransitGatewayMulticastGroup:
+ type: object
+ properties:
+ groupIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IP address assigned to the transit gateway multicast group.
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway attachment.
+ subnetId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the subnet.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
+ - description: 'The type of resource, for example a VPC attachment.'
+ resourceOwnerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: ' The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.'
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the transit gateway attachment.
+ groupMember:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates that the resource is a transit gateway multicast group member.
+ groupSource:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates that the resource is a transit gateway multicast group member.
+ memberType:
+ allOf:
+ - $ref: '#/components/schemas/MembershipType'
+ - description: 'The member type (for example, static).'
+ sourceType:
+ allOf:
+ - $ref: '#/components/schemas/MembershipType'
+ - description: The source type.
+ description: Describes the transit gateway multicast group resources.
+ TransitGatewayNetworkInterfaceIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - xml:
+ name: item
+ VpnEcmpSupportValue:
+ type: string
+ enum:
+ - enable
+ - disable
+ TransitGatewayPrefixListAttachment:
+ type: object
+ properties:
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentId'
+ - description: The ID of the attachment.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
+ - description: The resource type. Note that the tgw-peering resource type has been deprecated.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ description: Describes a transit gateway prefix list attachment.
+ TransitGatewayPrefixListReferenceState:
+ type: string
+ enum:
+ - pending
+ - available
+ - modifying
+ - deleting
+ TransitGatewayRouteAttachmentList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayRouteAttachment'
+ - xml:
+ name: item
+ TransitGatewayRouteType:
+ type: string
+ enum:
+ - static
+ - propagated
+ TransitGatewayRouteState:
+ type: string
+ enum:
+ - pending
+ - active
+ - blackhole
+ - deleting
+ - deleted
+ TransitGatewayRouteAttachment:
+ type: object
+ properties:
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the attachment.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
+ - description: 'The resource type. Note that the tgw-peering resource type has been deprecated. '
+ description: Describes a route attachment.
+ TransitGatewayRouteTableState:
+ type: string
+ enum:
+ - pending
+ - available
+ - deleting
+ - deleted
+ TransitGatewayRouteTableAssociation:
+ type: object
+ properties:
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the attachment.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
+ - description: The resource type. Note that the tgw-peering resource type has been deprecated.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAssociationState'
+ - description: The state of the association.
+ description: Describes an association between a route table and a resource attachment.
+ TransitGatewayRouteTablePropagation:
+ type: object
+ properties:
+ transitGatewayAttachmentId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the attachment.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ resourceType:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
+ - description: The type of resource. Note that the tgw-peering resource type has been deprecated.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/TransitGatewayPropagationState'
+ - description: The state of the resource.
+ description: Describes a route table propagation.
+ TransitGatewaySubnetIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/SubnetId'
+ - xml:
+ name: item
+ TransitGatewayVpcAttachmentOptions:
+ type: object
+ properties:
+ dnsSupport:
+ allOf:
+ - $ref: '#/components/schemas/DnsSupportValue'
+ - description: Indicates whether DNS support is enabled.
+ ipv6Support:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6SupportValue'
+ - description: Indicates whether IPv6 support is disabled.
+ applianceModeSupport:
+ allOf:
+ - $ref: '#/components/schemas/ApplianceModeSupportValue'
+ - description: Indicates whether appliance mode support is enabled.
+ description: Describes the VPC attachment options.
+ TrunkInterfaceAssociationIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TrunkInterfaceAssociationId'
+ - xml:
+ name: item
+ TunnelInsideIpVersion:
+ type: string
+ enum:
+ - ipv4
+ - ipv6
+ TunnelOption:
+ type: object
+ properties:
+ outsideIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The external IP address of the VPN tunnel.
+ tunnelInsideCidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The range of inside IPv4 addresses for the tunnel.
+ tunnelInsideIpv6Cidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The range of inside IPv6 addresses for the tunnel.
+ preSharedKey:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
+ phase1LifetimeSeconds:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The lifetime for phase 1 of the IKE negotiation, in seconds.'
+ phase2LifetimeSeconds:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The lifetime for phase 2 of the IKE negotiation, in seconds.'
+ rekeyMarginTimeSeconds:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: 'The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.'
+ rekeyFuzzPercentage:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
+ replayWindowSize:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of packets in an IKE replay window.
+ dpdTimeoutSeconds:
+ allOf:
+ - $ref: '#/components/schemas/Integer'
+ - description: The number of seconds after which a DPD timeout occurs.
+ dpdTimeoutAction:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The action to take after a DPD timeout occurs.
+ phase1EncryptionAlgorithmSet:
+ allOf:
+ - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsList'
+ - description: The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
+ phase2EncryptionAlgorithmSet:
+ allOf:
+ - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsList'
+ - description: The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
+ phase1IntegrityAlgorithmSet:
+ allOf:
+ - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsList'
+ - description: The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
+ phase2IntegrityAlgorithmSet:
+ allOf:
+ - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsList'
+ - description: The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
+ phase1DHGroupNumberSet:
+ allOf:
+ - $ref: '#/components/schemas/Phase1DHGroupNumbersList'
+ - description: The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
+ phase2DHGroupNumberSet:
+ allOf:
+ - $ref: '#/components/schemas/Phase2DHGroupNumbersList'
+ - description: The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
+ ikeVersionSet:
+ allOf:
+ - $ref: '#/components/schemas/IKEVersionsList'
+ - description: The IKE versions that are permitted for the VPN tunnel.
+ startupAction:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The action to take when the establishing the VPN tunnels for a VPN connection.
+ description: The VPN tunnel options.
+ TunnelOptionsList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/TunnelOption'
+ - xml:
+ name: item
+ UnassignIpv6AddressesRequest:
+ type: object
+ required:
+ - NetworkInterfaceId
+ title: UnassignIpv6AddressesRequest
+ properties:
+ ipv6Addresses:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6AddressList'
+ - description: The IPv6 addresses to unassign from the network interface.
+ Ipv6Prefix:
+ allOf:
+ - $ref: '#/components/schemas/IpPrefixList'
+ - description: One or more IPv6 prefixes to unassign from the network interface.
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - description: The ID of the network interface.
+ UnassignPrivateIpAddressesRequest:
+ type: object
+ required:
+ - NetworkInterfaceId
+ title: UnassignPrivateIpAddressesRequest
+ properties:
+ networkInterfaceId:
+ allOf:
+ - $ref: '#/components/schemas/NetworkInterfaceId'
+ - description: The ID of the network interface.
+ privateIpAddress:
+ allOf:
+ - $ref: '#/components/schemas/PrivateIpAddressStringList'
+ - description: The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.
+ Ipv4Prefix:
+ allOf:
+ - $ref: '#/components/schemas/IpPrefixList'
+ - description: The IPv4 prefixes to unassign from the network interface.
+ description: Contains the parameters for UnassignPrivateIpAddresses.
+ UnmonitorInstancesRequest:
+ type: object
+ required:
+ - InstanceIds
+ title: UnmonitorInstancesRequest
+ properties:
+ InstanceId:
+ allOf:
+ - $ref: '#/components/schemas/InstanceIdStringList'
+ - description: The IDs of the instances.
+ dryRun:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ UnsuccessfulInstanceCreditSpecificationErrorCode:
+ type: string
+ enum:
+ - InvalidInstanceID.Malformed
+ - InvalidInstanceID.NotFound
+ - IncorrectInstanceState
+ - InstanceCreditSpecification.NotSupported
+ UnsuccessfulInstanceCreditSpecificationItemError:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationErrorCode'
+ - description: The error code.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The applicable error message.
+ description: Information about the error for the burstable performance instance whose credit option for CPU usage was not modified.
+ UnsuccessfulInstanceCreditSpecificationItem:
+ type: object
+ properties:
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance.
+ error:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationItemError'
+ - description: The applicable error for the burstable performance instance whose credit option for CPU usage was not modified.
+ description: Describes the burstable performance instance whose credit option for CPU usage was not modified.
+ UnsuccessfulItemError:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The error code.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The error message accompanying the error code.
+ description: 'Information about the error that occurred. For more information about errors, see Error codes.'
+ UnsuccessfulItem:
+ type: object
+ properties:
+ error:
+ allOf:
+ - $ref: '#/components/schemas/UnsuccessfulItemError'
+ - description: Information about the error.
+ resourceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the resource.
+ description: Information about items that were not successfully processed in a batch call.
+ UpdateSecurityGroupRuleDescriptionsEgressRequest:
+ type: object
+ title: UpdateSecurityGroupRuleDescriptionsEgressRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/IpPermissionList'
+ - description: The IP permissions for the security group rule. You must specify either the IP permissions or the description.
+ SecurityGroupRuleDescription:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRuleDescriptionList'
+ - description: The description for the egress security group rules. You must specify either the description or the IP permissions.
+ UpdateSecurityGroupRuleDescriptionsIngressRequest:
+ type: object
+ title: UpdateSecurityGroupRuleDescriptionsIngressRequest
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/IpPermissionList'
+ - description: The IP permissions for the security group rule. You must specify either IP permissions or a description.
+ SecurityGroupRuleDescription:
+ allOf:
+ - $ref: '#/components/schemas/SecurityGroupRuleDescriptionList'
+ - description: '[VPC only] The description for the ingress security group rules. You must specify either a description or IP permissions.'
+ UsageClassType:
+ type: string
+ enum:
+ - spot
+ - on-demand
+ UserIdGroupPair:
+ type: object
+ properties:
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
' + groupId: + allOf: + - $ref: '#/components/schemas/String' + - description: The ID of the security group. + groupName: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
' + peeringStatus: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The status of a VPC peering connection, if applicable.' + userId: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.
' + vpcId: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The ID of the VPC for the referenced security group, if applicable.' + vpcPeeringConnectionId: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The ID of the VPC peering connection, if applicable.' + description: Describes a security group and Amazon Web Services account ID pair. + VCpuCount: + type: integer + VCpuCountRangeRequest: + type: object + required: + - Min + properties: + undefined: + allOf: + - $ref: '#/components/schemas/Integer' + - description: 'The maximum number of vCPUs. To specify no maximum limit, omit this parameter.' + description: The minimum and maximum number of vCPUs. + VgwTelemetry: + type: object + properties: + acceptedRouteCount: + allOf: + - $ref: '#/components/schemas/Integer' + - description: The number of accepted routes. + lastStatusChange: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: The date and time of the last change in status. + outsideIpAddress: + allOf: + - $ref: '#/components/schemas/String' + - description: The Internet-routable IP address of the virtual private gateway's outside interface. + status: + allOf: + - $ref: '#/components/schemas/TelemetryStatus' + - description: The status of the VPN tunnel. + statusMessage: + allOf: + - $ref: '#/components/schemas/String' + - description: 'If an error occurs, a description of the error.' + certificateArn: + allOf: + - $ref: '#/components/schemas/String' + - description: The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate. + description: Describes telemetry for a VPN tunnel. + VgwTelemetryList: + type: array + items: + allOf: + - $ref: '#/components/schemas/VgwTelemetry' + - xml: + name: item + VirtualizationTypeSet: + type: array + items: + allOf: + - $ref: '#/components/schemas/VirtualizationType' + - xml: + name: item + minItems: 0 + maxItems: 2 + VolumeAttachmentList: + type: array + items: + allOf: + - $ref: '#/components/schemas/VolumeAttachment' + - xml: + name: item + VolumeState: + type: string + enum: + - creating + - available + - in-use + - deleting + - deleted + - error + VolumeAttachmentState: + type: string + enum: + - attaching + - attached + - detaching + - detached + - busy + VolumeAttributeName: + type: string + enum: + - autoEnableIO + - productCodes + VolumeModificationState: + type: string + enum: + - modifying + - optimizing + - completed + - failed + VolumeStatusAction: + type: object + properties: + code: + allOf: + - $ref: '#/components/schemas/String' + - description: 'The code identifying the operation, for example,enable-volume-io.'
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the operation.
+ eventId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the event associated with this operation.
+ eventType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The event type associated with this operation.
+ description: Describes a volume status operation code.
+ VolumeStatusActionsList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusAction'
+ - xml:
+ name: item
+ VolumeStatusAttachmentStatus:
+ type: object
+ properties:
+ ioPerformance:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The maximum IOPS supported by the attached instance.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the attached instance.
+ description: Information about the instances to which the volume is attached.
+ VolumeStatusAttachmentStatusList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusAttachmentStatus'
+ - xml:
+ name: item
+ VolumeStatusName:
+ type: string
+ enum:
+ - io-enabled
+ - io-performance
+ VolumeStatusDetails:
+ type: object
+ properties:
+ name:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusName'
+ - description: The name of the volume status.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The intended status of the volume status.
+ description: Describes a volume status.
+ VolumeStatusDetailsList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusDetails'
+ - xml:
+ name: item
+ VolumeStatusEvent:
+ type: object
+ properties:
+ description:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: A description of the event.
+ eventId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of this event.
+ eventType:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The type of this event.
+ notAfter:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The latest end time of the event.
+ notBefore:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The earliest start time of the event.
+ instanceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the instance associated with the event.
+ description: Describes a volume status event.
+ VolumeStatusEventsList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusEvent'
+ - xml:
+ name: item
+ VolumeStatusInfoStatus:
+ type: string
+ enum:
+ - ok
+ - impaired
+ - insufficient-data
+ VolumeStatusInfo:
+ type: object
+ properties:
+ details:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusDetailsList'
+ - description: The details of the volume status.
+ status:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusInfoStatus'
+ - description: The status of the volume.
+ description: Describes the status of a volume.
+ VolumeStatusItem:
+ type: object
+ properties:
+ actionsSet:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusActionsList'
+ - description: The details of the operation.
+ availabilityZone:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Availability Zone of the volume.
+ outpostArn:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Amazon Resource Name (ARN) of the Outpost.
+ eventsSet:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusEventsList'
+ - description: A list of events associated with the volume.
+ volumeId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The volume ID.
+ volumeStatus:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusInfo'
+ - description: The volume status.
+ attachmentStatuses:
+ allOf:
+ - $ref: '#/components/schemas/VolumeStatusAttachmentStatusList'
+ - description: Information about the instances to which the volume is attached.
+ description: Describes the volume status.
+ VpcState:
+ type: string
+ enum:
+ - pending
+ - available
+ VpcIpv6CidrBlockAssociationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation'
+ - xml:
+ name: item
+ VpcCidrBlockAssociationSet:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcCidrBlockAssociation'
+ - xml:
+ name: item
+ VpcAttachmentList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcAttachment'
+ - xml:
+ name: item
+ VpcAttributeName:
+ type: string
+ enum:
+ - enableDnsSupport
+ - enableDnsHostnames
+ VpcCidrBlockState:
+ type: object
+ properties:
+ state:
+ allOf:
+ - $ref: '#/components/schemas/VpcCidrBlockStateCode'
+ - description: The state of the CIDR block.
+ statusMessage:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A message about the status of the CIDR block, if applicable.'
+ description: Describes the state of a CIDR block.
+ VpcCidrBlockStateCode:
+ type: string
+ enum:
+ - associating
+ - associated
+ - disassociating
+ - disassociated
+ - failing
+ - failed
+ VpcClassicLink:
+ type: object
+ properties:
+ classicLinkEnabled:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the VPC is enabled for ClassicLink.
+ tagSet:
+ allOf:
+ - $ref: '#/components/schemas/TagList'
+ - description: Any tags assigned to the VPC.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ description: Describes whether a VPC is enabled for ClassicLink.
+ VpcEndpointType:
+ type: string
+ enum:
+ - Interface
+ - Gateway
+ - GatewayLoadBalancer
+ VpcEndpointConnection:
+ type: object
+ properties:
+ serviceId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the service to which the endpoint is connected.
+ vpcEndpointId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC endpoint.
+ vpcEndpointOwner:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the VPC endpoint.
+ vpcEndpointState:
+ allOf:
+ - $ref: '#/components/schemas/State'
+ - description: The state of the VPC endpoint.
+ creationTimestamp:
+ allOf:
+ - $ref: '#/components/schemas/MillisecondDateTime'
+ - description: The date and time that the VPC endpoint was created.
+ dnsEntrySet:
+ allOf:
+ - $ref: '#/components/schemas/DnsEntrySet'
+ - description: The DNS entries for the VPC endpoint.
+ networkLoadBalancerArnSet:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The Amazon Resource Names (ARNs) of the network load balancers for the service.
+ gatewayLoadBalancerArnSet:
+ allOf:
+ - $ref: '#/components/schemas/ValueStringList'
+ - description: The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
+ ipAddressType:
+ allOf:
+ - $ref: '#/components/schemas/IpAddressType'
+ - description: The IP address type for the endpoint.
+ description: Describes a VPC endpoint connection to a service.
+ VpcPeeringConnectionVpcInfo:
+ type: object
+ properties:
+ cidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv4 CIDR block for the VPC.
+ ipv6CidrBlockSet:
+ allOf:
+ - $ref: '#/components/schemas/Ipv6CidrBlockSet'
+ - description: The IPv6 CIDR block for the VPC.
+ cidrBlockSet:
+ allOf:
+ - $ref: '#/components/schemas/CidrBlockSet'
+ - description: Information about the IPv4 CIDR blocks for the VPC.
+ ownerId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the Amazon Web Services account that owns the VPC.
+ peeringOptions:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnectionOptionsDescription'
+ - description: Information about the VPC peering connection options for the accepter or requester VPC.
+ vpcId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The ID of the VPC.
+ region:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The Region in which the VPC is located.
+ description: Describes a VPC in a VPC peering connection.
+ VpcPeeringConnectionStateReason:
+ type: object
+ properties:
+ code:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnectionStateReasonCode'
+ - description: The status of the VPC peering connection.
+ message:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'A message that provides more information about the status, if applicable.'
+ description: Describes the status of a VPC peering connection.
+ VpcPeeringConnectionIdList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpcPeeringConnectionId'
+ - xml:
+ name: item
+ VpcPeeringConnectionOptionsDescription:
+ type: object
+ properties:
+ allowDnsResolutionFromRemoteVpc:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
+ allowEgressFromLocalClassicLinkToRemoteVpc:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
+ allowEgressFromLocalVpcToRemoteClassicLink:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
+ description: Describes the VPC peering connection options.
+ VpcPeeringConnectionStateReasonCode:
+ type: string
+ enum:
+ - initiating-request
+ - pending-acceptance
+ - active
+ - deleted
+ - rejected
+ - failed
+ - expired
+ - provisioning
+ - deleting
+ VpcTenancy:
+ type: string
+ enum:
+ - default
+ VpnState:
+ type: string
+ enum:
+ - pending
+ - available
+ - deleting
+ - deleted
+ VpnConnectionOptions:
+ type: object
+ properties:
+ enableAcceleration:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether acceleration is enabled for the VPN connection.
+ staticRoutesOnly:
+ allOf:
+ - $ref: '#/components/schemas/Boolean'
+ - description: Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
+ localIpv4NetworkCidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
+ remoteIpv4NetworkCidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
+ localIpv6NetworkCidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
+ remoteIpv6NetworkCidr:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
+ tunnelInsideIpVersion:
+ allOf:
+ - $ref: '#/components/schemas/TunnelInsideIpVersion'
+ - description: Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
+ tunnelOptionSet:
+ allOf:
+ - $ref: '#/components/schemas/TunnelOptionsList'
+ - description: Indicates the VPN tunnel options.
+ description: Describes VPN connection options.
+ VpnStaticRouteList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/VpnStaticRoute'
+ - xml:
+ name: item
+ VpnConnectionDeviceType:
+ type: object
+ properties:
+ vpnConnectionDeviceTypeId:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Customer gateway device identifier.
+ vendor:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Customer gateway device vendor.
+ platform:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Customer gateway device platform.
+ software:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: Customer gateway device software version.
+ description: 'List of customer gateway devices that have a sample configuration file available for use. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.'
+ VpnConnectionDeviceTypeId:
+ type: string
+ VpnStaticRouteSource:
+ type: string
+ enum:
+ - Static
+ VpnStaticRoute:
+ type: object
+ properties:
+ destinationCidrBlock:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: The CIDR block associated with the local subnet of the customer data center.
+ source:
+ allOf:
+ - $ref: '#/components/schemas/VpnStaticRouteSource'
+ - description: Indicates how the routes were provided.
+ state:
+ allOf:
+ - $ref: '#/components/schemas/VpnState'
+ - description: The current state of the static route.
+ description: Describes a static route for a VPN connection.
+ VpnTunnelOptionsSpecification:
+ type: object
+ properties:
+ undefined:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - description: 'The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
+ ZoneIdStringList:
+ type: array
+ items:
+ allOf:
+ - $ref: '#/components/schemas/String'
+ - xml:
+ name: ZoneId
+security:
+ - hmac: []
+x-stackQL-config:
+ queryParamTranspose:
+ algorithm: AWSCanonical
+ requestTranslate:
+ algorithm: get_query_to_post_form_utf_8
\ No newline at end of file
diff --git a/providers/src/aws/v00.00.00000/services/iam.yaml b/providers/src/aws/v00.00.00000/services/iam.yaml
index 3b7f62cf..585d8064 100644
--- a/providers/src/aws/v00.00.00000/services/iam.yaml
+++ b/providers/src/aws/v00.00.00000/services/iam.yaml
@@ -1,31632 +1,2011 @@
-components:
- parameters:
- X-Amz-Algorithm:
- in: header
- name: X-Amz-Algorithm
- required: false
- schema:
- type: string
- X-Amz-Content-Sha256:
- in: header
- name: X-Amz-Content-Sha256
- required: false
- schema:
- type: string
- X-Amz-Credential:
- in: header
- name: X-Amz-Credential
- required: false
- schema:
- type: string
- X-Amz-Date:
- in: header
- name: X-Amz-Date
- required: false
- schema:
- type: string
- X-Amz-Security-Token:
- in: header
- name: X-Amz-Security-Token
- required: false
- schema:
- type: string
- X-Amz-Signature:
- in: header
- name: X-Amz-Signature
- required: false
- schema:
- type: string
- X-Amz-SignedHeaders:
- in: header
- name: X-Amz-SignedHeaders
- required: false
- schema:
- type: string
- schemas:
- AccessAdvisorUsageGranularityType:
- enum:
- - SERVICE_LEVEL
- - ACTION_LEVEL
- type: string
- AccessDetail:
- description: An object that contains details about when a principal in the - reported Organizations entity last attempted to access an Amazon Web Services - service. A principal can be an IAM user, an IAM role, or the Amazon Web Services - account root user within the reported Organizations entity.
This data - type is a response element in the GetOrganizationsAccessReport operation.
- properties: - EntityPath: - allOf: - - $ref: '#/components/schemas/organizationsEntityPathType' - - description:The path of the Organizations entity (root, organizational - unit, or account) from which an authenticated principal last attempted - to access the service. Amazon Web Services does not report unauthenticated - requests.
This field is null if no principals (IAM users, IAM - roles, or root users) in the reported Organizations entity attempted - to access the service within the reporting - period.
- LastAuthenticatedTime: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "The date and time, in\_ISO 8601 date-time format, when an authenticated principal most\ - \ recently attempted to access the service. Amazon Web Services does\ - \ not report unauthenticated requests.
This field is null if\ - \ no principals in the reported Organizations entity attempted to access\ - \ the service within the reporting period.
" - Region: - allOf: - - $ref: '#/components/schemas/stringType' - - description:The Region where the last service access attempt occurred.
-This field is null if no principals in the reported Organizations - entity attempted to access the service within the reporting - period.
- ServiceName: - allOf: - - $ref: '#/components/schemas/serviceNameType' - - description: The name of the service in which access was attempted. - ServiceNamespace: - allOf: - - $ref: '#/components/schemas/serviceNamespaceType' - - description: "The namespace of the service in which access was attempted.
\ - \To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services\
- \ in the Service Authorization Reference. Choose the name of\
- \ the service to view details for that service. In the first paragraph,\
- \ find the service prefix. For example, (service prefix: a4b).\
- \ For more information about service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\
- \ General Reference.
Contains information about an Amazon Web Services access key.
-This data type is used as a response element in the CreateAccessKey - and ListAccessKeys operations.
The SecretAccessKey
- value is returned only in response to CreateAccessKey. You can get
- a secret access key only when you first create an access key; you cannot recover
- the secret access key later. If you lose a secret access key, you must create
- a new access key.
Active means
- that the key is valid for API calls, while Inactive means
- it is not. '
- UserName:
- allOf:
- - $ref: '#/components/schemas/userNameType'
- - description: The name of the IAM user that the access key is associated
- with.
- required:
- - UserName
- - AccessKeyId
- - Status
- - SecretAccessKey
- type: object
- AccessKeyLastUsed:
- description: Contains information about the last time an Amazon Web Services - access key was used since IAM began tracking this information on April 22, - 2015.
This data type is used as a response element in the GetAccessKeyLastUsed - operation.
- properties: - LastUsedDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description:The date and time, in ISO - 8601 date-time format, when the access key was most recently used. - This field is null in the following situations:
The - user does not have an access key.
An access key exists - but has not been used since IAM began tracking this information.
-There is no sign-in data associated with the user.
-The Amazon Web Services Region where this access key was - most recently used. The value for this field is "N/A" in the following - situations:
The user does not have an access key.
-An access key exists but has not been used since IAM began - tracking this information.
There is no sign-in data - associated with the user.
For more information about - Amazon Web Services Regions, see Regions - and endpoints in the Amazon Web Services General Reference.
- ServiceName: - allOf: - - $ref: '#/components/schemas/stringType' - - description:The name of the Amazon Web Services service with which - this access key was most recently used. The value of this field is "N/A" - in the following situations:
The user does not have - an access key.
An access key exists but has not been - used since IAM started tracking this information.
There - is no sign-in data associated with the user.
Contains information about an Amazon Web Services access key, - without its secret key.
This data type is used as a response element - in the ListAccessKeys operation.
- properties: - AccessKeyId: - allOf: - - $ref: '#/components/schemas/accessKeyIdType' - - description: The ID for this access key. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date when the access key was created. - Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status of the access key.Active means that
- the key is valid for API calls; Inactive means it is not.
- UserName:
- allOf:
- - $ref: '#/components/schemas/userNameType'
- - description: The name of the IAM user that the key is associated with.
- type: object
- ActionNameListType:
- items:
- allOf:
- - $ref: '#/components/schemas/ActionNameType'
- - xml:
- name: member
- type: array
- ActionNameType:
- maxLength: 128
- minLength: 3
- type: string
- AddClientIDToOpenIDConnectProviderRequest:
- properties:
- ClientID:
- allOf:
- - $ref: '#/components/schemas/clientIDType'
- - description: The client ID (also known as audience) to add to the IAM
- OpenID Connect provider resource.
- OpenIDConnectProviderArn:
- allOf:
- - $ref: '#/components/schemas/arnType'
- - description: The Amazon Resource Name (ARN) of the IAM OpenID Connect
- (OIDC) provider resource to add the client ID to. You can get a list
- of OIDC provider ARNs by using the ListOpenIDConnectProviders
- operation.
- required:
- - OpenIDConnectProviderArn
- - ClientID
- title: AddClientIDToOpenIDConnectProviderRequest
- type: object
- AddRoleToInstanceProfileRequest:
- properties:
- InstanceProfileName:
- allOf:
- - $ref: '#/components/schemas/instanceProfileNameType'
- - description: 'The name of the instance profile to update.
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: _+=,.@-
' - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: 'The name of the role to add.
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: _+=,.@-
' - required: - - InstanceProfileName - - RoleName - title: AddRoleToInstanceProfileRequest - type: object - AddUserToGroupRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: 'The name of the group to update.
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: _+=,.@-
' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the user to add.
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: _+=,.@-
' - required: - - GroupName - - UserName - title: AddUserToGroupRequest - type: object - ArnListType: - items: - allOf: - - $ref: '#/components/schemas/arnType' - - xml: - name: member - type: array - AttachGroupPolicyRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: 'The name (friendly name, not ARN) of the group to attach - the policy to.
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: _+=,.@-
' - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to attach.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- required: - - GroupName - - PolicyArn - title: AttachGroupPolicyRequest - type: object - AttachRolePolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to attach.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: 'The name (friendly name, not ARN) of the role to attach - the policy to.
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: _+=,.@-
' - required: - - RoleName - - PolicyArn - title: AttachRolePolicyRequest - type: object - AttachUserPolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to attach.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: 'The name (friendly name, not ARN) of the IAM user to - attach the policy to.
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: _+=,.@-
' - required: - - UserName - - PolicyArn - title: AttachUserPolicyRequest - type: object - AttachedPermissionsBoundary: - 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.
- properties: - PermissionsBoundaryArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: ' The ARN of the policy used to set the permissions boundary - for the user or role.' - 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.'
- type: object
- AttachedPolicy:
- description: Contains information about an attached policy.
An attached - policy is a managed policy that has been attached to a user, group, or role. - This data type is used as a response element in the ListAttachedGroupPolicies, - ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails - operations.
For more information about managed policies, refer to - Managed - policies and inline policies in the IAM User Guide.
- properties: - PolicyArn: - $ref: '#/components/schemas/arnType' - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The friendly name of the attached policy. - type: object - BootstrapDatum: - format: password - type: string - ChangePasswordRequest: - properties: - NewPassword: - allOf: - - $ref: '#/components/schemas/passwordType' - - description:The new password. The new password must conform to the - Amazon Web Services account's password policy, if one exists.
The
- regex pattern that is
- used to validate this parameter is a string of characters. That string
- can include almost any printable ASCII character from the space (\u0020)
- through the end of the ASCII character range (\u00FF).
- You can also include the tab (\u0009), line feed (\u000A),
- and carriage return (\u000D) characters. Any of these characters
- are valid in a password. However, many tools, such as the Amazon Web
- Services Management Console, might restrict the ability to type certain
- characters because they have special meaning within that tool.
Contains information about a condition context key. It includes
- the name of the key and specifies the value (or values, if the context key
- supports multiple values) to use in the simulation. This information is used
- when evaluating the Condition elements of the input policies.
This data type is used as an input parameter to SimulateCustomPolicy - and SimulatePrincipalPolicy.
- properties: - ContextKeyName: - allOf: - - $ref: '#/components/schemas/ContextKeyNameType' - - description: The full name of a condition context key, including the service - prefix. For example,aws:SourceIp or s3:VersionId.
- ContextKeyType:
- allOf:
- - $ref: '#/components/schemas/ContextKeyTypeEnum'
- - description: The data type of the value (or values) specified in the ContextKeyValues
- parameter.
- ContextKeyValues:
- allOf:
- - $ref: '#/components/schemas/ContextKeyValueListType'
- - description: The value (or values, if the condition context key supports
- multiple values) to provide to the simulation when the key is referenced
- by a Condition element in an input policy.
- type: object
- ContextEntryListType:
- items:
- allOf:
- - $ref: '#/components/schemas/ContextEntry'
- - xml:
- name: member
- type: array
- ContextKeyNameType:
- maxLength: 256
- minLength: 5
- type: string
- ContextKeyNamesResultListType:
- items:
- allOf:
- - $ref: '#/components/schemas/ContextKeyNameType'
- - xml:
- name: member
- type: array
- ContextKeyTypeEnum:
- enum:
- - string
- - stringList
- - numeric
- - numericList
- - boolean
- - booleanList
- - ip
- - ipList
- - binary
- - binaryList
- - date
- - dateList
- type: string
- ContextKeyValueListType:
- items:
- allOf:
- - $ref: '#/components/schemas/ContextKeyValueType'
- - xml:
- name: member
- type: array
- ContextKeyValueType:
- type: string
- CreateAccessKeyRequest:
- properties:
- UserName:
- allOf:
- - $ref: '#/components/schemas/existingUserNameType'
- - description: 'The name of the IAM user that the new key will belong - to.
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: _+=,.@-
' - title: CreateAccessKeyRequest - type: object - CreateAccessKeyResponse: - description: 'Contains the response to a successful CreateAccessKey request. ' - example: - AccessKey: - AccessKeyId: AKIAIOSFODNN7EXAMPLE - CreateDate: '2015-03-09T18:39:23.411Z' - SecretAccessKey: wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY - Status: Active - UserName: Bob - properties: - AccessKey: - allOf: - - $ref: '#/components/schemas/AccessKey' - - description: A structure with details about the access key. - required: - - AccessKey - type: object - CreateAccountAliasRequest: - properties: - AccountAlias: - allOf: - - $ref: '#/components/schemas/accountAliasType' - - description:The account alias to create.
This parameter allows - (through its regex pattern) - a string of characters consisting of lowercase letters, digits, and - dashes. You cannot start or finish with a dash, nor can you have two - dashes in a row.
- required: - - AccountAlias - title: CreateAccountAliasRequest - type: object - CreateGroupRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: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".
- 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 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.
-The new password for the user.
The regex
- pattern that is used to validate this parameter is a string of characters.
- That string can include almost any printable ASCII character from the
- space (\u0020) through the end of the ASCII character range
- (\u00FF). You can also include the tab (\u0009),
- line feed (\u000A), and carriage return (\u000D)
- characters. Any of these characters are valid in a password. However,
- many tools, such as the Amazon Web Services Management Console, might
- restrict the ability to type certain characters because they have special
- meaning within that tool.
The name of the IAM user to create a password for. The - user must already exist.
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: - _+=,.@-
' - required: - - UserName - - Password - title: CreateLoginProfileRequest - type: object - CreateLoginProfileResponse: - description: 'Contains the response to a successful CreateLoginProfile - request. ' - example: - LoginProfile: - CreateDate: '2015-03-10T20:55:40.274Z' - PasswordResetRequired: true - UserName: Bob - properties: - LoginProfile: - allOf: - - $ref: '#/components/schemas/LoginProfile' - - description: A structure containing the user name and password create - date. - required: - - LoginProfile - type: object - CreateOpenIDConnectProviderRequest: - properties: - ClientIDList: - allOf: - - $ref: '#/components/schemas/clientIDListType' - - description:Provides a list of client IDs, also known as audiences.
- When a mobile or web app registers with an OpenID Connect provider,
- they establish a value that identifies the application. This is the
- value that's sent as the client_id parameter on OAuth requests.
You can register multiple client IDs with the same provider. For - example, you might have multiple applications that use the same OIDC - provider. You cannot register more than 100 client IDs with a single - IAM OIDC provider.
There is no defined format for a client ID.
- The CreateOpenIDConnectProviderRequest operation accepts
- client IDs up to 255 characters long.
A list of tags that you want to attach to the new IAM - OpenID Connect (OIDC) provider. 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.
-A list of server certificate thumbprints for the OpenID - Connect (OIDC) identity provider's server certificates. Typically this - list includes only one entry. However, IAM lets you have up to five - thumbprints for an OIDC provider. This lets you maintain multiple thumbprints - if the identity provider is rotating certificates.
The server - certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 - certificate used by the domain where the OpenID Connect provider makes - its keys available. It is always a 40-character string.
You must
- provide at least one thumbprint when creating an IAM OIDC provider.
- For example, assume that the OIDC provider is server.example.com
- and the provider stores its keys at https://keys.server.example.com/openid-connect.
- In that case, the thumbprint string would be the hex-encoded SHA-1 hash
- value of the certificate used by https://keys.server.example.com.
-
For more information about obtaining the OIDC provider thumbprint, - see Obtaining - the thumbprint for an OpenID Connect provider in the IAM User - Guide.
- Url: - allOf: - - $ref: '#/components/schemas/OpenIDConnectProviderUrlType' - - description:The URL of the identity provider. The URL must begin with
- https:// and should correspond to the iss
- claim in the provider's OpenID Connect ID tokens. Per the OIDC standard,
- path components are allowed but query parameters are not. Typically
- the URL consists of only a hostname, like https://server.example.org
- or https://example.com. The URL should not contain a port
- number.
You cannot register the same provider multiple times - in a single Amazon Web Services account. If you try to submit a URL - that has already been used for an OpenID Connect provider in the Amazon - Web Services account, you will get an error.
- required: - - Url - - ThumbprintList - title: CreateOpenIDConnectProviderRequest - type: object - CreateOpenIDConnectProviderResponse: - description: 'Contains the response to a successful CreateOpenIDConnectProvider - request. ' - example: - OpenIDConnectProviderArn: arn:aws:iam::123456789012:oidc-provider/server.example.com - properties: - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: 'The Amazon Resource Name (ARN) of the new IAM OpenID Connect - provider that is created. For more information, see OpenIDConnectProviderListEntry. ' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the new IAM OIDC provider. - The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - type: object - CreatePolicyRequest: - properties: - Description: - allOf: - - $ref: '#/components/schemas/policyDescriptionType' - - description:A friendly description of the policy.
Typically - used to store information about the permissions defined in the policy. - For example, "Grants access to production DynamoDB tables."
The - policy description is immutable. After a value is assigned, it cannot - be changed.
- Path: - allOf: - - $ref: '#/components/schemas/policyPathType' - - description:The path for the policy.
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.
You - cannot use an asterisk (*) in the path name.
The JSON policy document that you want to use as the content - for the new policy.
You must provide policies in JSON format - in IAM. 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 maximum length of the policy document that you can pass in this - operation, including whitespace, is listed below. To view the maximum - character counts of a managed policy with no whitespaces, see IAM - and STS character quotas.
To learn more about JSON policy - grammar, see Grammar - of the IAM JSON policy language in the IAM User Guide.
-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)
The friendly name of the policy.
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".
- Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description:A list of tags that you want to attach to the new IAM - customer managed policy. 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.
-The Amazon Resource Name (ARN) of the IAM policy to which - you want to add a new version.
For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:The JSON policy document that you want to use as the content - for this new version of the policy.
You must provide policies - in JSON format in IAM. 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 maximum length of the policy document that you can pass - in this operation, including whitespace, is listed below. To view the - maximum character counts of a managed policy with no whitespaces, see - IAM - and STS character quotas.
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)
Specifies whether to set this version as the policy's - default version.
When this parameter is true, the
- new policy version becomes the operative version. That is, it becomes
- the version that is in effect for the IAM users, groups, and roles that
- the policy is attached to.
For more information about managed - policy versions, see Versioning - for managed policies in the IAM User Guide.
- required: - - PolicyArn - - PolicyDocument - title: CreatePolicyVersionRequest - type: object - CreatePolicyVersionResponse: - description: 'Contains the response to a successful CreatePolicyVersion - request. ' - properties: - PolicyVersion: - allOf: - - $ref: '#/components/schemas/PolicyVersion' - - description: A structure containing details about the new policy version. - type: object - CreateRoleRequest: - properties: - 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 maximum of one hour is applied. This setting can - have a value from 1 hour to 12 hours.
Anyone who assumes the
- role from the 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 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".
- 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.
-The name of the provider 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: _+=,.@-
' - SAMLMetadataDocument: - allOf: - - $ref: '#/components/schemas/SAMLMetadataDocumentType' - - description:An XML document generated by an identity provider (IdP) - that supports SAML 2.0. The document includes the issuer's name, expiration - information, and keys that can be used to validate the SAML authentication - response (assertions) that are received from the IdP. You must generate - the metadata document using the identity management software that is - used as your organization's IdP.
For more information, see About - SAML 2.0-based federation in the IAM User Guide
- Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description:A list of tags that you want to attach to the new IAM - SAML provider. 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.
-The service principal for the Amazon Web Services service
- to which this role is attached. You use a string similar to a URL but
- without the http:// in front. For example: elasticbeanstalk.amazonaws.com.
-
Service principals are unique and case-sensitive. To find the - exact service principal for your service-linked role, see Amazon - Web Services services that work with IAM in the IAM User Guide. - Look for the services that have Yes in the Service-Linked - Role column. Choose the Yes link to view the service-linked - role documentation for that service.
' - CustomSuffix: - allOf: - - $ref: '#/components/schemas/customSuffixType' - - description:A string that you provide, which is combined with
- the service-provided prefix to form the complete role name. If you make
- multiple requests for the same service, then you must supply a different
- CustomSuffix for each request. Otherwise the request fails
- with a duplicate role name error. For example, you could add -1
- or -debug to the suffix.
Some services do not support
- the CustomSuffix parameter. If you provide an optional
- suffix and the operation fails, try the operation again without the
- suffix.
The name of the IAM user that is to be associated with - the credentials. The new service-specific credentials have the same - permissions as the associated user except that they can be used only - to access the specified service.
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: - _+=,.@-
' - required: - - UserName - - ServiceName - title: CreateServiceSpecificCredentialRequest - type: object - CreateServiceSpecificCredentialResponse: - properties: - ServiceSpecificCredential: - allOf: - - $ref: '#/components/schemas/ServiceSpecificCredential' - - description:A structure that contains information about the newly - created service-specific credential.
This is the - only time that the password for this credential set is available. It - cannot be recovered later. Instead, you must reset the password with - ResetServiceSpecificCredential.
The path for the user name. 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 new user. - 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.
-The name of the user 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".
- required: - - UserName - title: CreateUserRequest - type: object - CreateUserResponse: - description: 'Contains the response to a successful CreateUser request. ' - example: - User: - Arn: arn:aws:iam::123456789012:user/Bob - CreateDate: '2013-06-08T03:20:41.270Z' - Path: / - UserId: AKIAIOSFODNN7EXAMPLE - UserName: Bob - properties: - User: - allOf: - - $ref: '#/components/schemas/User' - - description: A structure with details about the new IAM user. - type: object - CreateVirtualMFADeviceRequest: - properties: - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description:The path for the virtual MFA device. 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 new IAM - virtual MFA device. 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.
-The name of the virtual MFA device. Use with path to - uniquely identify a virtual MFA device.
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: _+=,.@-
' - required: - - VirtualMFADeviceName - title: CreateVirtualMFADeviceRequest - type: object - CreateVirtualMFADeviceResponse: - description: 'Contains the response to a successful CreateVirtualMFADevice - request. ' - properties: - VirtualMFADevice: - allOf: - - $ref: '#/components/schemas/VirtualMFADevice' - - description: A structure containing details about the new virtual MFA - device. - required: - - VirtualMFADevice - type: object - CredentialReportExpiredException: {} - CredentialReportNotPresentException: {} - CredentialReportNotReadyException: {} - DeactivateMFADeviceRequest: - properties: - SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: 'The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the device ARN.
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: =,.@:/-
' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the user whose MFA device you want to deactivate.
-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: _+=,.@-
' - required: - - UserName - - SerialNumber - title: DeactivateMFADeviceRequest - type: object - DeleteAccessKeyRequest: - properties: - AccessKeyId: - allOf: - - $ref: '#/components/schemas/accessKeyIdType' - - description:The access key ID for the access key ID and secret access - key you want to delete.
This parameter allows (through its regex pattern) a string of - characters that can consist of any upper or lowercased letter or digit.
- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the user whose access key pair you want to - delete.
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: _+=,.@-
' - required: - - AccessKeyId - title: DeleteAccessKeyRequest - type: object - DeleteAccountAliasRequest: - properties: - AccountAlias: - allOf: - - $ref: '#/components/schemas/accountAliasType' - - description:The name of the account alias to delete.
This parameter - allows (through its regex - pattern) a string of characters consisting of lowercase letters, - digits, and dashes. You cannot start or finish with a dash, nor can - you have two dashes in a row.
- required: - - AccountAlias - title: DeleteAccountAliasRequest - type: object - DeleteConflictException: {} - DeleteGroupPolicyRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: 'The name (friendly name, not ARN) identifying the group - that the policy is embedded in.
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: - _+=,.@-
' - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: 'The name identifying the policy document to delete.
-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: _+=,.@-
' - required: - - GroupName - - PolicyName - title: DeleteGroupPolicyRequest - type: object - DeleteGroupRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: 'The name of the IAM group to delete.
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: _+=,.@-
' - required: - - GroupName - title: DeleteGroupRequest - type: object - DeleteInstanceProfileRequest: - properties: - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: 'The name of the instance profile to delete.
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: _+=,.@-
' - required: - - InstanceProfileName - title: DeleteInstanceProfileRequest - type: object - DeleteLoginProfileRequest: - properties: - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: 'The name of the user whose password you want to delete.
-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: _+=,.@-
' - required: - - UserName - title: DeleteLoginProfileRequest - type: object - DeleteOpenIDConnectProviderRequest: - properties: - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The Amazon Resource Name (ARN) of the IAM OpenID Connect - provider resource object to delete. You can get a list of OpenID Connect - provider resource ARNs by using the ListOpenIDConnectProviders - operation. - required: - - OpenIDConnectProviderArn - title: DeleteOpenIDConnectProviderRequest - type: object - DeletePolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to delete.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- required: - - PolicyArn - title: DeletePolicyRequest - type: object - DeletePolicyVersionRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The Amazon Resource Name (ARN) of the IAM policy from - which you want to delete a version.
For more information about - ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- VersionId: - allOf: - - $ref: '#/components/schemas/policyVersionIdType' - - description:The policy version to delete.
This parameter allows - (through its regex pattern) - a string of characters that consists of the lowercase letter 'v' followed - by one or two digits, and optionally followed by a period '.' and a - string of letters and digits.
For more information about managed - policy versions, see Versioning - for managed policies in the IAM User Guide.
- required: - - PolicyArn - - VersionId - title: DeletePolicyVersionRequest - type: object - DeleteRolePermissionsBoundaryRequest: - properties: - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The name (friendly name, not ARN) of the IAM role from which - you want to remove the permissions boundary. - required: - - RoleName - title: DeleteRolePermissionsBoundaryRequest - type: object - DeleteRolePolicyRequest: - properties: - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: 'The name of the inline policy to delete from the specified - IAM role.
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: _+=,.@-
' - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: 'The name (friendly name, not ARN) identifying the role - that the policy is embedded in.
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: - _+=,.@-
' - required: - - RoleName - - PolicyName - title: DeleteRolePolicyRequest - type: object - DeleteRoleRequest: - properties: - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: 'The name of the role to delete.
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: _+=,.@-
' - required: - - RoleName - title: DeleteRoleRequest - type: object - DeleteSAMLProviderRequest: - properties: - SAMLProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The Amazon Resource Name (ARN) of the SAML provider to delete. - required: - - SAMLProviderArn - title: DeleteSAMLProviderRequest - type: object - DeleteSSHPublicKeyRequest: - properties: - SSHPublicKeyId: - allOf: - - $ref: '#/components/schemas/publicKeyIdType' - - description:The unique identifier for the SSH public key.
This - parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.
- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: 'The name of the IAM user associated with the SSH public - key.
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: _+=,.@-
' - required: - - UserName - - SSHPublicKeyId - title: DeleteSSHPublicKeyRequest - type: object - DeleteServerCertificateRequest: - properties: - ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: 'The name of the server certificate you want to delete.
-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: _+=,.@-
' - required: - - ServerCertificateName - title: DeleteServerCertificateRequest - type: object - DeleteServiceLinkedRoleRequest: - properties: - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The name of the service-linked role to be deleted. - required: - - RoleName - title: DeleteServiceLinkedRoleRequest - type: object - DeleteServiceLinkedRoleResponse: - properties: - DeletionTaskId: - allOf: - - $ref: '#/components/schemas/DeletionTaskIdType' - - description: The deletion task identifier that you can use to check the - status of the deletion. This identifier is returned in the formattask/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
- required:
- - DeletionTaskId
- type: object
- DeleteServiceSpecificCredentialRequest:
- properties:
- ServiceSpecificCredentialId:
- allOf:
- - $ref: '#/components/schemas/serviceSpecificCredentialId'
- - description: The unique identifier of the service-specific credential. - You can get this value by calling ListServiceSpecificCredentials.
-This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.
- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: 'The name of the IAM user associated with the service-specific - credential. If this value is not specified, then the operation assumes - the user whose credentials are used to call the operation.
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: _+=,.@-
' - required: - - ServiceSpecificCredentialId - title: DeleteServiceSpecificCredentialRequest - type: object - DeleteSigningCertificateRequest: - properties: - CertificateId: - allOf: - - $ref: '#/components/schemas/certificateIdType' - - description:The ID of the signing certificate to delete.
The - format of this parameter, as described by its regex - pattern, is a string of characters that can be upper- or lower-cased - letters or digits.
- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the user the signing certificate belongs - to.
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: _+=,.@-
' - required: - - CertificateId - title: DeleteSigningCertificateRequest - type: object - DeleteUserPermissionsBoundaryRequest: - properties: - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name (friendly name, not ARN) of the IAM user from which - you want to remove the permissions boundary. - required: - - UserName - title: DeleteUserPermissionsBoundaryRequest - type: object - DeleteUserPolicyRequest: - properties: - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: 'The name identifying the policy document to delete.
-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: _+=,.@-
' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name (friendly name, not ARN) identifying the user - that the policy is embedded in.
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: - _+=,.@-
' - required: - - UserName - - PolicyName - title: DeleteUserPolicyRequest - type: object - DeleteUserRequest: - properties: - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the user to delete.
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: _+=,.@-
' - required: - - UserName - title: DeleteUserRequest - type: object - DeleteVirtualMFADeviceRequest: - properties: - SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: 'The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the same as the ARN.
-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: =,.@:/-
' - required: - - SerialNumber - title: DeleteVirtualMFADeviceRequest - type: object - DeletionTaskFailureReasonType: - description:The reason that the service-linked role deletion failed.
-This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus - operation.
- properties: - Reason: - allOf: - - $ref: '#/components/schemas/ReasonType' - - description: A short description of the reason that the service-linked - role deletion failed. - RoleUsageList: - allOf: - - $ref: '#/components/schemas/RoleUsageListType' - - description: A list of objects that contains details about the service-linked - role deletion failure, if that information is returned by the service. - If the service-linked role has active sessions or if any resources that - were used by the role have not been deleted from the linked service, - the role can't be deleted. This parameter includes a list of the resources - that are associated with the role and the Region in which the resources - are being used. - type: object - DeletionTaskIdType: - maxLength: 1000 - minLength: 1 - type: string - DeletionTaskStatusType: - enum: - - SUCCEEDED - - IN_PROGRESS - - FAILED - - NOT_STARTED - type: string - DetachGroupPolicyRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: 'The name (friendly name, not ARN) of the IAM group to - detach the policy from.
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: - _+=,.@-
' - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to detach.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- required: - - GroupName - - PolicyArn - title: DetachGroupPolicyRequest - type: object - DetachRolePolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to detach.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: 'The name (friendly name, not ARN) of the IAM role to - detach the policy from.
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: - _+=,.@-
' - required: - - RoleName - - PolicyArn - title: DetachRolePolicyRequest - type: object - DetachUserPolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to detach.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: 'The name (friendly name, not ARN) of the IAM user to - detach the policy from.
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: - _+=,.@-
' - required: - - UserName - - PolicyArn - title: DetachUserPolicyRequest - type: object - DuplicateCertificateException: {} - DuplicateSSHPublicKeyException: {} - EnableMFADeviceRequest: - properties: - AuthenticationCode1: - allOf: - - $ref: '#/components/schemas/authenticationCodeType' - - description:An authentication code emitted by the device.
The - format for this parameter is a string of six digits.
Submit your request immediately after generating the authentication - codes. If you generate the codes and then wait too long to submit the - request, the MFA device successfully associates with the user but the - MFA device becomes out of sync. This happens because time-based one-time - passwords (TOTP) expire after a short period of time. If this happens, - you can resync - the device.
A subsequent authentication code emitted by the device.
-The format for this parameter is a string of six digits.
Submit your request immediately after generating the authentication - codes. If you generate the codes and then wait too long to submit the - request, the MFA device successfully associates with the user but the - MFA device becomes out of sync. This happens because time-based one-time - passwords (TOTP) expire after a short period of time. If this happens, - you can resync - the device.
The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the device ARN.
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: =,.@:/-
' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the IAM user for whom you want to enable - the MFA device.
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: _+=,.@-
' - required: - - UserName - - SerialNumber - - AuthenticationCode1 - - AuthenticationCode2 - title: EnableMFADeviceRequest - type: object - EntityAlreadyExistsException: {} - EntityDetails: - description:An object that contains details about when the IAM entities - (users or roles) were last used in an attempt to access the specified Amazon - Web Services service.
This data type is a response element in the GetServiceLastAccessedDetailsWithEntities - operation.
- properties: - EntityInfo: - allOf: - - $ref: '#/components/schemas/EntityInfo' - - description: "The\_EntityInfo object that contains details\
- \ about the entity (user or role)."
- LastAuthenticated:
- allOf:
- - $ref: '#/components/schemas/dateType'
- - description: "The date and time, in\_ISO 8601 date-time format, when the authenticated entity last attempted\ - \ to access Amazon Web Services. Amazon Web Services does not report\ - \ unauthenticated requests.
This field is null if no IAM entities\ - \ attempted to access the service within the reporting period.
" - required: - - EntityInfo - type: object - EntityInfo: - description:Contains details about the specified entity (user or role).
-This data type is an element of the EntityDetails object.
- properties: - Arn: - $ref: '#/components/schemas/arnType' - Id: - allOf: - - $ref: '#/components/schemas/idType' - - description: The identifier of the entity (user or role). - Name: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name of the entity (user or role). - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description: 'The path to the entity (user or role). For more information - about paths, see IAM - identifiers in the IAM User Guide. ' - Type: - allOf: - - $ref: '#/components/schemas/policyOwnerEntityType' - - description: The type of entity (user or role). - required: - - Arn - - Name - - Type - - Id - type: object - EntityTemporarilyUnmodifiableException: {} - EntityType: - enum: - - User - - Role - - Group - - LocalManagedPolicy - - AWSManagedPolicy - type: string - ErrorDetails: - description:Contains information about the reason that the operation failed.
-This data type is used as a response element in the GetOrganizationsAccessReport, - GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities - operations.
- properties: - Code: - allOf: - - $ref: '#/components/schemas/stringType' - - description: The error code associated with the operation failure. - Message: - allOf: - - $ref: '#/components/schemas/stringType' - - description: Detailed information about the reason that the operation - failed. - required: - - Message - - Code - type: object - EvalDecisionDetailsType: - additionalProperties: - $ref: '#/components/schemas/PolicyEvaluationDecisionType' - type: object - EvalDecisionSourceType: - maxLength: 256 - minLength: 3 - type: string - EvaluationResult: - description:Contains the results of a simulation.
This data type
- is used by the return parameter of SimulateCustomPolicy
- and SimulatePrincipalPolicy .
Additional details about the results of the cross-account - evaluation decision. This parameter is populated for only cross-account - simulations. It contains a brief summary of how each policy type contributes - to the final evaluation decision.
If the simulation evaluates
- policies within the same account and includes a resource ARN, then the
- parameter is present but the response is empty. If the simulation evaluates
- policies within the same account and specifies all resources (*),
- then the parameter is not returned.
When you make a cross-account
- request, Amazon Web Services evaluates the request in the trusting account
- and the trusted account. The request is allowed only if both evaluations
- return true. For more information about how policies are
- evaluated, see Evaluating
- policies within a single account.
If an Organizations SCP - included in the evaluation denies access, the simulation ends. In this - case, policy evaluation does not proceed any further and this parameter - is not returned.
- EvalResourceName: - allOf: - - $ref: '#/components/schemas/ResourceNameType' - - description: The ARN of the resource that the indicated API operation - was tested on. - MatchedStatements: - allOf: - - $ref: '#/components/schemas/StatementListType' - - description: A list of the statements in the input policies that determine - the result for this scenario. Remember that even if multiple statements - allow the operation on the resource, if only one statement denies that - operation, then the explicit deny overrides any allow. In addition, - the deny statement is the only entry included in the result. - MissingContextValues: - allOf: - - $ref: '#/components/schemas/ContextKeyNamesResultListType' - - description: A list of context keys that are required by the included - input policies but that were not provided by one of the input parameters. - This list is used when the resource in a simulation is "*", either explicitly, - or when theResourceArns parameter blank. If you include
- a list of resources, then any missing context values are instead included
- under the ResourceSpecificResults section. To discover
- the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy
- or GetContextKeysForPrincipalPolicy.
- OrganizationsDecisionDetail:
- allOf:
- - $ref: '#/components/schemas/OrganizationsDecisionDetail'
- - description: A structure that details how Organizations and its service
- control policies affect the results of the simulation. Only applies
- if the simulated user's account is part of an organization.
- PermissionsBoundaryDecisionDetail:
- allOf:
- - $ref: '#/components/schemas/PermissionsBoundaryDecisionDetail'
- - description: Contains information about the effect that a permissions
- boundary has on a policy simulation when the boundary is applied to
- an IAM entity.
- ResourceSpecificResults:
- allOf:
- - $ref: '#/components/schemas/ResourceSpecificResultListType'
- - description: The individual results of the simulation of the API operation
- specified in EvalActionName on each resource.
- required:
- - EvalActionName
- - EvalDecision
- type: object
- EvaluationResultsListType:
- items:
- allOf:
- - $ref: '#/components/schemas/EvaluationResult'
- - xml:
- name: member
- type: array
- GenerateCredentialReportResponse:
- description: 'Contains the response to a successful GenerateCredentialReport
- request. '
- properties:
- Description:
- allOf:
- - $ref: '#/components/schemas/ReportStateDescriptionType'
- - description: Information about the credential report.
- State:
- allOf:
- - $ref: '#/components/schemas/ReportStateType'
- - description: Information about the state of the credential report.
- type: object
- GenerateOrganizationsAccessReportRequest:
- properties:
- EntityPath:
- allOf:
- - $ref: '#/components/schemas/organizationsEntityPathType'
- - description: The path of the Organizations entity (root, OU, or account).
- You can build an entity path using the known structure of your organization.
- For example, assume that your account ID is 123456789012
- and its parent OU ID is ou-rge0-awsabcde. The organization
- root ID is r-f6g7h8i9j0example and your organization ID
- is o-a1b2c3d4e5. Your entity path is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.
- OrganizationsPolicyId:
- allOf:
- - $ref: '#/components/schemas/organizationsPolicyIdType'
- - description: The identifier of the Organizations service control policy - (SCP). This parameter is optional.
This ID is used to generate - information about when an account principal that is limited by the SCP - attempted to access an Amazon Web Services service.
- required: - - EntityPath - title: GenerateOrganizationsAccessReportRequest - type: object - GenerateOrganizationsAccessReportResponse: - example: - JobId: examplea-1234-b567-cde8-90fg123abcd4 - properties: - JobId: - allOf: - - $ref: '#/components/schemas/jobIDType' - - description: The job identifier that you can use in the GetOrganizationsAccessReport - operation. - type: object - GenerateServiceLastAccessedDetailsRequest: - properties: - Arn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The ARN of the IAM resource (user, group, role, or managed - policy) used to generate information about when the resource was last - used in an attempt to access an Amazon Web Services service. - Granularity: - allOf: - - $ref: '#/components/schemas/AccessAdvisorUsageGranularityType' - - description: The level of detail that you want to generate. You can specify - whether you want to generate information about the last attempt to access - services or actions. If you specify service-level granularity, this - operation generates only service data. If you specify action-level granularity, - it generates service and action data. If you don't include this optional - parameter, the operation generates service data. - required: - - Arn - title: GenerateServiceLastAccessedDetailsRequest - type: object - GenerateServiceLastAccessedDetailsResponse: - example: - JobId: examplef-1305-c245-eba4-71fe298bcda7 - properties: - JobId: - allOf: - - $ref: '#/components/schemas/jobIDType' - - description: TheJobId that you can use in the GetServiceLastAccessedDetails
- or GetServiceLastAccessedDetailsWithEntities operations. The
- JobId returned by GenerateServiceLastAccessedDetail
- must be used by the same role within a session, or by the same user
- when used to call GetServiceLastAccessedDetail.
- type: object
- GetAccessKeyLastUsedRequest:
- properties:
- AccessKeyId:
- allOf:
- - $ref: '#/components/schemas/accessKeyIdType'
- - description: The identifier of an access key.
This parameter - allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.
- required: - - AccessKeyId - title: GetAccessKeyLastUsedRequest - type: object - GetAccessKeyLastUsedResponse: - description: Contains the response to a successful GetAccessKeyLastUsed - request. It is also returned as a member of the AccessKeyMetaData structure - returned by the ListAccessKeys action. - properties: - AccessKeyLastUsed: - allOf: - - $ref: '#/components/schemas/AccessKeyLastUsed' - - description: Contains information about the last time the access key was - used. - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description:The name of the IAM user that owns this access key.
- - type: object - GetAccountAuthorizationDetailsRequest: - properties: - Filter: - allOf: - - $ref: '#/components/schemas/entityListType' - - description:A list of entity types used to filter the results. Only
- the entities that match the types you specify are included in the output.
- Use the value LocalManagedPolicy to include customer managed
- policies.
The format for this parameter is a comma-separated - (if more than one) list of strings. Each string value in the list must - be one of the valid values listed below.
- Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of theMarker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Policies:
- allOf:
- - $ref: '#/components/schemas/ManagedPolicyDetailListType'
- - description: A list containing information about managed policies.
- RoleDetailList:
- allOf:
- - $ref: '#/components/schemas/roleDetailListType'
- - description: A list containing information about IAM roles.
- UserDetailList:
- allOf:
- - $ref: '#/components/schemas/userDetailListType'
- - description: A list containing information about IAM users.
- type: object
- GetAccountPasswordPolicyResponse:
- description: 'Contains the response to a successful GetAccountPasswordPolicy
- request. '
- example:
- PasswordPolicy:
- AllowUsersToChangePassword: false
- ExpirePasswords: false
- HardExpiry: false
- MaxPasswordAge: 90
- MinimumPasswordLength: 8
- PasswordReusePrevention: 12
- RequireLowercaseCharacters: false
- RequireNumbers: true
- RequireSymbols: true
- RequireUppercaseCharacters: false
- properties:
- PasswordPolicy:
- allOf:
- - $ref: '#/components/schemas/PasswordPolicy'
- - description: A structure that contains details about the account's password
- policy.
- required:
- - PasswordPolicy
- type: object
- GetAccountSummaryResponse:
- description: 'Contains the response to a successful GetAccountSummary
- request. '
- example:
- SummaryMap:
- AccessKeysPerUserQuota: 2
- AccountAccessKeysPresent: 1
- AccountMFAEnabled: 0
- AccountSigningCertificatesPresent: 0
- AttachedPoliciesPerGroupQuota: 10
- AttachedPoliciesPerRoleQuota: 10
- AttachedPoliciesPerUserQuota: 10
- GlobalEndpointTokenVersion: 2
- GroupPolicySizeQuota: 5120
- Groups: 15
- GroupsPerUserQuota: 10
- GroupsQuota: 100
- MFADevices: 6
- MFADevicesInUse: 3
- Policies: 8
- PoliciesQuota: 1000
- PolicySizeQuota: 5120
- PolicyVersionsInUse: 22
- PolicyVersionsInUseQuota: 10000
- ServerCertificates: 1
- ServerCertificatesQuota: 20
- SigningCertificatesPerUserQuota: 2
- UserPolicySizeQuota: 2048
- Users: 27
- UsersQuota: 5000
- VersionsPerPolicyQuota: 5
- properties:
- SummaryMap:
- allOf:
- - $ref: '#/components/schemas/summaryMapType'
- - description: "A set of key\u2013value pairs containing information about\
- \ IAM entity usage and IAM quotas."
- type: object
- GetContextKeysForCustomPolicyRequest:
- properties:
- PolicyInputList:
- allOf:
- - $ref: '#/components/schemas/SimulationPolicyListType'
- - description: A list of policies for which you want the list of context - keys referenced in those policies. Each document is specified as a string - containing the complete, valid JSON text of an IAM policy.
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)
An optional list of additional policies for which you - want the list of context keys that are referenced.
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)
The ARN of a user, group, or role whose policies contain - the context keys that you want listed. If you specify a user, the list - includes context keys that are found in all policies that are attached - to the user. The list also includes all groups that the user is a member - of. If you pick a group or a role, then it includes only those context - keys that are found in policies attached to that entity. Note that all - parameters are shown in unencoded form here for clarity, but must be - URL encoded to be included as a part of a real HTML request.
For - more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- required: - - PolicySourceArn - title: GetContextKeysForPrincipalPolicyRequest - type: object - GetCredentialReportResponse: - description: 'Contains the response to a successful GetCredentialReport - request. ' - properties: - Content: - allOf: - - $ref: '#/components/schemas/ReportContentType' - - description: Contains the credential report. The report is Base64-encoded. - GeneratedTime: - allOf: - - $ref: '#/components/schemas/dateType' - - description: ' The date and time when the credential report was created, - in ISO 8601 date-time format.' - ReportFormat: - allOf: - - $ref: '#/components/schemas/ReportFormatType' - - description: The format (MIME type) of the credential report. - type: object - GetGroupPolicyRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: 'The name of the group the policy is associated with.
-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: _+=,.@-
' - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: 'The name of the policy document to get.
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: _+=,.@-
' - required: - - GroupName - - PolicyName - title: GetGroupPolicyRequest - type: object - GetGroupPolicyResponse: - description: 'Contains the response to a successful GetGroupPolicy request. ' - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: The group the policy is associated with. - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:The policy document.
IAM stores policies in JSON - format. However, resources that were created using CloudFormation templates - can be formatted in YAML. CloudFormation always converts a YAML policy - to JSON format before submitting it to IAM.
- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The name of the policy. - required: - - GroupName - - PolicyName - - PolicyDocument - type: object - GetGroupRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: 'The name of the group.
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: - _+=,.@-
' - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of theMarker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Users:
- allOf:
- - $ref: '#/components/schemas/userListType'
- - description: A list of users in the group.
- required:
- - Group
- - Users
- type: object
- GetInstanceProfileRequest:
- properties:
- InstanceProfileName:
- allOf:
- - $ref: '#/components/schemas/instanceProfileNameType'
- - description: 'The name of the instance profile to get information about.
-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: _+=,.@-
' - required: - - InstanceProfileName - title: GetInstanceProfileRequest - type: object - GetInstanceProfileResponse: - description: 'Contains the response to a successful GetInstanceProfile - request. ' - example: - InstanceProfile: - Arn: arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile - CreateDate: '2013-06-12T23:52:02Z' - InstanceProfileId: AID2MAB8DPLSRHEXAMPLE - InstanceProfileName: ExampleInstanceProfile - Path: / - Roles: - - Arn: arn:aws:iam::336924118301:role/Test-Role - AssumeRolePolicyDocument:The name of the user whose login profile you want to - retrieve.
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: _+=,.@-
' - required: - - UserName - title: GetLoginProfileRequest - type: object - GetLoginProfileResponse: - description: 'Contains the response to a successful GetLoginProfile request. ' - example: - LoginProfile: - CreateDate: '2012-09-21T23:03:39Z' - UserName: Anika - properties: - LoginProfile: - allOf: - - $ref: '#/components/schemas/LoginProfile' - - description: A structure containing the user name and the profile creation - date for the user. - required: - - LoginProfile - type: object - GetOpenIDConnectProviderRequest: - properties: - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The Amazon Resource Name (ARN) of the OIDC provider resource - object in IAM to get information for. You can get a list of OIDC provider - resource ARNs by using the ListOpenIDConnectProviders operation.
-For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- required: - - OpenIDConnectProviderArn - title: GetOpenIDConnectProviderRequest - type: object - GetOpenIDConnectProviderResponse: - description: 'Contains the response to a successful GetOpenIDConnectProvider - request. ' - properties: - ClientIDList: - allOf: - - $ref: '#/components/schemas/clientIDListType' - - description: A list of client IDs (also known as audiences) that are associated - with the specified IAM OIDC provider resource object. For more information, - see CreateOpenIDConnectProvider. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time when the IAM OIDC provider resource object - was created in the Amazon Web Services account. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the specified IAM OIDC - provider. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - ThumbprintList: - allOf: - - $ref: '#/components/schemas/thumbprintListType' - - description: 'A list of certificate thumbprints that are associated with - the specified IAM OIDC provider resource object. For more information, - see CreateOpenIDConnectProvider. ' - Url: - allOf: - - $ref: '#/components/schemas/OpenIDConnectProviderUrlType' - - description: The URL that the IAM OIDC provider resource object is associated - with. For more information, see CreateOpenIDConnectProvider. - type: object - GetOrganizationsAccessReportRequest: - properties: - JobId: - allOf: - - $ref: '#/components/schemas/jobIDType' - - description: The identifier of the request generated by the GenerateOrganizationsAccessReport - operation. - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of theMarker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- JobCompletionDate:
- allOf:
- - $ref: '#/components/schemas/dateType'
- - description: "The date and time, in\_ISO 8601 date-time format, when the generated report job was completed\ - \ or failed.
This field is null if the job is still in progress,\
- \ as indicated by a job status value of IN_PROGRESS.
IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- NumberOfServicesAccessible:
- allOf:
- - $ref: '#/components/schemas/integerType'
- - description: The number of services that the applicable SCPs allow account
- principals to access.
- NumberOfServicesNotAccessed:
- allOf:
- - $ref: '#/components/schemas/integerType'
- - description: The number of services that account principals are allowed
- but did not attempt to access.
- required:
- - JobStatus
- - JobCreationDate
- type: object
- GetPolicyRequest:
- properties:
- PolicyArn:
- allOf:
- - $ref: '#/components/schemas/arnType'
- - description: The Amazon Resource Name (ARN) of the managed policy that - you want information about.
For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- required: - - PolicyArn - title: GetPolicyRequest - type: object - GetPolicyResponse: - description: 'Contains the response to a successful GetPolicy request. ' - properties: - Policy: - allOf: - - $ref: '#/components/schemas/Policy' - - description: A structure containing details about the policy. - type: object - GetPolicyVersionRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The Amazon Resource Name (ARN) of the managed policy that - you want information about.
For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- VersionId: - allOf: - - $ref: '#/components/schemas/policyVersionIdType' - - description:Identifies the policy version to retrieve.
This - parameter allows (through its regex - pattern) a string of characters that consists of the lowercase letter - 'v' followed by one or two digits, and optionally followed by a period - '.' and a string of letters and digits.
- required: - - PolicyArn - - VersionId - title: GetPolicyVersionRequest - type: object - GetPolicyVersionResponse: - description: 'Contains the response to a successful GetPolicyVersion - request. ' - properties: - PolicyVersion: - allOf: - - $ref: '#/components/schemas/PolicyVersion' - - description: A structure containing details about the policy version. - type: object - GetRolePolicyRequest: - properties: - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: 'The name of the policy document to get.
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: _+=,.@-
' - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: 'The name of the role associated with the policy.
-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: _+=,.@-
' - required: - - RoleName - - PolicyName - title: GetRolePolicyRequest - type: object - GetRolePolicyResponse: - description: 'Contains the response to a successful GetRolePolicy request. ' - properties: - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:The policy document.
IAM stores policies in JSON - format. However, resources that were created using CloudFormation templates - can be formatted in YAML. CloudFormation always converts a YAML policy - to JSON format before submitting it to IAM.
- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The name of the policy. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The role the policy is associated with. - required: - - RoleName - - PolicyName - - PolicyDocument - type: object - GetRoleRequest: - properties: - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: 'The name of the IAM role to get information about.
-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: _+=,.@-
' - required: - - RoleName - title: GetRoleRequest - type: object - GetRoleResponse: - description: 'Contains the response to a successful GetRole request. ' - example: - Role: - Arn: arn:aws:iam::123456789012:role/Test-Role - AssumeRolePolicyDocument:The Amazon Resource Name (ARN) of the SAML provider resource - object in IAM to get information about.
For more information - about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- required: - - SAMLProviderArn - title: GetSAMLProviderRequest - type: object - GetSAMLProviderResponse: - description: 'Contains the response to a successful GetSAMLProvider request. ' - properties: - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time when the SAML provider was created. - SAMLMetadataDocument: - allOf: - - $ref: '#/components/schemas/SAMLMetadataDocumentType' - - description: The XML metadata document that includes information about - an identity provider. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the specified IAM SAML - provider. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - ValidUntil: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The expiration date and time for the SAML provider. - type: object - GetSSHPublicKeyRequest: - properties: - Encoding: - allOf: - - $ref: '#/components/schemas/encodingType' - - description: Specifies the public key encoding format to use in the response. - To retrieve the public key in ssh-rsa format, useSSH.
- To retrieve the public key in PEM format, use PEM.
- SSHPublicKeyId:
- allOf:
- - $ref: '#/components/schemas/publicKeyIdType'
- - description: The unique identifier for the SSH public key.
This - parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.
- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: 'The name of the IAM user associated with the SSH public - key.
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: _+=,.@-
' - required: - - UserName - - SSHPublicKeyId - - Encoding - title: GetSSHPublicKeyRequest - type: object - GetSSHPublicKeyResponse: - description: Contains the response to a successful GetSSHPublicKey request. - properties: - SSHPublicKey: - allOf: - - $ref: '#/components/schemas/SSHPublicKey' - - description: A structure containing details about the SSH public key. - type: object - GetServerCertificateRequest: - properties: - ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: 'The name of the server certificate you want to retrieve - information about.
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: _+=,.@-
' - required: - - ServerCertificateName - title: GetServerCertificateRequest - type: object - GetServerCertificateResponse: - description: 'Contains the response to a successful GetServerCertificate - request. ' - properties: - ServerCertificate: - allOf: - - $ref: '#/components/schemas/ServerCertificate' - - description: A structure containing details about the server certificate. - required: - - ServerCertificate - type: object - GetServiceLastAccessedDetailsRequest: - properties: - JobId: - allOf: - - $ref: '#/components/schemas/jobIDType' - - description: The ID of the request generated by the GenerateServiceLastAccessedDetails - operation. TheJobId returned by GenerateServiceLastAccessedDetail
- must be used by the same role within a session, or by the same user
- when used to call GetServiceLastAccessedDetail.
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- JobCompletionDate:
- allOf:
- - $ref: '#/components/schemas/dateType'
- - description: "The date and time, in\_ISO 8601 date-time format, when the generated report job was completed\ - \ or failed.
This field is null if the job is still in progress,\
- \ as indicated by a job status value of IN_PROGRESS.
IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- ServicesLastAccessed:
- allOf:
- - $ref: '#/components/schemas/ServicesLastAccessed'
- - description: " A\_ServiceLastAccessed object that contains\
- \ details about the most recent attempt to access the service."
- required:
- - JobStatus
- - JobCreationDate
- - ServicesLastAccessed
- - JobCompletionDate
- type: object
- GetServiceLastAccessedDetailsWithEntitiesRequest:
- properties:
- JobId:
- allOf:
- - $ref: '#/components/schemas/jobIDType'
- - description: The ID of the request generated by the GenerateServiceLastAccessedDetails
- operation.
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The service namespace for an Amazon Web Services service.\ - \ Provide the service namespace to learn when the IAM entity last attempted\ - \ to access the specified service.
To learn the service namespace\
- \ for a service, see Actions, resources, and condition keys for Amazon Web Services services\
- \ in the IAM User Guide. Choose the name of the service to view\
- \ details for that service. In the first paragraph, find the service\
- \ prefix. For example, (service prefix: a4b). For more\
- \ information about service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\
- \ General Reference.
EntityDetailsList object that contains\
- \ details about when an IAM entity (user or role) used group or policy\
- \ permissions in an attempt to access the specified Amazon Web Services\
- \ service."
- Error:
- allOf:
- - $ref: '#/components/schemas/ErrorDetails'
- - description: An object that contains details about the reason the operation
- failed.
- IsTruncated:
- allOf:
- - $ref: '#/components/schemas/booleanType'
- - description: A flag that indicates whether there are more items to return.
- If your results were truncated, you can make a subsequent pagination
- request using the Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- JobCompletionDate:
- allOf:
- - $ref: '#/components/schemas/dateType'
- - description: "The date and time, in\_ISO 8601 date-time format, when the generated report job was completed\ - \ or failed.
This field is null if the job is still in progress,\
- \ as indicated by a job status value of IN_PROGRESS.
IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- required:
- - JobStatus
- - JobCreationDate
- - JobCompletionDate
- - EntityDetailsList
- type: object
- GetServiceLinkedRoleDeletionStatusRequest:
- properties:
- DeletionTaskId:
- allOf:
- - $ref: '#/components/schemas/DeletionTaskIdType'
- - description: The deletion task identifier. This identifier is returned
- by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
- required:
- - DeletionTaskId
- title: GetServiceLinkedRoleDeletionStatusRequest
- type: object
- GetServiceLinkedRoleDeletionStatusResponse:
- properties:
- Reason:
- allOf:
- - $ref: '#/components/schemas/DeletionTaskFailureReasonType'
- - description: An object that contains details about the reason the deletion
- failed.
- Status:
- allOf:
- - $ref: '#/components/schemas/DeletionTaskStatusType'
- - description: The status of the deletion.
- required:
- - Status
- type: object
- GetUserPolicyRequest:
- properties:
- PolicyName:
- allOf:
- - $ref: '#/components/schemas/policyNameType'
- - description: 'The name of the policy document to get.
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: _+=,.@-
' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the user who the policy is associated with.
-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: _+=,.@-
' - required: - - UserName - - PolicyName - title: GetUserPolicyRequest - type: object - GetUserPolicyResponse: - description: 'Contains the response to a successful GetUserPolicy request. ' - properties: - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:The policy document.
IAM stores policies in JSON - format. However, resources that were created using CloudFormation templates - can be formatted in YAML. CloudFormation always converts a YAML policy - to JSON format before submitting it to IAM.
- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The name of the policy. - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: The user the policy is associated with. - required: - - UserName - - PolicyName - - PolicyDocument - type: object - GetUserRequest: - properties: - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the user to get information about.
This - parameter is optional. If it is not included, it defaults to the user - making the request. 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: _+=,.@-
' - title: GetUserRequest - type: object - GetUserResponse: - description: 'Contains the response to a successful GetUser request. ' - example: - User: - Arn: arn:aws:iam::123456789012:user/Bob - CreateDate: '2012-09-21T23:03:13Z' - Path: / - UserId: AKIAIOSFODNN7EXAMPLE - UserName: Bob - properties: - User: - allOf: - - $ref: '#/components/schemas/User' - - description:A structure containing details about the IAM user.
-Due to a service issue, password last used data does - not include password use from May 3, 2018 22:50 PDT to May 23, 2018 - 14:08 PDT. This affects last - sign-in dates shown in the IAM console and password last used dates - in the IAM - credential report, and returned by this operation. If users signed - in during the affected time, the password last used date that is returned - is the date the user last signed in before May 3, 2018. For users that - signed in after May 23, 2018 14:08 PDT, the returned password last used - date is accurate.
You can use password last used information - to identify unused credentials for deletion. For example, you might - delete users who did not sign in to Amazon Web Services in the last - 90 days. In cases like this, we recommend that you adjust your evaluation - window to include dates after May 23, 2018. Alternatively, if your users - use access keys to access Amazon Web Services programmatically you can - refer to access key last used information because it is accurate for - all dates.
Contains information about an IAM group entity.
This - data type is used as a response element in the following operations:
- properties: - 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. - 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. ' - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: The friendly name that identifies the group. - 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. ' - required: - - Path - - GroupName - - GroupId - - Arn - - CreateDate - type: object - GroupDetail: - description:Contains information about an IAM group, including all of the - group's policies.
This data type is used as a response element in the - GetAccountAuthorizationDetails operation.
- properties: - Arn: - $ref: '#/components/schemas/arnType' - AttachedManagedPolicies: - allOf: - - $ref: '#/components/schemas/attachedPoliciesListType' - - description: A list of the managed policies attached to the group. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the group was created. - 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. - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: The friendly name that identifies the group. - GroupPolicyList: - allOf: - - $ref: '#/components/schemas/policyDetailListType' - - description: A list of the inline policies embedded in the group. - 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. - type: object - InstanceProfile: - description:Contains information about an instance profile.
This - data type is used as a response element in the following operations:
- properties: - 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. - 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. ' - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: The name identifying the instance profile. - 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. ' - 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. - required: - - Path - - InstanceProfileName - - InstanceProfileId - - Arn - - CreateDate - - Roles - type: object - InvalidAuthenticationCodeException: {} - InvalidCertificateException: {} - InvalidInputException: {} - InvalidPublicKeyException: {} - InvalidUserTypeException: {} - KeyPairMismatchException: {} - LimitExceededException: {} - LineNumber: - type: integer - ListAccessKeysRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of theMarker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The name of the user.
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: - _+=,.@-
' - title: ListAccessKeysRequest - type: object - ListAccessKeysResponse: - description: 'Contains the response to a successful ListAccessKeys request. ' - example: - AccessKeyMetadata: - - AccessKeyId: AKIA111111111EXAMPLE - CreateDate: '2016-12-01T22:19:58Z' - Status: Active - UserName: Alice - - AccessKeyId: AKIA222222222EXAMPLE - CreateDate: '2016-12-01T22:20:01Z' - Status: Active - UserName: Alice - properties: - AccessKeyMetadata: - allOf: - - $ref: '#/components/schemas/accessKeyMetadataListType' - - description: A list of objects containing metadata about the access keys. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- required:
- - AccessKeyMetadata
- type: object
- ListAccountAliasesRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- required:
- - AccountAliases
- type: object
- ListAttachedGroupPoliciesRequest:
- properties:
- GroupName:
- allOf:
- - $ref: '#/components/schemas/groupNameType'
- - description: 'The name (friendly name, not ARN) of the group to list - attached policies for.
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: - _+=,.@-
' - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of theMarker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies.
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.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- type: object
- ListAttachedRolePoliciesRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies.
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 (friendly name, not ARN) of the role to list - attached policies for.
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: - _+=,.@-
' - required: - - RoleName - title: ListAttachedRolePoliciesRequest - type: object - ListAttachedRolePoliciesResponse: - description: 'Contains the response to a successful ListAttachedRolePolicies - request. ' - properties: - AttachedPolicies: - allOf: - - $ref: '#/components/schemas/attachedPoliciesListType' - - description: A list of the attached policies. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- type: object
- ListAttachedUserPoliciesRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies.
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 (friendly name, not ARN) of the user to list - attached policies for.
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: - _+=,.@-
' - required: - - UserName - title: ListAttachedUserPoliciesRequest - type: object - ListAttachedUserPoliciesResponse: - description: 'Contains the response to a successful ListAttachedUserPolicies - request. ' - properties: - AttachedPolicies: - allOf: - - $ref: '#/components/schemas/attachedPoliciesListType' - - description: A list of the attached policies. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- type: object
- ListEntitiesForPolicyRequest:
- properties:
- EntityFilter:
- allOf:
- - $ref: '#/components/schemas/EntityType'
- - description: The entity type to use for filtering the results.
-For example, when EntityFilter is Role,
- only the roles that are attached to the specified policy are returned.
- This parameter is optional. If it is not included, all attached entities
- (users, groups, and roles) are returned. The argument for this parameter
- must be one of the valid values listed below.
Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all entities.
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 Amazon Resource Name (ARN) of the IAM policy for which - you want the versions.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- PolicyUsageFilter: - allOf: - - $ref: '#/components/schemas/PolicyUsageType' - - description: "The policy usage method to use for filtering the results.
\ - \To list only permissions policies, set\_PolicyUsageFilter\_\
- to\_PermissionsPolicy. To list only the policies used to\
- \ set permissions boundaries, set\_the value to\_PermissionsBoundary.
This parameter is optional. If it is not included, all policies\ - \ are returned.
" - required: - - PolicyArn - title: ListEntitiesForPolicyRequest - type: object - ListEntitiesForPolicyResponse: - description: 'Contains the response to a successful ListEntitiesForPolicy - request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- PolicyGroups:
- allOf:
- - $ref: '#/components/schemas/PolicyGroupListType'
- - description: A list of IAM groups that the policy is attached to.
- PolicyRoles:
- allOf:
- - $ref: '#/components/schemas/PolicyRoleListType'
- - description: A list of IAM roles that the policy is attached to.
- PolicyUsers:
- allOf:
- - $ref: '#/components/schemas/PolicyUserListType'
- - description: A list of IAM users that the policy is attached to.
- type: object
- ListGroupPoliciesRequest:
- properties:
- GroupName:
- allOf:
- - $ref: '#/components/schemas/groupNameType'
- - description: 'The name of the group to list policies for.
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: _+=,.@-
' - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of theMarker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- PolicyNames:
- allOf:
- - $ref: '#/components/schemas/policyNameListType'
- - description: 'A list of policy names.
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: _+=,.@-
' - required: - - PolicyNames - type: object - ListGroupsForUserRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of theMarker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The name of the user to list groups for.
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: _+=,.@-
' - required: - - UserName - title: ListGroupsForUserRequest - type: object - ListGroupsForUserResponse: - description: 'Contains the response to a successful ListGroupsForUser - request. ' - example: - Groups: - - Arn: arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test - CreateDate: '2016-11-30T14:10:01.156Z' - GroupId: AGP2111111111EXAMPLE - GroupName: Test - Path: /division_abc/subdivision_xyz/product_1234/engineering/ - - Arn: arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers - CreateDate: '2016-06-12T20:14:52.032Z' - GroupId: AGPI222222222SEXAMPLE - GroupName: Managers - Path: /division_abc/subdivision_xyz/product_1234/ - properties: - Groups: - allOf: - - $ref: '#/components/schemas/groupListType' - - description: A list of groups. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- required:
- - Groups
- type: object
- ListGroupsRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The path prefix for filtering the results. For example,
- the prefix /division_abc/subdivision_xyz/ gets all groups
- whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to
- a slash (/), listing all groups. 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.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- required:
- - Groups
- type: object
- ListInstanceProfileTagsRequest:
- properties:
- InstanceProfileName:
- allOf:
- - $ref: '#/components/schemas/instanceProfileNameType'
- - description: 'The name of the IAM instance profile whose tags you want - to see.
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: _+=,.@-
' - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of theMarker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Tags:
- allOf:
- - $ref: '#/components/schemas/tagListType'
- - description: The list of tags that are currently attached to the IAM instance
- profile. Each tag consists of a key name and an associated value. If
- no tags are attached to the specified resource, the response contains
- an empty list.
- required:
- - Tags
- type: object
- ListInstanceProfilesForRoleRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The name of the role to list instance profiles for.
-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: _+=,.@-
' - required: - - RoleName - title: ListInstanceProfilesForRoleRequest - type: object - ListInstanceProfilesForRoleResponse: - description: 'Contains the response to a successful ListInstanceProfilesForRole - request. ' - properties: - InstanceProfiles: - allOf: - - $ref: '#/components/schemas/instanceProfileListType' - - description: A list of instance profiles. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- required:
- - InstanceProfiles
- type: object
- ListInstanceProfilesRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The path prefix for filtering the results. For example,
- the prefix /application_abc/component_xyz/ gets all instance
- profiles whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to
- a slash (/), listing all instance profiles. 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.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- required:
- - InstanceProfiles
- type: object
- ListMFADeviceTagsRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The unique identifier for the IAM virtual MFA device - whose tags you want to see. For virtual MFA devices, the serial number - is the same as the ARN.
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: - _+=,.@-
' - required: - - SerialNumber - title: ListMFADeviceTagsRequest - type: object - ListMFADeviceTagsResponse: - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Tags:
- allOf:
- - $ref: '#/components/schemas/tagListType'
- - description: The list of tags that are currently attached to the virtual
- MFA device. Each tag consists of a key name and an associated value.
- If no tags are attached to the specified resource, the response contains
- an empty list.
- required:
- - Tags
- type: object
- ListMFADevicesRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The name of the user whose MFA devices you want to list.
-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: _+=,.@-
' - title: ListMFADevicesRequest - type: object - ListMFADevicesResponse: - description: 'Contains the response to a successful ListMFADevices request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- MFADevices:
- allOf:
- - $ref: '#/components/schemas/mfaDeviceListType'
- - description: A list of MFA devices.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- required:
- - MFADevices
- type: object
- ListOpenIDConnectProviderTagsRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The ARN of the OpenID Connect (OIDC) identity provider - whose tags you want to see.
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: - _+=,.@-
' - required: - - OpenIDConnectProviderArn - title: ListOpenIDConnectProviderTagsRequest - type: object - ListOpenIDConnectProviderTagsResponse: - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Tags:
- allOf:
- - $ref: '#/components/schemas/tagListType'
- - description: The list of tags that are currently attached to the OpenID
- Connect (OIDC) identity provider. Each tag consists of a key name and
- an associated value. If no tags are attached to the specified resource,
- the response contains an empty list.
- required:
- - Tags
- type: object
- ListOpenIDConnectProvidersRequest:
- properties: {}
- title: ListOpenIDConnectProvidersRequest
- type: object
- ListOpenIDConnectProvidersResponse:
- description: 'Contains the response to a successful ListOpenIDConnectProviders
- request. '
- properties:
- OpenIDConnectProviderList:
- allOf:
- - $ref: '#/components/schemas/OpenIDConnectProviderListType'
- - description: The list of IAM OIDC provider resource objects defined in
- the Amazon Web Services account.
- type: object
- ListPoliciesGrantingServiceAccessEntry:
- description: Contains details about the permissions policies that are attached - to the specified identity (user, group, or role).
This data type is - used as a response element in the ListPoliciesGrantingServiceAccess - operation.
- properties: - Policies: - allOf: - - $ref: '#/components/schemas/policyGrantingServiceAccessListType' - - description: "The\_PoliciesGrantingServiceAccess object that\
- \ contains details about the policy."
- ServiceNamespace:
- allOf:
- - $ref: '#/components/schemas/serviceNamespaceType'
- - description: "The namespace of the service that was accessed.
To\
- \ learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services\
- \ in the Service Authorization Reference. Choose the name of\
- \ the service to view details for that service. In the first paragraph,\
- \ find the service prefix. For example, (service prefix: a4b).\
- \ For more information about service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\
- \ General Reference.
Marker element in the response
- that you received to indicate where the next call should start.
- ServiceNamespaces:
- allOf:
- - $ref: '#/components/schemas/serviceNamespaceListType'
- - description: "The service namespace for the Amazon Web Services services\ - \ whose policies you want to list.
To learn the service namespace\
- \ for a service, see Actions, resources, and condition keys for Amazon Web Services services\
- \ in the IAM User Guide. Choose the name of the service to view\
- \ details for that service. In the first paragraph, find the service\
- \ prefix. For example, (service prefix: a4b). For more\
- \ information about service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\
- \ General Reference.
Marker request parameter to retrieve
- more items. We recommend that you check IsTruncated after
- every call to ensure that you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- PoliciesGrantingServiceAccess:
- allOf:
- - $ref: '#/components/schemas/listPolicyGrantingServiceAccessResponseListType'
- - description: "A\_ListPoliciesGrantingServiceAccess object\
- \ that contains details about the permissions policies attached to the\
- \ specified identity (user, group, or role)."
- required:
- - PoliciesGrantingServiceAccess
- type: object
- ListPoliciesRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
A flag to filter the results to only the attached policies.
-When OnlyAttached is true, the returned
- list contains only the policies that are attached to an IAM user, group,
- or role. When OnlyAttached is false, or when
- the parameter is not included, all policies are returned.
\u0021)
- through the DEL character (\u007F), including most punctuation
- characters, digits, and upper and lowercased letters.
- PolicyUsageFilter:
- allOf:
- - $ref: '#/components/schemas/PolicyUsageType'
- - description: "The policy usage method to use for filtering the results.
\ - \To list only permissions policies, set\_PolicyUsageFilter\_\
- to\_PermissionsPolicy. To list only the policies used to\
- \ set permissions boundaries, set\_the value to\_PermissionsBoundary.
This parameter is optional. If it is not included, all policies\ - \ are returned.
" - Scope: - allOf: - - $ref: '#/components/schemas/policyScopeType' - - description:The scope to use for filtering the results.
To
- list only Amazon Web Services managed policies, set Scope
- to AWS. To list only the customer managed policies in your
- Amazon Web Services account, set Scope to Local.
This parameter is optional. If it is not included, or if it is set
- to All, all policies are returned.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Policies:
- allOf:
- - $ref: '#/components/schemas/policyListType'
- - description: A list of policies.
- type: object
- ListPolicyTagsRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The ARN of the IAM customer managed policy whose tags - you want to see.
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: _+=,.@-
' - required: - - PolicyArn - title: ListPolicyTagsRequest - type: object - ListPolicyTagsResponse: - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Tags:
- allOf:
- - $ref: '#/components/schemas/tagListType'
- - description: The list of tags that are currently attached to the IAM customer
- managed policy. Each tag consists of a key name and an associated value.
- If no tags are attached to the specified resource, the response contains
- an empty list.
- required:
- - Tags
- type: object
- ListPolicyVersionsRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The Amazon Resource Name (ARN) of the IAM policy for which - you want the versions.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- required: - - PolicyArn - title: ListPolicyVersionsRequest - type: object - ListPolicyVersionsResponse: - description: 'Contains the response to a successful ListPolicyVersions - request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Versions:
- allOf:
- - $ref: '#/components/schemas/policyDocumentVersionListType'
- - description: A list of policy versions.
For more information - about managed policy versions, see Versioning - for managed policies in the IAM User Guide.
- type: object - ListRolePoliciesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of theMarker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The name of the role to list policies for.
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: _+=,.@-
' - required: - - RoleName - title: ListRolePoliciesRequest - type: object - ListRolePoliciesResponse: - description: 'Contains the response to a successful ListRolePolicies - request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- PolicyNames:
- allOf:
- - $ref: '#/components/schemas/policyNameListType'
- - description: A list of policy names.
- required:
- - PolicyNames
- type: object
- ListRoleTagsRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The name of the IAM role for which you want to see the - list of tags.
This parameter accepts (through its regex - pattern) a string of characters that consist of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-
' - required: - - RoleName - title: ListRoleTagsRequest - type: object - ListRoleTagsResponse: - example: - IsTruncated: false - Tags: - - Key: Dept - Value: '12345' - - Key: Team - Value: Accounting - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Tags:
- allOf:
- - $ref: '#/components/schemas/tagListType'
- - description: The list of tags that are currently attached to the role.
- Each tag consists of a key name and an associated value. If no tags
- are attached to the specified resource, the response contains an empty
- list.
- required:
- - Tags
- type: object
- ListRolesRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The path prefix for filtering the results. For example,
- the prefix /application_abc/component_xyz/ gets all roles
- whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to
- a slash (/), listing all roles. 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.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Roles:
- allOf:
- - $ref: '#/components/schemas/roleListType'
- - description: A list of roles.
- required:
- - Roles
- type: object
- ListSAMLProviderTagsRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The ARN of the Security Assertion Markup Language (SAML) - identity provider whose tags you want to see.
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: _+=,.@-
' - required: - - SAMLProviderArn - title: ListSAMLProviderTagsRequest - type: object - ListSAMLProviderTagsResponse: - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Tags:
- allOf:
- - $ref: '#/components/schemas/tagListType'
- - description: The list of tags that are currently attached to the Security
- Assertion Markup Language (SAML) identity provider. Each tag consists
- of a key name and an associated value. If no tags are attached to the
- specified resource, the response contains an empty list.
- required:
- - Tags
- type: object
- ListSAMLProvidersRequest:
- properties: {}
- title: ListSAMLProvidersRequest
- type: object
- ListSAMLProvidersResponse:
- description: 'Contains the response to a successful ListSAMLProviders
- request. '
- properties:
- SAMLProviderList:
- allOf:
- - $ref: '#/components/schemas/SAMLProviderListType'
- - description: The list of SAML provider resource objects defined in IAM
- for this Amazon Web Services account.
- type: object
- ListSSHPublicKeysRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The name of the IAM user to list SSH public keys for.
- If none is specified, the UserName field is determined
- implicitly based on the Amazon Web Services access key used to sign
- the request.
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: _+=,.@-
' - title: ListSSHPublicKeysRequest - type: object - ListSSHPublicKeysResponse: - description: Contains the response to a successful ListSSHPublicKeys - request. - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- SSHPublicKeys:
- allOf:
- - $ref: '#/components/schemas/SSHPublicKeyListType'
- - description: A list of the SSH public keys assigned to IAM user.
- type: object
- ListServerCertificateTagsRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The name of the IAM server certificate whose tags you - want to see.
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: _+=,.@-
' - required: - - ServerCertificateName - title: ListServerCertificateTagsRequest - type: object - ListServerCertificateTagsResponse: - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Tags:
- allOf:
- - $ref: '#/components/schemas/tagListType'
- - description: The list of tags that are currently attached to the IAM server
- certificate. Each tag consists of a key name and an associated value.
- If no tags are attached to the specified resource, the response contains
- an empty list.
- required:
- - Tags
- type: object
- ListServerCertificatesRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The path prefix for filtering the results. For example:
- /company/servercerts would get all server certificates
- for which the path starts with /company/servercerts.
This parameter is optional. If it is not included, it defaults to
- a slash (/), listing all server certificates. 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.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- ServerCertificateMetadataList:
- allOf:
- - $ref: '#/components/schemas/serverCertificateMetadataListType'
- - description: A list of server certificates.
- required:
- - ServerCertificateMetadataList
- type: object
- ListServiceSpecificCredentialsRequest:
- properties:
- ServiceName:
- allOf:
- - $ref: '#/components/schemas/serviceName'
- - description: Filters the returned results to only those for the specified
- Amazon Web Services service. If not specified, then Amazon Web Services
- returns service-specific credentials for all services.
- UserName:
- allOf:
- - $ref: '#/components/schemas/userNameType'
- - description: 'The name of the user whose service-specific credentials - you want information about. If this value is not specified, then the - operation assumes the user whose credentials are used to call the operation.
-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: _+=,.@-
' - title: ListServiceSpecificCredentialsRequest - type: object - ListServiceSpecificCredentialsResponse: - properties: - ServiceSpecificCredentials: - allOf: - - $ref: '#/components/schemas/ServiceSpecificCredentialsListType' - - description: A list of structures that each contain details about a service-specific - credential. - type: object - ListSigningCertificatesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of theMarker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The name of the IAM user whose signing certificates you - want to examine.
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: _+=,.@-
' - title: ListSigningCertificatesRequest - type: object - ListSigningCertificatesResponse: - description: 'Contains the response to a successful ListSigningCertificates - request. ' - example: - Certificates: - - CertificateBody: '-----BEGIN CERTIFICATE-----Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- required:
- - Certificates
- type: object
- ListUserPoliciesRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The name of the user to list policies for.
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: _+=,.@-
' - required: - - UserName - title: ListUserPoliciesRequest - type: object - ListUserPoliciesResponse: - description: 'Contains the response to a successful ListUserPolicies - request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- PolicyNames:
- allOf:
- - $ref: '#/components/schemas/policyNameListType'
- - description: A list of policy names.
- required:
- - PolicyNames
- type: object
- ListUserTagsRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The name of the IAM user whose tags you want to see.
-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: _+=,.@-
' - required: - - UserName - title: ListUserTagsRequest - type: object - ListUserTagsResponse: - example: - IsTruncated: false - Tags: - - Key: Dept - Value: '12345' - - Key: Team - Value: Accounting - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using theMarker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Tags:
- allOf:
- - $ref: '#/components/schemas/tagListType'
- - description: The list of tags that are currently attached to the user.
- Each tag consists of a key name and an associated value. If no tags
- are attached to the specified resource, the response contains an empty
- list.
- required:
- - Tags
- type: object
- ListUsersRequest:
- properties:
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The path prefix for filtering the results. For example:
- /division_abc/subdivision_xyz/, which would get all user
- names whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to
- a slash (/), listing all user names. 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.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- Users:
- allOf:
- - $ref: '#/components/schemas/userListType'
- - description: A list of users.
- required:
- - Users
- type: object
- ListVirtualMFADevicesRequest:
- properties:
- AssignmentStatus:
- allOf:
- - $ref: '#/components/schemas/assignmentStatusType'
- - description: ' The status (Unassigned or Assigned)
- of the devices to list. If you do not specify an AssignmentStatus,
- the operation defaults to Any, which lists both assigned
- and unassigned virtual MFA devices.,'
- Marker:
- allOf:
- - $ref: '#/components/schemas/markerType'
- - description: Use this parameter only when paginating results and only
- after you receive a response indicating that the results are truncated.
- Set it to the value of the Marker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- VirtualMFADevices:
- allOf:
- - $ref: '#/components/schemas/virtualMFADeviceListType'
- - description: ' The list of virtual MFA devices in the current account
- that match the AssignmentStatus value that was passed in
- the request.'
- required:
- - VirtualMFADevices
- type: object
- LoginProfile:
- description: Contains the user name and password create date for a user.
-This data type is used as a response element in the CreateLoginProfile - and GetLoginProfile operations.
- properties: - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date when the password for the user was created. - PasswordResetRequired: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether the user is required to set a new password - on next sign-in. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name of the user, which can be used for signing in to - the Amazon Web Services Management Console. - required: - - UserName - - CreateDate - type: object - MFADevice: - description:Contains information about an MFA device.
This data type - is used as a response element in the ListMFADevices operation.
- properties: - EnableDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date when the MFA device was enabled for the user. - SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the device ARN. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The user with whom the MFA device is associated. - required: - - UserName - - SerialNumber - - EnableDate - type: object - MalformedCertificateException: {} - MalformedPolicyDocumentException: {} - ManagedPolicyDetail: - description:Contains information about a managed policy, including the policy's - ARN, versions, and the number of principal entities (users, groups, and roles) - that the policy is attached to.
This data type is used as a response - element in the GetAccountAuthorizationDetails operation.
For - more information about managed policies, see Managed - policies and inline policies in the IAM User Guide.
- properties: - Arn: - $ref: '#/components/schemas/arnType' - AttachmentCount: - allOf: - - $ref: '#/components/schemas/attachmentCountType' - - description: The number of principal entities (users, groups, and roles) - that the policy is attached to. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the policy was created. - DefaultVersionId: - allOf: - - $ref: '#/components/schemas/policyVersionIdType' - - description:The identifier for the version of the policy that is set - as the default (operative) version.
For more information about - policy versions, see Versioning - for managed policies in the IAM User Guide.
- Description: - allOf: - - $ref: '#/components/schemas/policyDescriptionType' - - description: A friendly description of the policy. - IsAttachable: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether the policy can be attached to an IAM user, - group, or role. - Path: - allOf: - - $ref: '#/components/schemas/policyPathType' - - description:The path to the policy.
For more information about - paths, see IAM - identifiers in the IAM User Guide.
- PermissionsBoundaryUsageCount: - allOf: - - $ref: '#/components/schemas/attachmentCountType' - - description:The number of entities (users and roles) for which the - policy is used as the permissions boundary.
For more information - about permissions boundaries, see Permissions - boundaries for IAM identities in the IAM User Guide.
- PolicyId: - allOf: - - $ref: '#/components/schemas/idType' - - description:The stable and unique string identifying the policy.
-For more information about IDs, see IAM - identifiers in the IAM User Guide.
- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The friendly name (not ARN) identifying the policy. - PolicyVersionList: - allOf: - - $ref: '#/components/schemas/policyDocumentVersionListType' - - description: A list containing information about the versions of the policy. - UpdateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description:The date and time, in ISO - 8601 date-time format, when the policy was last updated.
When - a policy has only one version, this field contains the date and time - when the policy was created. When a policy has more than one version, - this field contains the date and time when the most recent policy version - was created.
- type: object - ManagedPolicyDetailListType: - items: - allOf: - - $ref: '#/components/schemas/ManagedPolicyDetail' - - xml: - name: member - type: array - NoSuchEntityException: {} - OpenIDConnectProviderListEntry: - description: Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect - provider. - properties: - Arn: - $ref: '#/components/schemas/arnType' - type: object - OpenIDConnectProviderListType: - description: Contains a list of IAM OpenID Connect providers. - items: - allOf: - - $ref: '#/components/schemas/OpenIDConnectProviderListEntry' - - xml: - name: member - type: array - OpenIDConnectProviderUrlType: - description: Contains a URL that specifies the endpoint for an OpenID Connect - provider. - maxLength: 255 - minLength: 1 - type: string - OrganizationsDecisionDetail: - description: Contains information about the effect that Organizations has on - a policy simulation. - properties: - AllowedByOrganizations: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether the simulated operation is allowed by the - Organizations service control policies that impact the simulated user's - account. - type: object - PasswordPolicy: - description:Contains information about the account password policy.
-This data type is used as a response element in the GetAccountPasswordPolicy - operation.
- properties: - AllowUsersToChangePassword: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether IAM users are allowed to change their own - password. Gives IAM users permissions toiam:ChangePassword
- for only their user and to the iam:GetAccountPasswordPolicy
- action. This option does not attach a permissions policy to each user,
- rather the permissions are applied at the account-level for all users
- by IAM.
- ExpirePasswords:
- allOf:
- - $ref: '#/components/schemas/booleanType'
- - description: Indicates whether passwords in the account expire. Returns
- true if MaxPasswordAge contains a value greater than 0.
- Returns false if MaxPasswordAge is 0 or not present.
- HardExpiry:
- allOf:
- - $ref: '#/components/schemas/booleanObjectType'
- - description: Specifies whether IAM users are prevented from setting a
- new password via the Amazon Web Services Management Console after their
- password has expired. The IAM user cannot access the console until an
- administrator resets the password. IAM users with iam:ChangePassword
- permission and active access keys can reset their own expired console
- password using the CLI or API.
- MaxPasswordAge:
- allOf:
- - $ref: '#/components/schemas/maxPasswordAgeType'
- - description: The number of days that an IAM user password is valid.
- MinimumPasswordLength:
- allOf:
- - $ref: '#/components/schemas/minimumPasswordLengthType'
- - description: Minimum length to require for IAM user passwords.
- PasswordReusePrevention:
- allOf:
- - $ref: '#/components/schemas/passwordReusePreventionType'
- - description: Specifies the number of previous passwords that IAM users
- are prevented from reusing.
- RequireLowercaseCharacters:
- allOf:
- - $ref: '#/components/schemas/booleanType'
- - description: Specifies whether IAM user passwords must contain at least
- one lowercase character (a to z).
- RequireNumbers:
- allOf:
- - $ref: '#/components/schemas/booleanType'
- - description: Specifies whether IAM user passwords must contain at least
- one numeric character (0 to 9).
- RequireSymbols:
- allOf:
- - $ref: '#/components/schemas/booleanType'
- - description: 'Specifies whether IAM user passwords must contain at - least one of the following symbols:
! @ # $ % ^ & * ( ) _ - + - = [ ] { } | ''
' - RequireUppercaseCharacters: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether IAM user passwords must contain at least - one uppercase character (A to Z). - type: object - PasswordPolicyViolationException: {} - PermissionsBoundaryAttachmentType: - enum: - - PermissionsBoundaryPolicy - type: string - PermissionsBoundaryDecisionDetail: - description: Contains information about the effect that a permissions boundary - has on a policy simulation when the boundary is applied to an IAM entity. - properties: - AllowedByPermissionsBoundary: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether an action is allowed by a permissions boundary - that is applied to an IAM entity (user or role). A value oftrue
- means that the permissions boundary does not deny the action. This means
- that the policy includes an Allow statement that matches
- the request. In this case, if an identity-based policy also allows the
- action, the request is allowed. A value of false means
- that either the requested action is not allowed (implicitly denied)
- or that the action is explicitly denied by the permissions boundary.
- In both of these cases, the action is not allowed, regardless of the
- identity-based policy.
- type: object
- Policy:
- description: Contains information about a managed policy.
This data - type is used as a response element in the CreatePolicy, GetPolicy, - and ListPolicies operations.
For more information about managed - policies, refer to Managed - policies and inline policies in the IAM User Guide.
- properties: - Arn: - $ref: '#/components/schemas/arnType' - AttachmentCount: - allOf: - - $ref: '#/components/schemas/attachmentCountType' - - description: The number of entities (users, groups, and roles) that the - policy is attached to. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the policy was created. - DefaultVersionId: - allOf: - - $ref: '#/components/schemas/policyVersionIdType' - - description: The identifier for the version of the policy that is set - as the default version. - Description: - allOf: - - $ref: '#/components/schemas/policyDescriptionType' - - description:A friendly description of the policy.
This element - is included in the response to the GetPolicy operation. It is - not included in the response to the ListPolicies operation.
- IsAttachable: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether the policy can be attached to an IAM user, - group, or role. - Path: - allOf: - - $ref: '#/components/schemas/policyPathType' - - description:The path to the policy.
For more information about - paths, see IAM - identifiers in the IAM User Guide.
- PermissionsBoundaryUsageCount: - allOf: - - $ref: '#/components/schemas/attachmentCountType' - - description:The number of entities (users and roles) for which the - policy is used to set the permissions boundary.
For more information - about permissions boundaries, see Permissions - boundaries for IAM identities in the IAM User Guide.
- PolicyId: - allOf: - - $ref: '#/components/schemas/idType' - - description:The stable and unique string identifying the policy.
-For more information about IDs, see IAM - identifiers in the IAM User Guide.
- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The friendly name (not ARN) identifying the policy. - 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. - UpdateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description:The date and time, in ISO - 8601 date-time format, when the policy was last updated.
When - a policy has only one version, this field contains the date and time - when the policy was created. When a policy has more than one version, - this field contains the date and time when the most recent policy version - was created.
- type: object - PolicyDetail: - description:Contains information about an IAM policy, including the policy - document.
This data type is used as a response element in the GetAccountAuthorizationDetails - operation.
- properties: - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description: The policy document. - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The name of the policy. - type: object - PolicyEvaluationDecisionType: - enum: - - allowed - - explicitDeny - - implicitDeny - type: string - PolicyEvaluationException: {} - PolicyGrantingServiceAccess: - description:Contains details about the permissions policies that are attached - to the specified identity (user, group, or role).
This data type is - an element of the ListPoliciesGrantingServiceAccessEntry object.
- properties: - EntityName: - allOf: - - $ref: '#/components/schemas/entityNameType' - - description:The name of the entity (user or role) to which the inline - policy is attached.
This field is null for managed policies. - For more information about these policy types, see Managed - policies and inline policies in the IAM User Guide.
- EntityType: - allOf: - - $ref: '#/components/schemas/policyOwnerEntityType' - - description:The type of entity (user or role) that used the policy - to access the service to which the inline policy is attached.
This - field is null for managed policies. For more information about these - policy types, see Managed - policies and inline policies in the IAM User Guide.
- PolicyArn: - $ref: '#/components/schemas/arnType' - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The policy name. - PolicyType: - allOf: - - $ref: '#/components/schemas/policyType' - - description: The policy type. For more information about these policy - types, see Managed - policies and inline policies in the IAM User Guide. - required: - - PolicyName - - PolicyType - type: object - PolicyGroup: - description:Contains information about a group that a managed policy is - attached to.
This data type is used as a response element in the ListEntitiesForPolicy - operation.
For more information about managed policies, refer to Managed - policies and inline policies in the IAM User Guide.
- properties: - 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. - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: The name (friendly name, not ARN) identifying the group. - type: object - PolicyGroupListType: - items: - allOf: - - $ref: '#/components/schemas/PolicyGroup' - - xml: - name: member - type: array - PolicyIdentifierType: - type: string - PolicyNotAttachableException: {} - PolicyRole: - description:Contains information about a role that a managed policy is attached - to.
This data type is used as a response element in the ListEntitiesForPolicy - operation.
For more information about managed policies, refer to Managed - policies and inline policies in the IAM User Guide.
- properties: - 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. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The name (friendly name, not ARN) identifying the role. - type: object - PolicyRoleListType: - items: - allOf: - - $ref: '#/components/schemas/PolicyRole' - - xml: - name: member - type: array - PolicySourceType: - enum: - - user - - group - - role - - aws-managed - - user-managed - - resource - - none - type: string - PolicyUsageType: - description:The policy usage type that indicates whether the policy is used - as a permissions policy or as the permissions boundary for an entity.
-For more information about permissions boundaries, see Permissions - boundaries for IAM identities in the IAM User Guide.
- enum: - - PermissionsPolicy - - PermissionsBoundary - type: string - PolicyUser: - description:Contains information about a user that a managed policy is attached - to.
This data type is used as a response element in the ListEntitiesForPolicy - operation.
For more information about managed policies, refer to Managed - policies and inline policies in the IAM User Guide.
- properties: - UserId: - allOf: - - $ref: '#/components/schemas/idType' - - description: The stable and unique string identifying the user. For more - information about IDs, see IAM - identifiers in the IAM User Guide. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name (friendly name, not ARN) identifying the user. - type: object - PolicyUserListType: - items: - allOf: - - $ref: '#/components/schemas/PolicyUser' - - xml: - name: member - type: array - PolicyVersion: - description:Contains information about a version of a managed policy.
-This data type is used as a response element in the CreatePolicyVersion, - GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails - operations.
For more information about managed policies, refer to - Managed - policies and inline policies in the IAM User Guide.
- properties: - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the policy version was created. - Document: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:The policy document.
The policy document is returned - in the response to the GetPolicyVersion and GetAccountAuthorizationDetails - operations. It is not returned in the response to the CreatePolicyVersion - or ListPolicyVersions operations.
The policy document
- returned in this structure is URL-encoded compliant with RFC
- 3986. You can use a URL decoding method to convert the policy back
- to plain JSON text. For example, if you use Java, you can use the decode
- method of the java.net.URLDecoder utility class in the
- Java SDK. Other languages and SDKs provide similar functionality.
The identifier for the policy version.
Policy version
- identifiers always begin with v (always lowercase). When
- a policy is created, the first policy version is v1.
Contains the row and column of a location of a Statement
- element in a policy document.
This data type is used as a member of
- the Statement type.
The name of the group to associate the policy with.
-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: _+=,.@-.
' - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:The policy document.
You must provide policies - in JSON format in IAM. 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)
The name of the policy document.
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: _+=,.@-
' - required: - - GroupName - - PolicyName - - PolicyDocument - title: PutGroupPolicyRequest - type: object - PutRolePermissionsBoundaryRequest: - properties: - PermissionsBoundary: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The ARN of the policy that is used to set the permissions - boundary for the role. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The name (friendly name, not ARN) of the IAM role for which - you want to set the permissions boundary. - required: - - RoleName - - PermissionsBoundary - title: PutRolePermissionsBoundaryRequest - type: object - PutRolePolicyRequest: - properties: - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:The policy document.
You must provide policies - in JSON format in IAM. 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)
The name of the policy document.
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: _+=,.@-
' - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: 'The name of the role to associate the policy with.
-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: _+=,.@-
' - required: - - RoleName - - PolicyName - - PolicyDocument - title: PutRolePolicyRequest - type: object - PutUserPermissionsBoundaryRequest: - properties: - PermissionsBoundary: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The ARN of the policy that is used to set the permissions - boundary for the user. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name (friendly name, not ARN) of the IAM user for which - you want to set the permissions boundary. - required: - - UserName - - PermissionsBoundary - title: PutUserPermissionsBoundaryRequest - type: object - PutUserPolicyRequest: - properties: - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:The policy document.
You must provide policies - in JSON format in IAM. 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)
The name of the policy document.
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: _+=,.@-
' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the user to associate the policy with.
-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: _+=,.@-
' - required: - - UserName - - PolicyName - - PolicyDocument - title: PutUserPolicyRequest - type: object - ReasonType: - maxLength: 1000 - type: string - RegionNameType: - maxLength: 100 - minLength: 1 - type: string - RemoveClientIDFromOpenIDConnectProviderRequest: - properties: - ClientID: - allOf: - - $ref: '#/components/schemas/clientIDType' - - description: The client ID (also known as audience) to remove from the - IAM OIDC provider resource. For more information about client IDs, see - CreateOpenIDConnectProvider. - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The Amazon Resource Name (ARN) of the IAM OIDC provider - resource to remove the client ID from. You can get a list of OIDC provider - ARNs by using the ListOpenIDConnectProviders operation.
For - more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- required: - - OpenIDConnectProviderArn - - ClientID - title: RemoveClientIDFromOpenIDConnectProviderRequest - type: object - RemoveRoleFromInstanceProfileRequest: - properties: - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: 'The name of the instance profile to update.
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: _+=,.@-
' - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: 'The name of the role to remove.
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: _+=,.@-
' - required: - - InstanceProfileName - - RoleName - title: RemoveRoleFromInstanceProfileRequest - type: object - RemoveUserFromGroupRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: 'The name of the group to update.
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: _+=,.@-
' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the user to remove.
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: _+=,.@-
' - required: - - GroupName - - UserName - title: RemoveUserFromGroupRequest - type: object - ReportContentType: - type: string - ReportFormatType: - enum: - - text/csv - type: string - ReportGenerationLimitExceededException: {} - ReportStateDescriptionType: - type: string - ReportStateType: - enum: - - STARTED - - INPROGRESS - - COMPLETE - type: string - ResetServiceSpecificCredentialRequest: - properties: - ServiceSpecificCredentialId: - allOf: - - $ref: '#/components/schemas/serviceSpecificCredentialId' - - description:The unique identifier of the service-specific credential.
-This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.
- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: 'The name of the IAM user associated with the service-specific - credential. If this value is not specified, then the operation assumes - the user whose credentials are used to call the operation.
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: _+=,.@-
' - required: - - ServiceSpecificCredentialId - title: ResetServiceSpecificCredentialRequest - type: object - ResetServiceSpecificCredentialResponse: - properties: - ServiceSpecificCredential: - allOf: - - $ref: '#/components/schemas/ServiceSpecificCredential' - - description:A structure with details about the updated service-specific - credential, including the new password.
This is the - only time that you can access the password. You cannot recover - the password later, but you can reset it again.
Contains the result of the simulation of a single API operation - call on a single resource.
This data type is used by a member of the - EvaluationResult data type.
- properties: - EvalDecisionDetails: - allOf: - - $ref: '#/components/schemas/EvalDecisionDetailsType' - - description: Additional details about the results of the evaluation decision - on a single resource. This parameter is returned only for cross-account - simulations. This parameter explains how each policy type contributes - to the resource-specific evaluation decision. - EvalResourceDecision: - allOf: - - $ref: '#/components/schemas/PolicyEvaluationDecisionType' - - description: The result of the simulation of the simulated API operation - on the resource specified inEvalResourceName.
- EvalResourceName:
- allOf:
- - $ref: '#/components/schemas/ResourceNameType'
- - description: The name of the simulated resource, in Amazon Resource Name
- (ARN) format.
- MatchedStatements:
- allOf:
- - $ref: '#/components/schemas/StatementListType'
- - description: A list of the statements in the input policies that determine
- the result for this part of the simulation. Remember that even if multiple
- statements allow the operation on the resource, if any statement
- denies that operation, then the explicit deny overrides any allow. In
- addition, the deny statement is the only entry included in the result.
- MissingContextValues:
- allOf:
- - $ref: '#/components/schemas/ContextKeyNamesResultListType'
- - description: A list of context keys that are required by the included
- input policies but that were not provided by one of the input parameters.
- This list is used when a list of ARNs is included in the ResourceArns
- parameter instead of "*". If you do not specify individual resources,
- by setting ResourceArns to "*" or by not including the
- ResourceArns parameter, then any missing context values
- are instead included under the EvaluationResults section.
- To discover the context keys used by a set of policies, you can call
- GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
- PermissionsBoundaryDecisionDetail:
- allOf:
- - $ref: '#/components/schemas/PermissionsBoundaryDecisionDetail'
- - description: Contains information about the effect that a permissions
- boundary has on a policy simulation when that boundary is applied to
- an IAM entity.
- required:
- - EvalResourceName
- - EvalResourceDecision
- type: object
- ResourceSpecificResultListType:
- items:
- allOf:
- - $ref: '#/components/schemas/ResourceSpecificResult'
- - xml:
- name: member
- type: array
- ResyncMFADeviceRequest:
- properties:
- AuthenticationCode1:
- allOf:
- - $ref: '#/components/schemas/authenticationCodeType'
- - description: An authentication code emitted by the device.
The - format for this parameter is a sequence of six digits.
- AuthenticationCode2: - allOf: - - $ref: '#/components/schemas/authenticationCodeType' - - description:A subsequent authentication code emitted by the device.
-The format for this parameter is a sequence of six digits.
- SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: 'Serial number that uniquely identifies the MFA device.
-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: _+=,.@-
' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the user whose MFA device you want to resynchronize.
-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: _+=,.@-
' - required: - - UserName - - SerialNumber - - AuthenticationCode1 - - AuthenticationCode2 - title: ResyncMFADeviceRequest - type: object - Role: - description: Contains information about an IAM role. This structure is returned - as a response element in several API operations that interact with roles. - properties: - 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. ' - AssumeRolePolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description: The policy that grants an entity permission to assume the - role. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the role was created. - 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.
- 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. '
- 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.
- 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. ' - 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. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The friendly name that identifies the role. - 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. - required: - - Path - - RoleName - - RoleId - - Arn - - CreateDate - type: object - RoleDetail: - description:Contains information about an IAM role, including all of the - role's policies.
This data type is used as a response element in the - GetAccountAuthorizationDetails operation.
- properties: - Arn: - $ref: '#/components/schemas/arnType' - AssumeRolePolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description: The trust policy that grants permission to assume the role. - AttachedManagedPolicies: - allOf: - - $ref: '#/components/schemas/attachedPoliciesListType' - - description: A list of managed policies attached to the role. These policies - are the role's access (permissions) policies. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the role was created. - InstanceProfileList: - allOf: - - $ref: '#/components/schemas/instanceProfileListType' - - description: A list of instance profiles that contain this role. - 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. - 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.
- 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. - 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. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The friendly name that identifies the role. - RolePolicyList: - allOf: - - $ref: '#/components/schemas/policyDetailListType' - - description: A list of inline policies embedded in the role. These policies - are the role's access (permissions) policies. - 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. - type: object - 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.
This data type - is returned as a response element in the GetRole and GetAccountAuthorizationDetails - operations.
- 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. - type: object - RoleUsageListType: - items: - allOf: - - $ref: '#/components/schemas/RoleUsageType' - - xml: - name: member - type: array - RoleUsageType: - description:An object that contains details about how a service-linked role - is used, if that information is returned by the service.
This data - type is used as a response element in the GetServiceLinkedRoleDeletionStatus - operation.
- properties: - Region: - allOf: - - $ref: '#/components/schemas/RegionNameType' - - description: The name of the Region where the service-linked role is being - used. - Resources: - allOf: - - $ref: '#/components/schemas/ArnListType' - - description: The name of the resource that is using the service-linked - role. - type: object - SAMLMetadataDocumentType: - maxLength: 10000000 - minLength: 1000 - type: string - SAMLProviderListEntry: - description: Contains the list of SAML providers for this account. - properties: - Arn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The Amazon Resource Name (ARN) of the SAML provider. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time when the SAML provider was created. - ValidUntil: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The expiration date and time for the SAML provider. - type: object - SAMLProviderListType: - items: - allOf: - - $ref: '#/components/schemas/SAMLProviderListEntry' - - xml: - name: member - type: array - SAMLProviderNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w._-]+' - type: string - SSHPublicKey: - description:Contains information about an SSH public key.
This data - type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey - operations.
- properties: - Fingerprint: - allOf: - - $ref: '#/components/schemas/publicKeyFingerprintType' - - description: The MD5 message digest of the SSH public key. - SSHPublicKeyBody: - allOf: - - $ref: '#/components/schemas/publicKeyMaterialType' - - description: The SSH public key. - SSHPublicKeyId: - allOf: - - $ref: '#/components/schemas/publicKeyIdType' - - description: The unique identifier for the SSH public key. - Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status of the SSH public key.Active means
- that the key can be used for authentication with an CodeCommit repository.
- Inactive means that the key cannot be used.
- UploadDate:
- allOf:
- - $ref: '#/components/schemas/dateType'
- - description: The date and time, in ISO
- 8601 date-time format, when the SSH public key was uploaded.
- UserName:
- allOf:
- - $ref: '#/components/schemas/userNameType'
- - description: The name of the IAM user associated with the SSH public key.
- required:
- - UserName
- - SSHPublicKeyId
- - Fingerprint
- - SSHPublicKeyBody
- - Status
- type: object
- SSHPublicKeyListType:
- items:
- allOf:
- - $ref: '#/components/schemas/SSHPublicKeyMetadata'
- - xml:
- name: member
- type: array
- SSHPublicKeyMetadata:
- description: Contains information about an SSH public key, without the key's - body or fingerprint.
This data type is used as a response element in - the ListSSHPublicKeys operation.
- properties: - SSHPublicKeyId: - allOf: - - $ref: '#/components/schemas/publicKeyIdType' - - description: The unique identifier for the SSH public key. - Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status of the SSH public key.Active means
- that the key can be used for authentication with an CodeCommit repository.
- Inactive means that the key cannot be used.
- UploadDate:
- allOf:
- - $ref: '#/components/schemas/dateType'
- - description: The date and time, in ISO
- 8601 date-time format, when the SSH public key was uploaded.
- UserName:
- allOf:
- - $ref: '#/components/schemas/userNameType'
- - description: The name of the IAM user associated with the SSH public key.
- required:
- - UserName
- - SSHPublicKeyId
- - Status
- - UploadDate
- type: object
- ServerCertificate:
- description: Contains information about a server certificate.
This - data type is used as a response element in the GetServerCertificate - operation.
- properties: - CertificateBody: - allOf: - - $ref: '#/components/schemas/certificateBodyType' - - description: The contents of the public key certificate. - CertificateChain: - allOf: - - $ref: '#/components/schemas/certificateChainType' - - description: The contents of the public key certificate chain. - ServerCertificateMetadata: - allOf: - - $ref: '#/components/schemas/ServerCertificateMetadata' - - description: The meta information of the server certificate, such as its - name, path, ID, and ARN. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the server certificate. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - required: - - ServerCertificateMetadata - - CertificateBody - type: object - ServerCertificateMetadata: - description:Contains information about a server certificate without its - certificate body, certificate chain, and private key.
This data type - is used as a response element in the UploadServerCertificate and ListServerCertificates - operations.
- properties: - Arn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: ' The Amazon Resource Name (ARN) specifying the server certificate. - For more information about ARNs and how to use them in policies, see - IAM - identifiers in the IAM User Guide. ' - Expiration: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date on which the certificate is set to expire. - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description: ' The path to the server certificate. For more information - about paths, see IAM - identifiers in the IAM User Guide. ' - ServerCertificateId: - allOf: - - $ref: '#/components/schemas/idType' - - description: ' The stable and unique string identifying the server certificate. - For more information about IDs, see IAM - identifiers in the IAM User Guide. ' - ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: The name that identifies the server certificate. - UploadDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date when the server certificate was uploaded. - required: - - Path - - ServerCertificateName - - ServerCertificateId - - Arn - type: object - ServiceFailureException: {} - ServiceLastAccessed: - description:Contains details about the most recent attempt to access the - service.
This data type is used as a response element in the GetServiceLastAccessedDetails - operation.
- properties: - LastAuthenticated: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "The date and time, in\_ISO 8601 date-time format, when an authenticated entity most recently\ - \ attempted to access the service. Amazon Web Services does not report\ - \ unauthenticated requests.
This field is null if no IAM entities\ - \ attempted to access the service within the reporting period.
" - LastAuthenticatedEntity: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The ARN of the authenticated entity (user or role) that - last attempted to access the service. Amazon Web Services does not report - unauthenticated requests.
This field is null if no IAM entities - attempted to access the service within the reporting - period.
- LastAuthenticatedRegion: - allOf: - - $ref: '#/components/schemas/stringType' - - description:The Region from which the authenticated entity (user or - role) last attempted to access the service. Amazon Web Services does - not report unauthenticated requests.
This field is null if no - IAM entities attempted to access the service within the reporting - period.
- ServiceName: - allOf: - - $ref: '#/components/schemas/serviceNameType' - - description: The name of the service in which access was attempted. - ServiceNamespace: - allOf: - - $ref: '#/components/schemas/serviceNamespaceType' - - description: "The namespace of the service in which access was attempted.
\ - \To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services\
- \ in the Service Authorization Reference. Choose the name of\
- \ the service to view details for that service. In the first paragraph,\
- \ find the service prefix. For example, (service prefix: a4b).\
- \ For more information about service namespaces, see Amazon Web Services Service Namespaces in the\_Amazon Web Services\
- \ General Reference.
The total number of authenticated principals (root user, - IAM users, or IAM roles) that have attempted to access the service.
-This field is null if no principals attempted to access the service - within the reporting - period.
- TrackedActionsLastAccessed: - allOf: - - $ref: '#/components/schemas/TrackedActionsLastAccessed' - - description:An object that contains details about the most recent - attempt to access a tracked action within the service.
This field
- is null if there no tracked actions or if the principal did not use
- the tracked actions within the reporting
- period. This field is also null if the report was generated at the
- service level and not the action level. For more information, see the
- Granularity field in GenerateServiceLastAccessedDetails.
jane-at-123456789012,
- for example. This value cannot be configured by the user.
- Status:
- allOf:
- - $ref: '#/components/schemas/statusType'
- - description: The status of the service-specific credential. Active
- means that the key is valid for API calls, while Inactive
- means it is not.
- UserName:
- allOf:
- - $ref: '#/components/schemas/userNameType'
- - description: The name of the IAM user associated with the service-specific
- credential.
- required:
- - CreateDate
- - ServiceName
- - ServiceUserName
- - ServicePassword
- - ServiceSpecificCredentialId
- - UserName
- - Status
- type: object
- ServiceSpecificCredentialMetadata:
- description: Contains additional details about a service-specific credential.
- properties:
- CreateDate:
- allOf:
- - $ref: '#/components/schemas/dateType'
- - description: The date and time, in ISO
- 8601 date-time format, when the service-specific credential were
- created.
- ServiceName:
- allOf:
- - $ref: '#/components/schemas/serviceName'
- - description: The name of the service associated with the service-specific
- credential.
- ServiceSpecificCredentialId:
- allOf:
- - $ref: '#/components/schemas/serviceSpecificCredentialId'
- - description: The unique identifier for the service-specific credential.
- ServiceUserName:
- allOf:
- - $ref: '#/components/schemas/serviceUserName'
- - description: The generated user name for the service-specific credential.
- Status:
- allOf:
- - $ref: '#/components/schemas/statusType'
- - description: The status of the service-specific credential. Active
- means that the key is valid for API calls, while Inactive
- means it is not.
- UserName:
- allOf:
- - $ref: '#/components/schemas/userNameType'
- - description: The name of the IAM user associated with the service-specific
- credential.
- required:
- - UserName
- - Status
- - ServiceUserName
- - CreateDate
- - ServiceSpecificCredentialId
- - ServiceName
- type: object
- ServiceSpecificCredentialsListType:
- items:
- allOf:
- - $ref: '#/components/schemas/ServiceSpecificCredentialMetadata'
- - xml:
- name: member
- type: array
- ServicesLastAccessed:
- items:
- allOf:
- - $ref: '#/components/schemas/ServiceLastAccessed'
- - xml:
- name: member
- type: array
- SetDefaultPolicyVersionRequest:
- properties:
- PolicyArn:
- allOf:
- - $ref: '#/components/schemas/arnType'
- - description: The Amazon Resource Name (ARN) of the IAM policy whose - default version you want to set.
For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- VersionId: - allOf: - - $ref: '#/components/schemas/policyVersionIdType' - - description:The version of the policy to set as the default (operative) - version.
For more information about managed policy versions, - see Versioning - for managed policies in the IAM User Guide.
- required: - - PolicyArn - - VersionId - title: SetDefaultPolicyVersionRequest - type: object - SetSecurityTokenServicePreferencesRequest: - properties: - GlobalEndpointTokenVersion: - allOf: - - $ref: '#/components/schemas/globalEndpointTokenVersion' - - description:The version of the global endpoint token. Version 1 tokens - are valid only in Amazon Web Services Regions that are available by - default. These tokens do not work in manually enabled Regions, such - as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. - However, version 2 tokens are longer and might affect systems where - you temporarily store tokens.
For information, see Activating - and deactivating STS in an Amazon Web Services Region in the IAM - User Guide.
- required: - - GlobalEndpointTokenVersion - title: SetSecurityTokenServicePreferencesRequest - type: object - SigningCertificate: - description:Contains information about an X.509 signing certificate.
-This data type is used as a response element in the UploadSigningCertificate - and ListSigningCertificates operations.
- properties: - CertificateBody: - allOf: - - $ref: '#/components/schemas/certificateBodyType' - - description: The contents of the signing certificate. - CertificateId: - allOf: - - $ref: '#/components/schemas/certificateIdType' - - description: The ID for the signing certificate. - Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status of the signing certificate.Active
- means that the key is valid for API calls, while Inactive
- means it is not.
- UploadDate:
- allOf:
- - $ref: '#/components/schemas/dateType'
- - description: The date when the signing certificate was uploaded.
- UserName:
- allOf:
- - $ref: '#/components/schemas/userNameType'
- - description: The name of the user the signing certificate is associated
- with.
- required:
- - UserName
- - CertificateId
- - CertificateBody
- - Status
- type: object
- SimulateCustomPolicyRequest:
- properties:
- ActionNames:
- allOf:
- - $ref: '#/components/schemas/ActionNameListType'
- - description: A list of names of API operations to evaluate in the simulation.
- Each operation is evaluated against each resource. Each operation must
- include the service identifier, such as iam:CreateUser.
- This operation does not support using wildcards (*) in an action name.
- CallerArn:
- allOf:
- - $ref: '#/components/schemas/ResourceNameType'
- - description: The ARN of the IAM user that you want to use as the simulated
- caller of the API operations. CallerArn is required if
- you include a ResourcePolicy so that the policy's Principal
- element has a value to use in evaluating the policy.
You can - specify only the ARN of an IAM user. You cannot specify the ARN of an - assumed role, federated user, or a service principal.
- ContextEntries: - allOf: - - $ref: '#/components/schemas/ContextEntryListType' - - description: A list of context keys and corresponding values for the simulation - to use. Whenever a context key is evaluated in one of the simulated - IAM permissions policies, the corresponding value is supplied. - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of theMarker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The IAM permissions boundary policy to simulate. The permissions - boundary sets the maximum permissions that an IAM entity can have. You - can input only one permissions boundary when you pass a policy to this - operation. For more information about permissions boundaries, see Permissions - boundaries for IAM entities in the IAM User Guide. The policy - input is specified as a string that contains the complete, valid JSON - text of a permissions boundary policy.
The maximum length of - the policy document that you can pass in this operation, including whitespace, - is listed below. To view the maximum character counts of a managed policy - with no whitespaces, see IAM - and STS character quotas.
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)
A list of policy documents to include in the simulation.
- Each document is specified as a string containing the complete, valid
- JSON text of an IAM policy. Do not include any resource-based policies
- in this parameter. Any resource-based policy must be submitted with
- the ResourcePolicy parameter. The policies cannot be "scope-down"
- policies, such as you could include in a call to GetFederationToken
- or one of the AssumeRole
- API operations. In other words, do not use policies designed to restrict
- what a user can do while using the temporary credentials.
The - maximum length of the policy document that you can pass in this operation, - including whitespace, is listed below. To view the maximum character - counts of a managed policy with no whitespaces, see IAM - and STS character quotas.
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)
A list of ARNs of Amazon Web Services resources to include
- in the simulation. If this parameter is not provided, then the value
- defaults to * (all resources). Each API in the ActionNames
- parameter is evaluated for each resource in this list. The simulation
- determines the access result (allowed or denied) of each combination
- and reports it in the response. You can simulate resources that don't
- exist in your account.
The simulation does not automatically
- retrieve policies for the specified resources. If you want to include
- a resource policy in the simulation, then you must include the policy
- as a string in the ResourcePolicy parameter.
If
- you include a ResourcePolicy, then it must be applicable
- to all of the resources included in the simulation or you receive an
- invalid input error.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- ResourceHandlingOption: - allOf: - - $ref: '#/components/schemas/ResourceHandlingOptionType' - - description:Specifies the type of simulation to run. Different API - operations that support resource-based policies require different combinations - of resources. By specifying the type of simulation to run, you enable - the policy simulator to enforce the presence of the required resources - to ensure reliable simulation results. If your simulation does not match - one of the following scenarios, then you can omit this parameter. The - following list shows each of the supported scenario values and the resources - that you must define to run the simulation.
Each of the EC2 scenarios - requires that you specify instance, image, and security-group resources. - If your scenario includes an EBS volume, then you must specify that - volume as a resource. If the EC2 scenario includes VPC, then you must - supply the network-interface resource. If it includes an IP subnet, - then you must specify the subnet resource. For more information on the - EC2 scenario options, see Supported - platforms in the Amazon EC2 User Guide.
- EC2-Classic-InstanceStore
instance, image, security-group
-EC2-Classic-EBS
instance, image, security-group, - volume
EC2-VPC-InstanceStore
instance, - image, security-group, network-interface
EC2-VPC-InstanceStore-Subnet -
instance, image, security-group, network-interface, subnet
-EC2-VPC-EBS
instance, image, security-group, - network-interface, volume
EC2-VPC-EBS-Subnet -
instance, image, security-group, network-interface, subnet, - volume
An ARN representing the Amazon Web Services account ID
- that specifies the owner of any simulated resource that does not identify
- its owner in the resource ARN. Examples of resource ARNs include an
- S3 bucket or object. If ResourceOwner is specified, it
- is also used as the account owner of any ResourcePolicy
- included in the simulation. If the ResourceOwner parameter
- is not specified, then the owner of the resources and the resource policy
- defaults to the account of the identity provided in CallerArn.
- This parameter is required only if you specify a resource-based policy
- and account that owns the resource is different from the account that
- owns the simulated calling user CallerArn.
The ARN
- for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root.
- For example, to represent the account with the 112233445566 ID, use
- the following ARN: arn:aws:iam::112233445566-ID:root.
A resource-based policy to include in the simulation provided - as a string. Each resource in the simulation is treated as if it had - this policy attached. You can include only one resource-based policy - in a simulation.
The maximum length of the policy document that - you can pass in this operation, including whitespace, is listed below. - To view the maximum character counts of a managed policy with no whitespaces, - see IAM - and STS character quotas.
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)
Marker request parameter to retrieve
- more items. Note that IAM might return fewer than the MaxItems
- number of results even when there are more results available. We recommend
- that you check IsTruncated after every call to ensure that
- you receive all your results.
- Marker:
- allOf:
- - $ref: '#/components/schemas/responseMarkerType'
- - description: When IsTruncated is true, this
- element is present and contains the value to use for the Marker
- parameter in a subsequent pagination request.
- type: object
- SimulatePrincipalPolicyRequest:
- properties:
- ActionNames:
- allOf:
- - $ref: '#/components/schemas/ActionNameListType'
- - description: A list of names of API operations to evaluate in the simulation.
- Each operation is evaluated for each resource. Each operation must include
- the service identifier, such as iam:CreateUser.
- CallerArn:
- allOf:
- - $ref: '#/components/schemas/ResourceNameType'
- - description: The ARN of the IAM user that you want to specify as the
- simulated caller of the API operations. If you do not specify a CallerArn,
- it defaults to the ARN of the user that you specify in PolicySourceArn,
- if you specified a user. If you include both a PolicySourceArn
- (for example, arn:aws:iam::123456789012:user/David) and
- a CallerArn (for example, arn:aws:iam::123456789012:user/Bob),
- the result is that you simulate calling the API operations as Bob, as
- if Bob had David's policies.
You can specify only the ARN of - an IAM user. You cannot specify the ARN of an assumed role, federated - user, or a service principal.
CallerArn is required
- if you include a ResourcePolicy and the PolicySourceArn
- is not the ARN for an IAM user. This is required so that the resource-based
- policy's Principal element has a value to use in evaluating
- the policy.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- ContextEntries: - allOf: - - $ref: '#/components/schemas/ContextEntryListType' - - description: A list of context keys and corresponding values for the simulation - to use. Whenever a context key is evaluated in one of the simulated - IAM permissions policies, the corresponding value is supplied. - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of theMarker element in the response
- that you received to indicate where the next call should start.
- MaxItems:
- allOf:
- - $ref: '#/components/schemas/maxItemsType'
- - description: Use this only when paginating results to indicate the
- maximum number of items you want in the response. If additional items
- exist beyond the maximum you specify, the IsTruncated response
- element is true.
If you do not include this parameter,
- the number of items defaults to 100. Note that IAM might return fewer
- results, even when there are more results available. In that case, the
- IsTruncated response element returns true,
- and Marker contains a value to include in the subsequent
- call that tells the service where to continue from.
The IAM permissions boundary policy to simulate. The permissions - boundary sets the maximum permissions that the entity can have. You - can input only one permissions boundary when you pass a policy to this - operation. An IAM entity can only have one permissions boundary in effect - at a time. For example, if a permissions boundary is attached to an - entity and you pass in a different permissions boundary policy using - this parameter, then the new permissions boundary policy is used for - the simulation. For more information about permissions boundaries, see - Permissions - boundaries for IAM entities in the IAM User Guide. The policy - input is specified as a string containing the complete, valid JSON text - of a permissions boundary policy.
The maximum length of the policy - document that you can pass in this operation, including whitespace, - is listed below. To view the maximum character counts of a managed policy - with no whitespaces, see IAM - and STS character quotas.
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)
An optional list of additional policy documents to include - in the simulation. Each document is specified as a string containing - the complete, valid JSON text of an IAM policy.
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)
The Amazon Resource Name (ARN) of a user, group, or role - whose policies you want to include in the simulation. If you specify - a user, group, or role, the simulation includes all policies that are - associated with that entity. If you specify a user, the simulation also - includes all policies that are attached to any groups the user belongs - to.
The maximum length of the policy document that you can pass - in this operation, including whitespace, is listed below. To view the - maximum character counts of a managed policy with no whitespaces, see - IAM - and STS character quotas.
For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- ResourceArns: - allOf: - - $ref: '#/components/schemas/ResourceNameListType' - - description:A list of ARNs of Amazon Web Services resources to include
- in the simulation. If this parameter is not provided, then the value
- defaults to * (all resources). Each API in the ActionNames
- parameter is evaluated for each resource in this list. The simulation
- determines the access result (allowed or denied) of each combination
- and reports it in the response. You can simulate resources that don't
- exist in your account.
The simulation does not automatically
- retrieve policies for the specified resources. If you want to include
- a resource policy in the simulation, then you must include the policy
- as a string in the ResourcePolicy parameter.
For - more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- ResourceHandlingOption: - allOf: - - $ref: '#/components/schemas/ResourceHandlingOptionType' - - description:Specifies the type of simulation to run. Different API - operations that support resource-based policies require different combinations - of resources. By specifying the type of simulation to run, you enable - the policy simulator to enforce the presence of the required resources - to ensure reliable simulation results. If your simulation does not match - one of the following scenarios, then you can omit this parameter. The - following list shows each of the supported scenario values and the resources - that you must define to run the simulation.
Each of the EC2 scenarios - requires that you specify instance, image, and security group resources. - If your scenario includes an EBS volume, then you must specify that - volume as a resource. If the EC2 scenario includes VPC, then you must - supply the network interface resource. If it includes an IP subnet, - then you must specify the subnet resource. For more information on the - EC2 scenario options, see Supported - platforms in the Amazon EC2 User Guide.
- EC2-Classic-InstanceStore
instance, image, security group
-EC2-Classic-EBS
instance, image, security - group, volume
EC2-VPC-InstanceStore
instance, - image, security group, network interface
EC2-VPC-InstanceStore-Subnet -
instance, image, security group, network interface, subnet
-EC2-VPC-EBS
instance, image, security - group, network interface, volume
EC2-VPC-EBS-Subnet -
instance, image, security group, network interface, subnet, - volume
ResourceOwner
- is specified, it is also used as the account owner of any ResourcePolicy
- included in the simulation. If the ResourceOwner parameter
- is not specified, then the owner of the resources and the resource policy
- defaults to the account of the identity provided in CallerArn.
- This parameter is required only if you specify a resource-based policy
- and account that owns the resource is different from the account that
- owns the simulated calling user CallerArn.
- ResourcePolicy:
- allOf:
- - $ref: '#/components/schemas/policyDocumentType'
- - description: A resource-based policy to include in the simulation provided - as a string. Each resource in the simulation is treated as if it had - this policy attached. You can include only one resource-based policy - in a simulation.
The maximum length of the policy document that - you can pass in this operation, including whitespace, is listed below. - To view the maximum character counts of a managed policy with no whitespaces, - see IAM - and STS character quotas.
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)
Contains a reference to a Statement element in
- a policy document that determines the result of the simulation.
This
- data type is used by the MatchedStatements member of the
- EvaluationResult type.
Statement
- in an IAM policy.
- SourcePolicyId:
- allOf:
- - $ref: '#/components/schemas/PolicyIdentifierType'
- - description: The identifier of the policy that was provided as an input.
- SourcePolicyType:
- allOf:
- - $ref: '#/components/schemas/PolicySourceType'
- - description: The type of the policy.
- StartPosition:
- allOf:
- - $ref: '#/components/schemas/Position'
- - description: The row and column of the beginning of the Statement
- in an IAM policy.
- type: object
- StatementListType:
- items:
- allOf:
- - $ref: '#/components/schemas/Statement'
- - xml:
- name: member
- type: array
- Tag:
- description: A structure that represents user-provided metadata that can be
- associated with an IAM resource. For more information about tagging, see Tagging
- IAM resources in the IAM User Guide.
- 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 name of the IAM instance profile to which you want - to add tags.
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: _+=,.@-
' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the IAM instance - profile. Each tag consists of a key name and an associated value. - required: - - InstanceProfileName - - Tags - title: TagInstanceProfileRequest - type: object - TagMFADeviceRequest: - properties: - SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: 'The unique identifier for the IAM virtual MFA device - to which you want to add tags. For virtual MFA devices, the serial number - is the same as the ARN.
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: - _+=,.@-
' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the IAM virtual - MFA device. Each tag consists of a key name and an associated value. - required: - - SerialNumber - - Tags - title: TagMFADeviceRequest - type: object - TagOpenIDConnectProviderRequest: - properties: - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: 'The ARN of the OIDC identity provider in IAM to which - you want to add tags.
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: _+=,.@-
' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the OIDC identity - provider in IAM. Each tag consists of a key name and an associated value. - required: - - OpenIDConnectProviderArn - - Tags - title: TagOpenIDConnectProviderRequest - type: object - TagPolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: 'The ARN of the IAM customer managed policy to which you - want to add tags.
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: _+=,.@-
' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the IAM customer - managed policy. Each tag consists of a key name and an associated value. - required: - - PolicyArn - - Tags - title: TagPolicyRequest - type: object - TagRoleRequest: - properties: - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: 'The name of the IAM role to which you want to add tags.
-This parameter accepts (through its regex - pattern) a string of characters that consist of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-
' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the IAM role. - Each tag consists of a key name and an associated value. - required: - - RoleName - - Tags - title: TagRoleRequest - type: object - TagSAMLProviderRequest: - properties: - SAMLProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: 'The ARN of the SAML identity provider in IAM to which - you want to add tags.
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: _+=,.@-
' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the SAML identity - provider in IAM. Each tag consists of a key name and an associated value. - required: - - SAMLProviderArn - - Tags - title: TagSAMLProviderRequest - type: object - TagServerCertificateRequest: - properties: - ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: 'The name of the IAM server certificate to which you want - to add tags.
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: _+=,.@-
' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the IAM server - certificate. Each tag consists of a key name and an associated value. - required: - - ServerCertificateName - - Tags - title: TagServerCertificateRequest - type: object - TagUserRequest: - properties: - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the IAM user. - Each tag consists of a key name and an associated value. - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the IAM user to which you want to add tags.
-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: _+=,.@-
' - required: - - UserName - - Tags - title: TagUserRequest - type: object - TrackedActionLastAccessed: - description:Contains details about the most recent attempt to access an - action within the service.
This data type is used as a response element - in the GetServiceLastAccessedDetails operation.
- properties: - ActionName: - allOf: - - $ref: '#/components/schemas/stringType' - - description: The name of the tracked action to which access was attempted. - Tracked actions are actions that report activity to IAM. - LastAccessedEntity: - $ref: '#/components/schemas/arnType' - LastAccessedRegion: - allOf: - - $ref: '#/components/schemas/stringType' - - description:The Region from which the authenticated entity (user or - role) last attempted to access the tracked action. Amazon Web Services - does not report unauthenticated requests.
This field is null - if no IAM entities attempted to access the service within the reporting - period.
- LastAccessedTime: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "The date and time, in\_ISO 8601 date-time format, when an authenticated entity most recently\ - \ attempted to access the tracked service. Amazon Web Services does\ - \ not report unauthenticated requests.
This field is null if\ - \ no IAM entities attempted to access the service within the reporting period.
" - type: object - TrackedActionsLastAccessed: - items: - allOf: - - $ref: '#/components/schemas/TrackedActionLastAccessed' - - xml: - name: member - type: array - UnmodifiableEntityException: {} - UnrecognizedPublicKeyEncodingException: {} - UntagInstanceProfileRequest: - properties: - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: 'The name of the IAM instance profile from which you want - to remove tags.
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: _+=,.@-
' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified instance profile. - required: - - InstanceProfileName - - TagKeys - title: UntagInstanceProfileRequest - type: object - UntagMFADeviceRequest: - properties: - SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: 'The unique identifier for the IAM virtual MFA device - from which you want to remove tags. For virtual MFA devices, the serial - number is the same as the ARN.
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: - _+=,.@-
' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified instance profile. - required: - - SerialNumber - - TagKeys - title: UntagMFADeviceRequest - type: object - UntagOpenIDConnectProviderRequest: - properties: - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: 'The ARN of the OIDC provider in IAM from which you want - to remove tags.
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: _+=,.@-
' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified OIDC provider. - required: - - OpenIDConnectProviderArn - - TagKeys - title: UntagOpenIDConnectProviderRequest - type: object - UntagPolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: 'The ARN of the IAM customer managed policy from which - you want to remove tags.
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: - _+=,.@-
' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified policy. - required: - - PolicyArn - - TagKeys - title: UntagPolicyRequest - type: object - UntagRoleRequest: - properties: - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: 'The name of the IAM role from which you want to remove - tags.
This parameter accepts (through its regex - pattern) a string of characters that consist of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-
' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified role. - required: - - RoleName - - TagKeys - title: UntagRoleRequest - type: object - UntagSAMLProviderRequest: - properties: - SAMLProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: 'The ARN of the SAML identity provider in IAM from which - you want to remove tags.
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: - _+=,.@-
' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified SAML identity provider. - required: - - SAMLProviderArn - - TagKeys - title: UntagSAMLProviderRequest - type: object - UntagServerCertificateRequest: - properties: - ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: 'The name of the IAM server certificate from which you - want to remove tags.
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: _+=,.@-
' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified IAM server certificate. - required: - - ServerCertificateName - - TagKeys - title: UntagServerCertificateRequest - type: object - UntagUserRequest: - properties: - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified user. - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'The name of the IAM user from which you want to remove - tags.
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: _+=,.@-
' - required: - - UserName - - TagKeys - title: UntagUserRequest - type: object - UpdateAccessKeyRequest: - properties: - AccessKeyId: - allOf: - - $ref: '#/components/schemas/accessKeyIdType' - - description:The access key ID of the secret access key you want to - update.
This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.
- Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: ' The status you want to assign to the secret access key. -Active means that the key can be used for programmatic
- calls to Amazon Web Services, while Inactive means that
- the key cannot be used.'
- UserName:
- allOf:
- - $ref: '#/components/schemas/existingUserNameType'
- - description: 'The name of the user whose key you want to update.
-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: _+=,.@-
' - required: - - AccessKeyId - - Status - title: UpdateAccessKeyRequest - type: object - UpdateAccountPasswordPolicyRequest: - properties: - AllowUsersToChangePassword: - allOf: - - $ref: '#/components/schemas/booleanType' - - description:Allows all IAM users in your account to use the Amazon - Web Services Management Console to change their own passwords. For more - information, see Permitting - IAM users to change their own passwords in the IAM User Guide.
-If you do not specify a value for this parameter, then the operation
- uses the default value of false. The result is that IAM
- users in the account do not automatically have permissions to change
- their own password.
Prevents IAM users who are accessing the account via - the Amazon Web Services Management Console from setting a new console - password after their password has expired. The IAM user cannot access - the console until an administrator resets the password.
If you
- do not specify a value for this parameter, then the operation uses the
- default value of false. The result is that IAM users can
- change their passwords after they expire and continue to sign in as
- the user.
In the Amazon Web Services Management Console,
- the custom password policy option Allow users to change their own
- password gives IAM users permissions to iam:ChangePassword
- for only their user and to the iam:GetAccountPasswordPolicy
- action. This option does not attach a permissions policy to each user,
- rather the permissions are applied at the account-level for all users
- by IAM. IAM users with iam:ChangePassword permission and
- active access keys can reset their own expired console password using
- the CLI or API.
The number of days that an IAM user password is valid.
-If you do not specify a value for this parameter, then the operation
- uses the default value of 0. The result is that IAM user
- passwords never expire.
The minimum number of characters allowed in an IAM user - password.
If you do not specify a value for this parameter, then
- the operation uses the default value of 6.
Specifies the number of previous passwords that IAM users - are prevented from reusing.
If you do not specify a value for
- this parameter, then the operation uses the default value of 0.
- The result is that IAM users are not prevented from reusing previous
- passwords.
Specifies whether IAM user passwords must contain at least - one lowercase character from the ISO basic Latin alphabet (a to z).
-If you do not specify a value for this parameter, then the operation
- uses the default value of false. The result is that passwords
- do not require at least one lowercase character.
Specifies whether IAM user passwords must contain at least - one numeric character (0 to 9).
If you do not specify a value
- for this parameter, then the operation uses the default value of false.
- The result is that passwords do not require at least one numeric character.
Specifies whether IAM user passwords must contain at - least one of the following non-alphanumeric characters:
! @ # - $ % ^ & * ( ) _ + - = [ ] { } | ''
If you do not specify
- a value for this parameter, then the operation uses the default value
- of false. The result is that passwords do not require at
- least one symbol character.
Specifies whether IAM user passwords must contain at least - one uppercase character from the ISO basic Latin alphabet (A to Z).
-If you do not specify a value for this parameter, then the operation
- uses the default value of false. The result is that passwords
- do not require at least one uppercase character.
The policy that grants an entity permission to assume - the role.
You must provide policies in JSON format in IAM. 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)
The name of the role to update with the new policy.
-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: _+=,.@-
' - required: - - RoleName - - PolicyDocument - title: UpdateAssumeRolePolicyRequest - type: object - UpdateGroupRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: 'Name of the IAM group to update. If you''re changing - the name of the group, this is the original name.
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: _+=,.@-
' - NewGroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description:New name for the IAM group. Only include this if changing - the group's name.
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".
- NewPath: - allOf: - - $ref: '#/components/schemas/pathType' - - description:New path for the IAM group. Only include this if changing - the group's path.
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 new password for the specified IAM user.
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)
However, the format can be further restricted by the - account administrator by setting a password policy on the Amazon Web - Services account. For more information, see UpdateAccountPasswordPolicy.
- PasswordResetRequired: - allOf: - - $ref: '#/components/schemas/booleanObjectType' - - description: Allows this new password to be used only once by requiring - the specified IAM user to set a new password on next sign-in. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: 'The name of the user whose password you want to update.
-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: _+=,.@-
' - required: - - UserName - title: UpdateLoginProfileRequest - type: object - UpdateOpenIDConnectProviderThumbprintRequest: - properties: - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:The Amazon Resource Name (ARN) of the IAM OIDC provider - resource object for which you want to update the thumbprint. You can - get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders - operation.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- ThumbprintList: - allOf: - - $ref: '#/components/schemas/thumbprintListType' - - description: 'A list of certificate thumbprints that are associated with - the specified IAM OpenID Connect provider. For more information, see - CreateOpenIDConnectProvider. ' - required: - - OpenIDConnectProviderArn - - ThumbprintList - title: UpdateOpenIDConnectProviderThumbprintRequest - type: object - UpdateRoleDescriptionRequest: - properties: - Description: - allOf: - - $ref: '#/components/schemas/roleDescriptionType' - - description: The new description that you want to apply to the specified - role. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The name of the role that you want to modify. - required: - - RoleName - - Description - title: UpdateRoleDescriptionRequest - type: object - UpdateRoleDescriptionResponse: - properties: - Role: - allOf: - - $ref: '#/components/schemas/Role' - - description: A structure that contains details about the modified role. - type: object - UpdateRoleRequest: - properties: - Description: - allOf: - - $ref: '#/components/schemas/roleDescriptionType' - - description: The new description that you want to apply to the specified - 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 maximum 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 Amazon Resource Name (ARN) of the SAML provider to - update.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- required: - - SAMLMetadataDocument - - SAMLProviderArn - title: UpdateSAMLProviderRequest - type: object - UpdateSAMLProviderResponse: - description: 'Contains the response to a successful UpdateSAMLProvider - request. ' - properties: - SAMLProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The Amazon Resource Name (ARN) of the SAML provider that - was updated. - type: object - UpdateSSHPublicKeyRequest: - properties: - SSHPublicKeyId: - allOf: - - $ref: '#/components/schemas/publicKeyIdType' - - description:The unique identifier for the SSH public key.
This - parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.
- Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status to assign to the SSH public key.Active
- means that the key can be used for authentication with an CodeCommit
- repository. Inactive means that the key cannot be used.
- UserName:
- allOf:
- - $ref: '#/components/schemas/userNameType'
- - description: 'The name of the IAM user associated with the SSH public - key.
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: _+=,.@-
' - required: - - UserName - - SSHPublicKeyId - - Status - title: UpdateSSHPublicKeyRequest - type: object - UpdateServerCertificateRequest: - properties: - NewPath: - allOf: - - $ref: '#/components/schemas/pathType' - - description:The new path for the server certificate. Include this - only if you are updating the server certificate's path.
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 new name for the server certificate. Include this - only if you are updating the server certificate''s name. The name of - the certificate cannot contain any spaces.
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: _+=,.@-
' - ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: 'The name of the server certificate that you want to update.
-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: _+=,.@-
' - required: - - ServerCertificateName - title: UpdateServerCertificateRequest - type: object - UpdateServiceSpecificCredentialRequest: - properties: - ServiceSpecificCredentialId: - allOf: - - $ref: '#/components/schemas/serviceSpecificCredentialId' - - description:The unique identifier of the service-specific credential.
-This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.
- Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status to be assigned to the service-specific credential. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: 'The name of the IAM user associated with the service-specific - credential. If you do not specify this value, then the operation assumes - the user whose credentials are used to call the operation.
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: _+=,.@-
' - required: - - ServiceSpecificCredentialId - - Status - title: UpdateServiceSpecificCredentialRequest - type: object - UpdateSigningCertificateRequest: - properties: - CertificateId: - allOf: - - $ref: '#/components/schemas/certificateIdType' - - description:The ID of the signing certificate you want to update.
-This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.
- Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: ' The status you want to assign to the certificate.Active
- means that the certificate can be used for programmatic calls to Amazon
- Web Services Inactive means that the certificate cannot
- be used.'
- UserName:
- allOf:
- - $ref: '#/components/schemas/existingUserNameType'
- - description: 'The name of the IAM user the signing certificate belongs - to.
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: _+=,.@-
' - required: - - CertificateId - - Status - title: UpdateSigningCertificateRequest - type: object - UpdateUserRequest: - properties: - NewPath: - allOf: - - $ref: '#/components/schemas/pathType' - - description:New path for the IAM user. Include this parameter only - if you're changing the user's path.
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.
New name for the user. Include this parameter only if - you're changing the user's name.
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".
- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: 'Name of the user to update. If you''re changing the name - of the user, this is the original user name.
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: _+=,.@-
' - required: - - UserName - title: UpdateUserRequest - type: object - UploadSSHPublicKeyRequest: - properties: - SSHPublicKeyBody: - allOf: - - $ref: '#/components/schemas/publicKeyMaterialType' - - description:The SSH public key. The public key must be encoded in - ssh-rsa format or PEM format. The minimum bit-length of the public key - is 2048 bits. For example, you can generate a 2048-bit key, and the - resulting PEM file is 1679 bytes long.
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)
The name of the IAM user to associate the SSH public - key with.
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: _+=,.@-
' - required: - - UserName - - SSHPublicKeyBody - title: UploadSSHPublicKeyRequest - type: object - UploadSSHPublicKeyResponse: - description: Contains the response to a successful UploadSSHPublicKey - request. - properties: - SSHPublicKey: - allOf: - - $ref: '#/components/schemas/SSHPublicKey' - - description: Contains information about the SSH public key. - type: object - UploadServerCertificateRequest: - properties: - CertificateBody: - allOf: - - $ref: '#/components/schemas/certificateBodyType' - - description:The contents of the public key certificate in PEM-encoded - format.
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)
The contents of the certificate chain. This is typically - a concatenation of the PEM-encoded public key certificates of the chain.
-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)
The path for the server certificate. 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.
- If you are uploading a server certificate specifically for use with
- Amazon CloudFront distributions, you must specify a path using the path
- parameter. The path must begin with /cloudfront and must
- include a trailing slash (for example, /cloudfront/test/).
The contents of the private key in PEM-encoded format.
-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)
The name for the server certificate. Do not include the - path in this value. The name of the certificate cannot contain any spaces.
-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: _+=,.@-
' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description:A list of tags that you want to attach to the new IAM - server certificate resource. 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.
-The contents of the signing certificate.
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)
The name of the user the signing certificate is for.
-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: _+=,.@-
' - required: - - CertificateBody - title: UploadSigningCertificateRequest - type: object - UploadSigningCertificateResponse: - description: 'Contains the response to a successful UploadSigningCertificate - request. ' - example: - Certificate: - CertificateBody: '-----BEGIN CERTIFICATE-----Contains information about an IAM user entity.
This data - type is used as a response element in the following operations:
- properties: - Arn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: 'The Amazon Resource Name (ARN) that identifies the user. - For more information about ARNs and how to use ARNs 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 user was created. - PasswordLastUsed: - allOf: - - $ref: '#/components/schemas/dateType' - - description:The date and time, in ISO - 8601 date-time format, when the user's password was last used to - sign in to an Amazon Web Services website. For a list of Amazon Web - Services websites that capture a user's last sign-in time, see the Credential - reports topic in the IAM User Guide. If a password is used - more than once in a five-minute span, only the first use is returned - in this field. If the field is null (no value), then it indicates that - they never signed in with a password. This can be because:
The user never had a password.
A password - exists but has not been used since IAM started tracking this information - on October 20, 2014.
A null value does not mean that - the user never had a password. Also, if the user does not currently - have a password but had one in the past, then this field contains the - date and time the most recent password was used.
This value is - returned only in the GetUser and ListUsers operations. -
- Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description:The path to the user. For more information about paths, - see IAM - identifiers in the IAM User Guide.
The ARN of the - policy used to set the permissions boundary for the user.
- PermissionsBoundary: - allOf: - - $ref: '#/components/schemas/AttachedPermissionsBoundary' - - description: 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 associated with the user. For more - information about tagging, see Tagging - IAM resources in the IAM User Guide. - UserId: - allOf: - - $ref: '#/components/schemas/idType' - - description: The stable and unique string identifying the user. For more - information about IDs, see IAM - identifiers in the IAM User Guide. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The friendly name identifying the user. - required: - - Path - - UserName - - UserId - - Arn - - CreateDate - type: object - UserDetail: - description:Contains information about an IAM user, including all the user's - policies and all the IAM groups the user is in.
This data type is used - as a response element in the GetAccountAuthorizationDetails operation.
- properties: - Arn: - $ref: '#/components/schemas/arnType' - AttachedManagedPolicies: - allOf: - - $ref: '#/components/schemas/attachedPoliciesListType' - - description: A list of the managed policies attached to the user. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the user was created. - GroupList: - allOf: - - $ref: '#/components/schemas/groupNameListType' - - description: A list of IAM groups that the user is in. - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description: The path to the user. For more information about paths, see - IAM - identifiers in the IAM User Guide. - PermissionsBoundary: - allOf: - - $ref: '#/components/schemas/AttachedPermissionsBoundary' - - description:The ARN of the policy used to set the permissions boundary - for the user.
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 associated with the user. For more - information about tagging, see Tagging - IAM resources in the IAM User Guide. - UserId: - allOf: - - $ref: '#/components/schemas/idType' - - description: The stable and unique string identifying the user. For more - information about IDs, see IAM - identifiers in the IAM User Guide. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The friendly name identifying the user. - UserPolicyList: - allOf: - - $ref: '#/components/schemas/policyDetailListType' - - description: A list of the inline policies embedded in the user. - type: object - VirtualMFADevice: - description: Contains information about a virtual MFA device. - properties: - Base32StringSeed: - allOf: - - $ref: '#/components/schemas/BootstrapDatum' - - description: ' The base32 seed defined as specified in RFC3548. - TheBase32StringSeed is base64-encoded. '
- EnableDate:
- allOf:
- - $ref: '#/components/schemas/dateType'
- - description: The date and time on which the virtual MFA device was enabled.
- QRCodePNG:
- allOf:
- - $ref: '#/components/schemas/BootstrapDatum'
- - description: ' A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String
- where $virtualMFADeviceName is one of the create call arguments.
- AccountName is the user name if set (otherwise, the account
- ID otherwise), and Base32String is the seed in base32 format.
- The Base32String value is base64-encoded. '
- SerialNumber:
- allOf:
- - $ref: '#/components/schemas/serialNumberType'
- - description: The serial number associated with VirtualMFADevice.
- Tags:
- allOf:
- - $ref: '#/components/schemas/tagListType'
- - description: A list of tags that are attached to the virtual MFA device.
- For more information about tagging, see Tagging
- IAM resources in the IAM User Guide.
- User:
- allOf:
- - $ref: '#/components/schemas/User'
- - description: The IAM user associated with this virtual MFA device.
- required:
- - SerialNumber
- type: object
- accessKeyIdType:
- maxLength: 128
- minLength: 16
- pattern: '[\w]+'
- type: string
- accessKeyMetadataListType:
- description: Contains a list of access key metadata.
This data type - is used as a response element in the ListAccessKeys operation.
- items: - allOf: - - $ref: '#/components/schemas/AccessKeyMetadata' - - xml: - name: member - type: array - accessKeySecretType: - format: password - type: string - accountAliasListType: - items: - allOf: - - $ref: '#/components/schemas/accountAliasType' - - xml: - name: member - type: array - accountAliasType: - maxLength: 63 - minLength: 3 - pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$ - type: string - arnType: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - assignmentStatusType: - enum: - - Assigned - - Unassigned - - Any - type: string - attachedPoliciesListType: - items: - allOf: - - $ref: '#/components/schemas/AttachedPolicy' - - xml: - name: member - type: array - attachmentCountType: - type: integer - authenticationCodeType: - maxLength: 6 - minLength: 6 - pattern: '[\d]+' - type: string - booleanObjectType: - type: boolean - booleanType: - type: boolean - certificateBodyType: - maxLength: 16384 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - certificateChainType: - maxLength: 2097152 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - certificateIdType: - maxLength: 128 - minLength: 24 - pattern: '[\w]+' - type: string - certificateListType: - description:Contains a list of signing certificates.
This data type - is used as a response element in the ListSigningCertificates operation.
- items: - allOf: - - $ref: '#/components/schemas/SigningCertificate' - - xml: - name: member - type: array - clientIDListType: - items: - allOf: - - $ref: '#/components/schemas/clientIDType' - - xml: - name: member - type: array - clientIDType: - maxLength: 255 - minLength: 1 - type: string - customSuffixType: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - dateType: - format: date-time - type: string - encodingType: - enum: - - SSH - - PEM - type: string - entityDetailsListType: - items: - allOf: - - $ref: '#/components/schemas/EntityDetails' - - xml: - name: member - type: array - entityListType: - items: - allOf: - - $ref: '#/components/schemas/EntityType' - - xml: - name: member - type: array - entityNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - existingUserNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - globalEndpointTokenVersion: - enum: - - v1Token - - v2Token - type: string - groupDetailListType: - items: - allOf: - - $ref: '#/components/schemas/GroupDetail' - - xml: - name: member - type: array - groupListType: - description:Contains a list of IAM groups.
This data type is used - as a response element in the ListGroups operation.
- items: - allOf: - - $ref: '#/components/schemas/Group' - - xml: - name: member - type: array - groupNameListType: - items: - allOf: - - $ref: '#/components/schemas/groupNameType' - - xml: - name: member - type: array - groupNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - idType: - maxLength: 128 - minLength: 16 - pattern: '[\w]+' - type: string - instanceProfileListType: - description: Contains a list of instance profiles. - items: - allOf: - - $ref: '#/components/schemas/InstanceProfile' - - xml: - name: member - type: array - instanceProfileNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - integerType: - type: integer - jobIDType: - maxLength: 36 - minLength: 36 - type: string - jobStatusType: - enum: - - IN_PROGRESS - - COMPLETED - - FAILED - type: string - listPolicyGrantingServiceAccessResponseListType: - items: - allOf: - - $ref: '#/components/schemas/ListPoliciesGrantingServiceAccessEntry' - - xml: - name: member - type: array - markerType: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - maxItemsType: - maximum: 1000 - minimum: 1 - type: integer - maxPasswordAgeType: - maximum: 1095 - minimum: 1 - type: integer - mfaDeviceListType: - description:Contains a list of MFA devices.
This data type is used - as a response element in the ListMFADevices and ListVirtualMFADevices - operations.
- items: - allOf: - - $ref: '#/components/schemas/MFADevice' - - xml: - name: member - type: array - minimumPasswordLengthType: - maximum: 128 - minimum: 6 - type: integer - organizationsEntityPathType: - maxLength: 427 - minLength: 19 - pattern: ^o-[0-9a-z]{10,32}\/r-[0-9a-z]{4,32}[0-9a-z-\/]* - type: string - organizationsPolicyIdType: - pattern: ^p-[0-9a-zA-Z_]{8,128}$ - type: string - passwordReusePreventionType: - maximum: 24 - minimum: 1 - type: integer - passwordType: - format: password - maxLength: 128 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - pathPrefixType: - maxLength: 512 - minLength: 1 - pattern: \u002F[\u0021-\u007F]* - type: string - pathType: - maxLength: 512 - minLength: 1 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - policyDescriptionType: - maxLength: 1000 - type: string - policyDetailListType: - items: - allOf: - - $ref: '#/components/schemas/PolicyDetail' - - xml: - name: member - type: array - policyDocumentType: - maxLength: 131072 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - policyDocumentVersionListType: - items: - allOf: - - $ref: '#/components/schemas/PolicyVersion' - - xml: - name: member - type: array - policyGrantingServiceAccessListType: - items: - allOf: - - $ref: '#/components/schemas/PolicyGrantingServiceAccess' - - xml: - name: member - type: array - policyListType: - items: - allOf: - - $ref: '#/components/schemas/Policy' - - xml: - name: member - type: array - policyNameListType: - description:Contains a list of policy names.
This data type is used - as a response element in the ListPolicies operation.
- items: - allOf: - - $ref: '#/components/schemas/policyNameType' - - xml: - name: member - type: array - policyNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - policyOwnerEntityType: - enum: - - USER - - ROLE - - GROUP - type: string - policyPathType: - maxLength: 512 - minLength: 1 - pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/ - type: string - policyScopeType: - enum: - - All - - AWS - - Local - type: string - policyType: - enum: - - INLINE - - MANAGED - type: string - policyVersionIdType: - pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? - type: string - privateKeyType: - format: password - maxLength: 16384 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - publicKeyFingerprintType: - maxLength: 48 - minLength: 48 - pattern: '[:\w]+' - type: string - publicKeyIdType: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - publicKeyMaterialType: - maxLength: 16384 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - responseMarkerType: - type: string - roleDescriptionType: - maxLength: 1000 - pattern: '[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*' - type: string - roleDetailListType: - items: - allOf: - - $ref: '#/components/schemas/RoleDetail' - - xml: - name: member - type: array - roleListType: - description:Contains a list of IAM roles.
This data type is used - as a response element in the ListRoles operation.
- items: - allOf: - - $ref: '#/components/schemas/Role' - - xml: - name: member - type: array - roleMaxSessionDurationType: - maximum: 43200 - minimum: 3600 - type: integer - roleNameType: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - serialNumberType: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - serverCertificateMetadataListType: - items: - allOf: - - $ref: '#/components/schemas/ServerCertificateMetadata' - - xml: - name: member - type: array - serverCertificateNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - serviceName: - type: string - serviceNameType: - type: string - serviceNamespaceListType: - items: - allOf: - - $ref: '#/components/schemas/serviceNamespaceType' - - xml: - name: member - maxItems: 200 - minItems: 1 - type: array - serviceNamespaceType: - maxLength: 64 - minLength: 1 - pattern: '[\w-]*' - type: string - servicePassword: - format: password - type: string - serviceSpecificCredentialId: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - serviceUserName: - maxLength: 200 - minLength: 17 - pattern: '[\w+=,.@-]+' - type: string - sortKeyType: - enum: - - SERVICE_NAMESPACE_ASCENDING - - SERVICE_NAMESPACE_DESCENDING - - LAST_AUTHENTICATED_TIME_ASCENDING - - LAST_AUTHENTICATED_TIME_DESCENDING - type: string - statusType: - enum: - - Active - - Inactive - type: string - stringType: - type: string - summaryKeyType: - enum: - - Users - - UsersQuota - - Groups - - GroupsQuota - - ServerCertificates - - ServerCertificatesQuota - - UserPolicySizeQuota - - GroupPolicySizeQuota - - GroupsPerUserQuota - - SigningCertificatesPerUserQuota - - AccessKeysPerUserQuota - - MFADevices - - MFADevicesInUse - - AccountMFAEnabled - - AccountAccessKeysPresent - - AccountSigningCertificatesPresent - - AttachedPoliciesPerGroupQuota - - AttachedPoliciesPerRoleQuota - - AttachedPoliciesPerUserQuota - - Policies - - PoliciesQuota - - PolicySizeQuota - - PolicyVersionsInUse - - PolicyVersionsInUseQuota - - VersionsPerPolicyQuota - - GlobalEndpointTokenVersion - type: string - summaryMapType: - additionalProperties: - $ref: '#/components/schemas/summaryValueType' - type: object - summaryValueType: - type: integer - tagKeyListType: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - tagKeyType: - maxLength: 128 - minLength: 1 - pattern: '[\p{L}\p{Z}\p{N}_.:/=+\-@]+' - type: string - tagListType: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - tagValueType: - maxLength: 256 - minLength: 0 - pattern: '[\p{L}\p{Z}\p{N}_.:/=+\-@]*' - type: string - thumbprintListType: - description: Contains a list of thumbprints of identity provider server certificates. - items: - allOf: - - $ref: '#/components/schemas/thumbprintType' - - xml: - name: member - type: array - thumbprintType: - description:Contains a thumbprint for an identity provider's server certificate.
-The identity provider's server certificate thumbprint is the hex-encoded - SHA-1 hash value of the self-signed X.509 certificate. This thumbprint is - used by the domain where the OpenID Connect provider makes its keys available. - The thumbprint is always a 40-character string.
- maxLength: 40 - minLength: 40 - type: string - userDetailListType: - items: - allOf: - - $ref: '#/components/schemas/UserDetail' - - xml: - name: member - type: array - userListType: - description:Contains a list of users.
This data type is used as a - response element in the GetGroup and ListUsers operations.
- items: - allOf: - - $ref: '#/components/schemas/User' - - xml: - name: member - type: array - userNameType: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - virtualMFADeviceListType: - items: - allOf: - - $ref: '#/components/schemas/VirtualMFADevice' - - xml: - name: member - type: array - virtualMFADeviceName: - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - securitySchemes: - hmac: - description: Amazon Signature authorization v4 - in: header - name: Authorization - type: apiKey - x-amazon-apigateway-authtype: awsSigv4 - x-stackQL-resources: - access_key_last_useds: - id: aws.iam.access_key_last_useds - methods: - access_key_last_useds_Get: - operation: - $ref: '#/paths/~1?Action=GetAccessKeyLastUsed&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetAccessKeyLastUsedResult - openAPIDocKey: '200' - name: access_key_last_useds - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/access_key_last_useds/methods/access_key_last_useds_Get' - update: [] - title: access_key_last_useds - access_keys: - id: aws.iam.access_keys - methods: - access_keys_Create: - operation: - $ref: '#/paths/~1?Action=CreateAccessKey&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - access_keys_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteAccessKey&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - access_keys_List: - operation: - $ref: '#/paths/~1?Action=ListAccessKeys&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListAccessKeysResult/AccessKeyMetadata/member - openAPIDocKey: '200' - access_keys_Update: - operation: - $ref: '#/paths/~1?Action=UpdateAccessKey&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: access_keys - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/access_keys/methods/access_keys_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/access_keys/methods/access_keys_Create' - select: - - $ref: '#/components/x-stackQL-resources/access_keys/methods/access_keys_List' - update: [] - title: access_keys - account_alias: - id: aws.iam.account_alias - methods: - account_alias_Create: - operation: - $ref: '#/paths/~1?Action=CreateAccountAlias&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - account_alias_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteAccountAlias&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: account_alias - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/account_alias/methods/account_alias_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/account_alias/methods/account_alias_Create' - select: [] - update: [] - title: account_alias - account_aliases: - id: aws.iam.account_aliases - methods: - account_aliases_List: - operation: - $ref: '#/paths/~1?Action=ListAccountAliases&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListAccountAliasesResult/AccountAliases/member - openAPIDocKey: '200' - name: account_aliases - sqlVerbs: - delete: [] - insert: [] - select: [] - # - $ref: '#/components/x-stackQL-resources/account_aliases/methods/account_aliases_List' - update: [] - title: account_aliases - account_authorization_details: - id: aws.iam.account_authorization_details - methods: - account_authorization_details_Get: - operation: - $ref: '#/paths/~1?Action=GetAccountAuthorizationDetails&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetAccountAuthorizationDetailsResult - openAPIDocKey: '200' - name: account_authorization_details - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/account_authorization_details/methods/account_authorization_details_Get' - update: [] - title: account_authorization_details - account_password_policies: - id: aws.iam.account_password_policies - methods: - account_password_policies_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteAccountPasswordPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - account_password_policies_Get: - operation: - $ref: '#/paths/~1?Action=GetAccountPasswordPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetAccountPasswordPolicyResult - openAPIDocKey: '200' - account_password_policies_Update: - operation: - $ref: '#/paths/~1?Action=UpdateAccountPasswordPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: account_password_policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/account_password_policies/methods/account_password_policies_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/account_password_policies/methods/account_password_policies_Get' - update: [] - title: account_password_policies - account_summaries: - id: aws.iam.account_summaries - methods: - account_summaries_Get: - operation: - $ref: '#/paths/~1?Action=GetAccountSummary&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetAccountSummaryResult - openAPIDocKey: '200' - name: account_summaries - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/account_summaries/methods/account_summaries_Get' - update: [] - title: account_summaries - assume_role_policies: - id: aws.iam.assume_role_policies - methods: - assume_role_policies_Update: - operation: - $ref: '#/paths/~1?Action=UpdateAssumeRolePolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: assume_role_policies - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: assume_role_policies - attached_group_policies: - id: aws.iam.attached_group_policies - methods: - attached_group_policies_List: - operation: - $ref: '#/paths/~1?Action=ListAttachedGroupPolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListAttachedGroupPoliciesResult/AttachedPolicies/member - openAPIDocKey: '200' - name: attached_group_policies - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/attached_group_policies/methods/attached_group_policies_List' - update: [] - title: attached_group_policies - attached_role_policies: - id: aws.iam.attached_role_policies - methods: - attached_role_policies_List: - operation: - $ref: '#/paths/~1?Action=ListAttachedRolePolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListAttachedRolePoliciesResult/AttachedPolicies/member - openAPIDocKey: '200' - name: attached_role_policies - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/attached_role_policies/methods/attached_role_policies_List' - update: [] - title: attached_role_policies - attached_user_policies: - id: aws.iam.attached_user_policies - methods: - attached_user_policies_List: - operation: - $ref: '#/paths/~1?Action=ListAttachedUserPolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListAttachedUserPoliciesResult/AttachedPolicies/member - openAPIDocKey: '200' - name: attached_user_policies - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/attached_user_policies/methods/attached_user_policies_List' - update: [] - title: attached_user_policies - client_id_from_open_id_connect_providers: - id: aws.iam.client_id_from_open_id_connect_providers - methods: - client_id_from_open_id_connect_providers_Remove: - operation: - $ref: '#/paths/~1?Action=RemoveClientIDFromOpenIDConnectProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: client_id_from_open_id_connect_providers - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: client_id_from_open_id_connect_providers - # client_id_to_open_id_connect_providers: - # id: aws.iam.client_id_to_open_id_connect_providers - # methods: {} - # name: client_id_to_open_id_connect_providers - # sqlVerbs: - # delete: [] - # insert: [] - # select: [] - # update: [] - # title: client_id_to_open_id_connect_providers - context_keys_for_custom_policies: - id: aws.iam.context_keys_for_custom_policies - methods: - context_keys_for_custom_policies_Get: - operation: - $ref: '#/paths/~1?Action=GetContextKeysForCustomPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetContextKeysForCustomPolicyResult - openAPIDocKey: '200' - name: context_keys_for_custom_policies - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/context_keys_for_custom_policies/methods/context_keys_for_custom_policies_Get' - update: [] - title: context_keys_for_custom_policies - context_keys_for_principal_policies: - id: aws.iam.context_keys_for_principal_policies - methods: - context_keys_for_principal_policies_Get: - operation: - $ref: '#/paths/~1?Action=GetContextKeysForPrincipalPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetContextKeysForPrincipalPolicyResult - openAPIDocKey: '200' - name: context_keys_for_principal_policies - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/context_keys_for_principal_policies/methods/context_keys_for_principal_policies_Get' - update: [] - title: context_keys_for_principal_policies - credential_reports: - id: aws.iam.credential_reports - methods: - credential_reports_Generate: - operation: - $ref: '#/paths/~1?Action=GenerateCredentialReport&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - credential_reports_Get: - operation: - $ref: '#/paths/~1?Action=GetCredentialReport&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetCredentialReportResult - openAPIDocKey: '200' - name: credential_reports - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/credential_reports/methods/credential_reports_Get' - update: [] - title: credential_reports - custom_policies: - id: aws.iam.custom_policies - methods: - custom_policies_Simulate: - operation: - $ref: '#/paths/~1?Action=SimulateCustomPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: custom_policies - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: custom_policies - default_policy_versions: - id: aws.iam.default_policy_versions - methods: - default_policy_versions_Set: - operation: - $ref: '#/paths/~1?Action=SetDefaultPolicyVersion&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: default_policy_versions - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: default_policy_versions - entities_for_policies: - id: aws.iam.entities_for_policies - methods: - entities_for_policies_List: - operation: - $ref: '#/paths/~1?Action=ListEntitiesForPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListEntitiesForPolicyResult/PolicyGroups/member - openAPIDocKey: '200' - name: entities_for_policies - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/entities_for_policies/methods/entities_for_policies_List' - update: [] - title: entities_for_policies - group_policies: - id: aws.iam.group_policies - methods: - group_policies_Attach: - operation: - $ref: '#/paths/~1?Action=AttachGroupPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - group_policies_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteGroupPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - group_policies_Detach: - operation: - $ref: '#/paths/~1?Action=DetachGroupPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - group_policies_Get: - operation: - $ref: '#/paths/~1?Action=GetGroupPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetGroupPolicyResult - openAPIDocKey: '200' - group_policies_List: - operation: - $ref: '#/paths/~1?Action=ListGroupPolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListGroupPoliciesResult/PolicyNames/member - openAPIDocKey: '200' - group_policies_Put: - operation: - $ref: '#/paths/~1?Action=PutGroupPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: group_policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/group_policies/methods/group_policies_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/group_policies/methods/group_policies_Get' - - $ref: '#/components/x-stackQL-resources/group_policies/methods/group_policies_List' - update: [] - title: group_policies - groups: - id: aws.iam.groups - methods: - groups_Create: - operation: - $ref: '#/paths/~1?Action=CreateGroup&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - groups_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteGroup&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - groups_Get: - operation: - $ref: '#/paths/~1?Action=GetGroup&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetGroupResult/Group - openAPIDocKey: '200' - groups_List: - operation: - $ref: '#/paths/~1?Action=ListGroups&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListGroupsResult/Groups/member - openAPIDocKey: '200' - groups_Update: - operation: - $ref: '#/paths/~1?Action=UpdateGroup&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: groups - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/groups/methods/groups_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/groups/methods/groups_Create' - select: - - $ref: '#/components/x-stackQL-resources/groups/methods/groups_Get' - - $ref: '#/components/x-stackQL-resources/groups/methods/groups_List' - update: [] - title: groups - groups_for_users: - id: aws.iam.groups_for_users - methods: - groups_for_users_List: - operation: - $ref: '#/paths/~1?Action=ListGroupsForUser&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListGroupsForUserResult/Groups/member - openAPIDocKey: '200' - name: groups_for_users - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/groups_for_users/methods/groups_for_users_List' - update: [] - title: groups_for_users - instance_profile_tags: - id: aws.iam.instance_profile_tags - methods: - instance_profile_tags_List: - operation: - $ref: '#/paths/~1?Action=ListInstanceProfileTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListInstanceProfileTagsResult/Tags/member - openAPIDocKey: '200' - name: instance_profile_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_profile_tags/methods/instance_profile_tags_List' - update: [] - title: instance_profile_tags - instance_profiles: - id: aws.iam.instance_profiles - methods: - instance_profiles_Create: - operation: - $ref: '#/paths/~1?Action=CreateInstanceProfile&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_profiles_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteInstanceProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - instance_profiles_Get: - operation: - $ref: '#/paths/~1?Action=GetInstanceProfile&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetInstanceProfileResult - openAPIDocKey: '200' - instance_profiles_List: - operation: - $ref: '#/paths/~1?Action=ListInstanceProfiles&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListInstanceProfilesResult/InstanceProfiles/member - openAPIDocKey: '200' - instance_profiles_Tag: - operation: - $ref: '#/paths/~1?Action=TagInstanceProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - instance_profiles_Untag: - operation: - $ref: '#/paths/~1?Action=UntagInstanceProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: instance_profiles - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/instance_profiles_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/instance_profiles_Create' - select: - - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/instance_profiles_Get' - - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/instance_profiles_List' - update: [] - title: instance_profiles - instance_profiles_for_roles: - id: aws.iam.instance_profiles_for_roles - methods: - instance_profiles_for_roles_List: - operation: - $ref: '#/paths/~1?Action=ListInstanceProfilesForRole&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListInstanceProfilesForRoleResult/InstanceProfiles/member - openAPIDocKey: '200' - name: instance_profiles_for_roles - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_profiles_for_roles/methods/instance_profiles_for_roles_List' - update: [] - title: instance_profiles_for_roles - login_profiles: - id: aws.iam.login_profiles - methods: - login_profiles_Create: - operation: - $ref: '#/paths/~1?Action=CreateLoginProfile&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - login_profiles_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteLoginProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - login_profiles_Get: - operation: - $ref: '#/paths/~1?Action=GetLoginProfile&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetLoginProfileResult - openAPIDocKey: '200' - login_profiles_Update: - operation: - $ref: '#/paths/~1?Action=UpdateLoginProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: login_profiles - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/login_profiles/methods/login_profiles_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/login_profiles/methods/login_profiles_Create' - select: - - $ref: '#/components/x-stackQL-resources/login_profiles/methods/login_profiles_Get' - update: [] - title: login_profiles - mfa_device_tags: - id: aws.iam.mfa_device_tags - methods: - mfa_device_tags_List: - operation: - $ref: '#/paths/~1?Action=ListMFADeviceTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListMFADeviceTagsResult/Tags/member - openAPIDocKey: '200' - name: mfa_device_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/mfa_device_tags/methods/mfa_device_tags_List' - update: [] - title: mfa_device_tags - mfa_devices: - id: aws.iam.mfa_devices - methods: - mfa_devices_Deactivate: - operation: - $ref: '#/paths/~1?Action=DeactivateMFADevice&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - mfa_devices_Enable: - operation: - $ref: '#/paths/~1?Action=EnableMFADevice&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - mfa_devices_List: - operation: - $ref: '#/paths/~1?Action=ListMFADevices&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListMFADevicesResult/MFADevices/member - openAPIDocKey: '200' - mfa_devices_Resync: - operation: - $ref: '#/paths/~1?Action=ResyncMFADevice&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - mfa_devices_Tag: - operation: - $ref: '#/paths/~1?Action=TagMFADevice&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - mfa_devices_Untag: - operation: - $ref: '#/paths/~1?Action=UntagMFADevice&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: mfa_devices - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/mfa_devices/methods/mfa_devices_List' - update: [] - title: mfa_devices - open_id_connect_provider_tags: - id: aws.iam.open_id_connect_provider_tags - methods: - open_id_connect_provider_tags_List: - operation: - $ref: '#/paths/~1?Action=ListOpenIDConnectProviderTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListOpenIDConnectProviderTagsResult/Tags/member - openAPIDocKey: '200' - name: open_id_connect_provider_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/open_id_connect_provider_tags/methods/open_id_connect_provider_tags_List' - update: [] - title: open_id_connect_provider_tags - open_id_connect_provider_thumbprints: - id: aws.iam.open_id_connect_provider_thumbprints - methods: - open_id_connect_provider_thumbprints_Update: - operation: - $ref: '#/paths/~1?Action=UpdateOpenIDConnectProviderThumbprint&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: open_id_connect_provider_thumbprints - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: open_id_connect_provider_thumbprints - open_id_connect_providers: - id: aws.iam.open_id_connect_providers - methods: - open_id_connect_providers_Create: - operation: - $ref: '#/paths/~1?Action=CreateOpenIDConnectProvider&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - open_id_connect_providers_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteOpenIDConnectProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - open_id_connect_providers_Get: - operation: - $ref: '#/paths/~1?Action=GetOpenIDConnectProvider&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetOpenIDConnectProviderResult - openAPIDocKey: '200' - open_id_connect_providers_List: - operation: - $ref: '#/paths/~1?Action=ListOpenIDConnectProviders&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListOpenIDConnectProvidersResult/OpenIDConnectProviderList/member - openAPIDocKey: '200' - open_id_connect_providers_Tag: - operation: - $ref: '#/paths/~1?Action=TagOpenIDConnectProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - open_id_connect_providers_Untag: - operation: - $ref: '#/paths/~1?Action=UntagOpenIDConnectProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: open_id_connect_providers - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/open_id_connect_providers/methods/open_id_connect_providers_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/open_id_connect_providers/methods/open_id_connect_providers_Create' - select: - - $ref: '#/components/x-stackQL-resources/open_id_connect_providers/methods/open_id_connect_providers_Get' - - $ref: '#/components/x-stackQL-resources/open_id_connect_providers/methods/open_id_connect_providers_List' - update: [] - title: open_id_connect_providers - organizations_access_reports: - id: aws.iam.organizations_access_reports - methods: - organizations_access_reports_Generate: - operation: - $ref: '#/paths/~1?Action=GenerateOrganizationsAccessReport&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - organizations_access_reports_Get: - operation: - $ref: '#/paths/~1?Action=GetOrganizationsAccessReport&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetOrganizationsAccessReportResult - openAPIDocKey: '200' - name: organizations_access_reports - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/organizations_access_reports/methods/organizations_access_reports_Get' - update: [] - title: organizations_access_reports - passwords: - id: aws.iam.passwords - methods: - passwords_Change: - operation: - $ref: '#/paths/~1?Action=ChangePassword&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: passwords - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: passwords - policies: - id: aws.iam.policies - methods: - policies_Create: - operation: - $ref: '#/paths/~1?Action=CreatePolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - policies_Delete: - operation: - $ref: '#/paths/~1?Action=DeletePolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - policies_Get: - operation: - $ref: '#/paths/~1?Action=GetPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetPolicyResult - openAPIDocKey: '200' - policies_List: - operation: - $ref: '#/paths/~1?Action=ListPolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListPoliciesResult/Policies/member - openAPIDocKey: '200' - policies_Tag: - operation: - $ref: '#/paths/~1?Action=TagPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - policies_Untag: - operation: - $ref: '#/paths/~1?Action=UntagPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_Create' - select: - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_Get' - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_List' - update: [] - title: policies - policy_tags: - id: aws.iam.policy_tags - methods: - policy_tags_List: - operation: - $ref: '#/paths/~1?Action=ListPolicyTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListPolicyTagsResult/Tags/member - openAPIDocKey: '200' - name: policy_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/policy_tags/methods/policy_tags_List' - update: [] - title: policy_tags - policy_versions: - id: aws.iam.policy_versions - methods: - policy_versions_Create: - operation: - $ref: '#/paths/~1?Action=CreatePolicyVersion&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - policy_versions_Delete: - operation: - $ref: '#/paths/~1?Action=DeletePolicyVersion&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - policy_versions_Get: - operation: - $ref: '#/paths/~1?Action=GetPolicyVersion&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetPolicyVersionResult - openAPIDocKey: '200' - policy_versions_List: - operation: - $ref: '#/paths/~1?Action=ListPolicyVersions&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListPolicyVersionsResult/Versions/member - openAPIDocKey: '200' - name: policy_versions - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/policy_versions/methods/policy_versions_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/policy_versions/methods/policy_versions_Create' - select: - - $ref: '#/components/x-stackQL-resources/policy_versions/methods/policy_versions_Get' - - $ref: '#/components/x-stackQL-resources/policy_versions/methods/policy_versions_List' - update: [] - title: policy_versions - principal_policies: - id: aws.iam.principal_policies - methods: - principal_policies_Simulate: - operation: - $ref: '#/paths/~1?Action=SimulatePrincipalPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: principal_policies - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: principal_policies - role_descriptions: - id: aws.iam.role_descriptions - methods: - role_descriptions_Update: - operation: - $ref: '#/paths/~1?Action=UpdateRoleDescription&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: role_descriptions - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: role_descriptions - role_from_instance_profiles: - id: aws.iam.role_from_instance_profiles - methods: - role_from_instance_profiles_Remove: - operation: - $ref: '#/paths/~1?Action=RemoveRoleFromInstanceProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: role_from_instance_profiles - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: role_from_instance_profiles - role_permissions_boundaries: - id: aws.iam.role_permissions_boundaries - methods: - role_permissions_boundaries_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteRolePermissionsBoundary&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - role_permissions_boundaries_Put: - operation: - $ref: '#/paths/~1?Action=PutRolePermissionsBoundary&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: role_permissions_boundaries - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/role_permissions_boundaries/methods/role_permissions_boundaries_Delete' - insert: [] - select: [] - update: [] - title: role_permissions_boundaries - role_policies: - id: aws.iam.role_policies - methods: - role_policies_Attach: - operation: - $ref: '#/paths/~1?Action=AttachRolePolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - role_policies_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteRolePolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - role_policies_Detach: - operation: - $ref: '#/paths/~1?Action=DetachRolePolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - role_policies_Get: - operation: - $ref: '#/paths/~1?Action=GetRolePolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetRolePolicyResult - openAPIDocKey: '200' - role_policies_List: - operation: - $ref: '#/paths/~1?Action=ListRolePolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListRolePoliciesResult/PolicyNames/member - openAPIDocKey: '200' - role_policies_Put: - operation: - $ref: '#/paths/~1?Action=PutRolePolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: role_policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/role_policies/methods/role_policies_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/role_policies/methods/role_policies_Get' - - $ref: '#/components/x-stackQL-resources/role_policies/methods/role_policies_List' - update: [] - title: role_policies - role_tags: - id: aws.iam.role_tags - methods: - role_tags_List: - operation: - $ref: '#/paths/~1?Action=ListRoleTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListRoleTagsResult/Tags/member - openAPIDocKey: '200' - name: role_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/role_tags/methods/role_tags_List' - update: [] - title: role_tags - role_to_instance_profiles: - id: aws.iam.role_to_instance_profiles - methods: - role_to_instance_profiles_Add: - operation: - $ref: '#/paths/~1?Action=AddRoleToInstanceProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: role_to_instance_profiles - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: role_to_instance_profiles - roles: - id: aws.iam.roles - methods: - roles_Create: - operation: - $ref: '#/paths/~1?Action=CreateRole&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - roles_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteRole&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - roles_Get: - operation: - $ref: '#/paths/~1?Action=GetRole&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetRoleResult/Role - openAPIDocKey: '200' - roles_List: - operation: - $ref: '#/paths/~1?Action=ListRoles&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListRolesResult/Roles/member - openAPIDocKey: '200' - roles_Tag: - operation: - $ref: '#/paths/~1?Action=TagRole&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - roles_Untag: - operation: - $ref: '#/paths/~1?Action=UntagRole&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - roles_Update: - operation: - $ref: '#/paths/~1?Action=UpdateRole&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: roles - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/roles/methods/roles_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/roles/methods/roles_Create' - select: - - $ref: '#/components/x-stackQL-resources/roles/methods/roles_Get' - - $ref: '#/components/x-stackQL-resources/roles/methods/roles_List' - update: [] - title: roles - saml_provider_tags: - id: aws.iam.saml_provider_tags - methods: - saml_provider_tags_List: - operation: - $ref: '#/paths/~1?Action=ListSAMLProviderTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListSAMLProviderTagsResult/Tags/member - openAPIDocKey: '200' - name: saml_provider_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/saml_provider_tags/methods/saml_provider_tags_List' - update: [] - title: saml_provider_tags - saml_providers: - id: aws.iam.saml_providers - methods: - saml_providers_Create: - operation: - $ref: '#/paths/~1?Action=CreateSAMLProvider&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - saml_providers_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSAMLProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - saml_providers_Get: - operation: - $ref: '#/paths/~1?Action=GetSAMLProvider&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetSAMLProviderResult - openAPIDocKey: '200' - saml_providers_List: - operation: - $ref: '#/paths/~1?Action=ListSAMLProviders&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListSAMLProvidersResult/SAMLProviderList/member - openAPIDocKey: '200' - saml_providers_Tag: - operation: - $ref: '#/paths/~1?Action=TagSAMLProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - saml_providers_Untag: - operation: - $ref: '#/paths/~1?Action=UntagSAMLProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - saml_providers_Update: - operation: - $ref: '#/paths/~1?Action=UpdateSAMLProvider&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: saml_providers - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/saml_providers/methods/saml_providers_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/saml_providers/methods/saml_providers_Create' - select: - - $ref: '#/components/x-stackQL-resources/saml_providers/methods/saml_providers_Get' - - $ref: '#/components/x-stackQL-resources/saml_providers/methods/saml_providers_List' - update: [] - title: saml_providers - security_token_service_preferences: - id: aws.iam.security_token_service_preferences - methods: - security_token_service_preferences_Set: - operation: - $ref: '#/paths/~1?Action=SetSecurityTokenServicePreferences&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: security_token_service_preferences - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: security_token_service_preferences - server_certificate_tags: - id: aws.iam.server_certificate_tags - methods: - server_certificate_tags_List: - operation: - $ref: '#/paths/~1?Action=ListServerCertificateTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListServerCertificateTagsResult/Tags/member - openAPIDocKey: '200' - name: server_certificate_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/server_certificate_tags/methods/server_certificate_tags_List' - update: [] - title: server_certificate_tags - server_certificates: - id: aws.iam.server_certificates - methods: - server_certificates_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteServerCertificate&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - server_certificates_Get: - operation: - $ref: '#/paths/~1?Action=GetServerCertificate&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetServerCertificateResult - openAPIDocKey: '200' - server_certificates_List: - operation: - $ref: '#/paths/~1?Action=ListServerCertificates&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListServerCertificatesResult/ServerCertificateMetadataList/member - openAPIDocKey: '200' - server_certificates_Tag: - operation: - $ref: '#/paths/~1?Action=TagServerCertificate&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - server_certificates_Untag: - operation: - $ref: '#/paths/~1?Action=UntagServerCertificate&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - server_certificates_Update: - operation: - $ref: '#/paths/~1?Action=UpdateServerCertificate&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - server_certificates_Upload: - operation: - $ref: '#/paths/~1?Action=UploadServerCertificate&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: server_certificates - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/server_certificates/methods/server_certificates_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/server_certificates/methods/server_certificates_Get' - - $ref: '#/components/x-stackQL-resources/server_certificates/methods/server_certificates_List' - update: [] - title: server_certificates - service_last_accessed_details: - id: aws.iam.service_last_accessed_details - methods: - service_last_accessed_details_Generate: - operation: - $ref: '#/paths/~1?Action=GenerateServiceLastAccessedDetails&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - service_last_accessed_details_Get: - operation: - $ref: '#/paths/~1?Action=GetServiceLastAccessedDetails&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetServiceLastAccessedDetailsResult - openAPIDocKey: '200' - name: service_last_accessed_details - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/service_last_accessed_details/methods/service_last_accessed_details_Get' - update: [] - title: service_last_accessed_details - service_last_accessed_details_with_entities: - id: aws.iam.service_last_accessed_details_with_entities - methods: - service_last_accessed_details_with_entities_Get: - operation: - $ref: '#/paths/~1?Action=GetServiceLastAccessedDetailsWithEntities&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetServiceLastAccessedDetailsWithEntitiesResult - openAPIDocKey: '200' - name: service_last_accessed_details_with_entities - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/service_last_accessed_details_with_entities/methods/service_last_accessed_details_with_entities_Get' - update: [] - title: service_last_accessed_details_with_entities - service_linked_role_deletion_status: - id: aws.iam.service_linked_role_deletion_status - methods: - service_linked_role_deletion_status_Get: - operation: - $ref: '#/paths/~1?Action=GetServiceLinkedRoleDeletionStatus&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetServiceLinkedRoleDeletionStatusResult - openAPIDocKey: '200' - name: service_linked_role_deletion_status - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/service_linked_role_deletion_status/methods/service_linked_role_deletion_status_Get' - update: [] - title: service_linked_role_deletion_status - service_linked_roles: - id: aws.iam.service_linked_roles - methods: - service_linked_roles_Create: - operation: - $ref: '#/paths/~1?Action=CreateServiceLinkedRole&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - service_linked_roles_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteServiceLinkedRole&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: service_linked_roles - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/service_linked_roles/methods/service_linked_roles_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/service_linked_roles/methods/service_linked_roles_Create' - select: [] - update: [] - title: service_linked_roles - service_specific_credentials: - id: aws.iam.service_specific_credentials - methods: - service_specific_credentials_Create: - operation: - $ref: '#/paths/~1?Action=CreateServiceSpecificCredential&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - service_specific_credentials_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteServiceSpecificCredential&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - service_specific_credentials_List: - operation: - $ref: '#/paths/~1?Action=ListServiceSpecificCredentials&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListServiceSpecificCredentialsResult/ServiceSpecificCredentials/member - openAPIDocKey: '200' - service_specific_credentials_Reset: - operation: - $ref: '#/paths/~1?Action=ResetServiceSpecificCredential&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - service_specific_credentials_Update: - operation: - $ref: '#/paths/~1?Action=UpdateServiceSpecificCredential&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: service_specific_credentials - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/service_specific_credentials/methods/service_specific_credentials_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/service_specific_credentials/methods/service_specific_credentials_Create' - select: - - $ref: '#/components/x-stackQL-resources/service_specific_credentials/methods/service_specific_credentials_List' - update: [] - title: service_specific_credentials - signing_certificates: - id: aws.iam.signing_certificates - methods: - signing_certificates_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSigningCertificate&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - signing_certificates_List: - operation: - $ref: '#/paths/~1?Action=ListSigningCertificates&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListSigningCertificatesResult/Certificates/member - openAPIDocKey: '200' - signing_certificates_Update: - operation: - $ref: '#/paths/~1?Action=UpdateSigningCertificate&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - signing_certificates_Upload: - operation: - $ref: '#/paths/~1?Action=UploadSigningCertificate&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: signing_certificates - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/signing_certificates/methods/signing_certificates_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/signing_certificates/methods/signing_certificates_List' - update: [] - title: signing_certificates - ssh_public_keys: - id: aws.iam.ssh_public_keys - methods: - ssh_public_keys_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSSHPublicKey&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - ssh_public_keys_Get: - operation: - $ref: '#/paths/~1?Action=GetSSHPublicKey&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetSSHPublicKeyResult - openAPIDocKey: '200' - ssh_public_keys_List: - operation: - $ref: '#/paths/~1?Action=ListSSHPublicKeys&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListSSHPublicKeysResult/SSHPublicKeys/member - openAPIDocKey: '200' - ssh_public_keys_Update: - operation: - $ref: '#/paths/~1?Action=UpdateSSHPublicKey&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - ssh_public_keys_Upload: - operation: - $ref: '#/paths/~1?Action=UploadSSHPublicKey&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: ssh_public_keys - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/ssh_public_keys_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/ssh_public_keys_Get' - - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/ssh_public_keys_List' - update: [] - title: ssh_public_keys - user_from_groups: - id: aws.iam.user_from_groups - methods: - user_from_groups_Remove: - operation: - $ref: '#/paths/~1?Action=RemoveUserFromGroup&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: user_from_groups - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: user_from_groups - user_permissions_boundaries: - id: aws.iam.user_permissions_boundaries - methods: - user_permissions_boundaries_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteUserPermissionsBoundary&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - user_permissions_boundaries_Put: - operation: - $ref: '#/paths/~1?Action=PutUserPermissionsBoundary&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: user_permissions_boundaries - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/user_permissions_boundaries/methods/user_permissions_boundaries_Delete' - insert: [] - select: [] - update: [] - title: user_permissions_boundaries - user_policies: - id: aws.iam.user_policies - methods: - user_policies_Attach: - operation: - $ref: '#/paths/~1?Action=AttachUserPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - user_policies_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteUserPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - user_policies_Detach: - operation: - $ref: '#/paths/~1?Action=DetachUserPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - user_policies_Get: - operation: - $ref: '#/paths/~1?Action=GetUserPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetUserPolicyResult - openAPIDocKey: '200' - user_policies_List: - operation: - $ref: '#/paths/~1?Action=ListUserPolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListUserPoliciesResult/PolicyNames/member - openAPIDocKey: '200' - user_policies_Put: - operation: - $ref: '#/paths/~1?Action=PutUserPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: user_policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/user_policies/methods/user_policies_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/user_policies/methods/user_policies_Get' - - $ref: '#/components/x-stackQL-resources/user_policies/methods/user_policies_List' - update: [] - title: user_policies - user_tags: - id: aws.iam.user_tags - methods: - user_tags_List: - operation: - $ref: '#/paths/~1?Action=ListUserTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListUserTagsResult/Tags/member - openAPIDocKey: '200' - name: user_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/user_tags/methods/user_tags_List' - update: [] - title: user_tags - user_to_groups: - id: aws.iam.user_to_groups - methods: - user_to_groups_Add: - operation: - $ref: '#/paths/~1?Action=AddUserToGroup&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: user_to_groups - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: user_to_groups - users: - id: aws.iam.users - methods: - users_Create: - operation: - $ref: '#/paths/~1?Action=CreateUser&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - users_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteUser&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - users_Get: - operation: - $ref: '#/paths/~1?Action=GetUser&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetUserResult/User - openAPIDocKey: '200' - users_List: - operation: - $ref: '#/paths/~1?Action=ListUsers&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListUsersResult/Users/member - openAPIDocKey: '200' - users_Tag: - operation: - $ref: '#/paths/~1?Action=TagUser&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - users_Untag: - operation: - $ref: '#/paths/~1?Action=UntagUser&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - users_Update: - operation: - $ref: '#/paths/~1?Action=UpdateUser&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: users - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/users/methods/users_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/users/methods/users_Create' - select: - - $ref: '#/components/x-stackQL-resources/users/methods/users_List' - update: [] - title: users - virtual_mfa_devices: - id: aws.iam.virtual_mfa_devices - methods: - virtual_mfa_devices_Create: - operation: - $ref: '#/paths/~1?Action=CreateVirtualMFADevice&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - virtual_mfa_devices_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVirtualMFADevice&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - virtual_mfa_devices_List: - operation: - $ref: '#/paths/~1?Action=ListVirtualMFADevices&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListVirtualMFADevicesResult/VirtualMFADevices/member - openAPIDocKey: '200' - name: virtual_mfa_devices - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/virtual_mfa_devices/methods/virtual_mfa_devices_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/virtual_mfa_devices/methods/virtual_mfa_devices_Create' - select: - - $ref: '#/components/x-stackQL-resources/virtual_mfa_devices/methods/virtual_mfa_devices_List' - update: [] - title: virtual_mfa_devices -externalDocs: - description: Amazon Web Services documentation - url: https://docs.aws.amazon.com/iam/ -info: - contact: - email: mike.ralphson@gmail.com - name: Mike Ralphson - url: https://github.com/mermade/aws2openapi - x-twitter: PermittedSoc - description:Identity and - Access Management (IAM) is a web service for securely controlling access to Amazon - Web Services services. With IAM, you can centrally manage users, security credentials - such as access keys, and permissions that control which Amazon Web Services resources - users and applications can access. For more information about IAM, see Identity - and Access Management (IAM) and the Identity - and Access Management User Guide.
- license: - name: Apache 2.0 License - url: http://www.apache.org/licenses/ - termsOfService: https://aws.amazon.com/service-terms/ - title: AWS Identity and Access Management - version: '2010-05-08' - x-apiClientRegistration: - url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct - x-apisguru-categories: - - cloud - x-logo: - backgroundColor: '#FFFFFF' - url: https://twitter.com/awscloud/profile_image?size=original - x-origin: - - contentType: application/json - converter: - url: https://github.com/mermade/aws2openapi - version: 1.0.0 - url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iam-2010-05-08.normal.json - x-apisguru-driver: external - x-preferred: true - x-providerName: amazonaws.com - x-release: v4 - x-serviceName: iam -openapi: 3.0.0 -paths: - /?Action=AddClientIDToOpenIDConnectProvider&Version=2010-05-08: - get: - description:Adds a new client ID (also known as audience) to the list of - client IDs already registered for the specified IAM OpenID Connect (OIDC) - provider resource.
This operation is idempotent; it does not fail or - return an error if you add an existing client ID to the provider.
- operationId: GET_AddClientIDToOpenIDConnectProvider - parameters: - - description: The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) - provider resource to add the client ID to. You can get a list of OIDC provider - ARNs by using the ListOpenIDConnectProviders operation. - in: query - name: OpenIDConnectProviderArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description: The client ID (also known as audience) to add to the IAM OpenID - Connect provider resource. - in: query - name: ClientID - required: true - schema: - maxLength: 255 - minLength: 1 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AddClientIDToOpenIDConnectProvider - 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' - post: - description:Adds a new client ID (also known as audience) to the list of - client IDs already registered for the specified IAM OpenID Connect (OIDC) - provider resource.
This operation is idempotent; it does not fail or - return an error if you add an existing client ID to the provider.
- operationId: POST_AddClientIDToOpenIDConnectProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AddClientIDToOpenIDConnectProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AddClientIDToOpenIDConnectProvider - /?Action=AddRoleToInstanceProfile&Version=2010-05-08: - get: - description:Adds the specified IAM role to the specified instance profile. - An instance profile can contain only one role, and this quota cannot be increased. - You can remove the existing role and then add a different role to an instance - profile. You must then wait for the change to appear across all of Amazon - Web Services because of eventual - consistency. To force the change, you must disassociate - the instance profile and then associate - the instance profile, or you can stop your instance and then restart it.
-The caller of this operation must be granted the PassRole
- permission on the IAM role by a permissions policy.
For more - information about roles, see Working - with roles. For more information about instance profiles, see About - instance profiles.
- operationId: GET_AddRoleToInstanceProfile - parameters: - - description: 'The name of the instance profile to update.
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: _+=,.@-
' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name of the role to add.
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: _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AddRoleToInstanceProfile - 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' - post: - description:Adds the specified IAM role to the specified instance profile. - An instance profile can contain only one role, and this quota cannot be increased. - You can remove the existing role and then add a different role to an instance - profile. You must then wait for the change to appear across all of Amazon - Web Services because of eventual - consistency. To force the change, you must disassociate - the instance profile and then associate - the instance profile, or you can stop your instance and then restart it.
-The caller of this operation must be granted the PassRole
- permission on the IAM role by a permissions policy.
For more - information about roles, see Working - with roles. For more information about instance profiles, see About - instance profiles.
- operationId: POST_AddRoleToInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AddRoleToInstanceProfileRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AddRoleToInstanceProfile - /?Action=AddUserToGroup&Version=2010-05-08: - get: - description: Adds the specified user to the specified group. - operationId: GET_AddUserToGroup - parameters: - - description: 'The name of the group to update.
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: _+=,.@-
' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name of the user to add.
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: _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AddUserToGroup - 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' - post: - description: Adds the specified user to the specified group. - operationId: POST_AddUserToGroup - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AddUserToGroupRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AddUserToGroup - /?Action=AttachGroupPolicy&Version=2010-05-08: - get: - description:Attaches the specified managed policy to the specified IAM group.
-You use this operation to attach a managed policy to a group. To embed - an inline policy in a group, use PutGroupPolicy.
As a best practice, - you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.
For more information - about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_AttachGroupPolicy - parameters: - - description: 'The name (friendly name, not ARN) of the group to attach - the policy to.
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: - _+=,.@-
' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to attach.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AttachGroupPolicy - 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' - post: - description:Attaches the specified managed policy to the specified IAM group.
-You use this operation to attach a managed policy to a group. To embed - an inline policy in a group, use PutGroupPolicy.
As a best practice, - you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.
For more information - about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_AttachGroupPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachGroupPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AttachGroupPolicy - /?Action=AttachRolePolicy&Version=2010-05-08: - get: - description:Attaches the specified managed policy to the specified IAM role. - When you attach a managed policy to a role, the managed policy becomes part - of the role's permission (access) policy.
You cannot use a managed - policy as the role's trust policy. The role's trust policy is created at the - same time as the role, using CreateRole. You can update a role's trust - policy using UpdateAssumeRolePolicy.
Use this operation - to attach a managed policy to a role. To embed an inline policy in - a role, use PutRolePolicy. For more information about policies, see - Managed - policies and inline policies in the IAM User Guide.
As a - best practice, you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.
- operationId: GET_AttachRolePolicy - parameters: - - description: 'The name (friendly name, not ARN) of the role to attach the - policy to.
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: - _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to attach.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AttachRolePolicy - 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' - post: - description:Attaches the specified managed policy to the specified IAM role. - When you attach a managed policy to a role, the managed policy becomes part - of the role's permission (access) policy.
You cannot use a managed - policy as the role's trust policy. The role's trust policy is created at the - same time as the role, using CreateRole. You can update a role's trust - policy using UpdateAssumeRolePolicy.
Use this operation - to attach a managed policy to a role. To embed an inline policy in - a role, use PutRolePolicy. For more information about policies, see - Managed - policies and inline policies in the IAM User Guide.
As a - best practice, you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.
- operationId: POST_AttachRolePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachRolePolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AttachRolePolicy - /?Action=AttachUserPolicy&Version=2010-05-08: - get: - description:Attaches the specified managed policy to the specified user.
-You use this operation to attach a managed policy to a user. To - embed an inline policy in a user, use PutUserPolicy.
As a best - practice, you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.
For more information - about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_AttachUserPolicy - parameters: - - description: 'The name (friendly name, not ARN) of the IAM user to attach - the policy to.
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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to attach.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AttachUserPolicy - 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' - post: - description:Attaches the specified managed policy to the specified user.
-You use this operation to attach a managed policy to a user. To - embed an inline policy in a user, use PutUserPolicy.
As a best - practice, you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.
For more information - about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_AttachUserPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachUserPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AttachUserPolicy - /?Action=ChangePassword&Version=2010-05-08: - get: - description:Changes the password of the IAM user who is calling this operation. - This operation can be performed using the CLI, the Amazon Web Services API, - or the My Security Credentials page in the Amazon Web Services Management - Console. The Amazon Web Services account root user password is not affected - by this operation.
Use UpdateLoginProfile to use the CLI, the - Amazon Web Services API, or the Users page in the IAM console to change - the password for any IAM user. For more information about modifying passwords, - see Managing - passwords in the IAM User Guide.
- operationId: GET_ChangePassword - parameters: - - description: The IAM user's current password. - in: query - name: OldPassword - required: true - schema: - format: password - maxLength: 128 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description:The new password. The new password must conform to the Amazon - Web Services account's password policy, if one exists.
The regex
- pattern that is used to validate this parameter is a string of characters.
- That string can include almost any printable ASCII character from the space
- (\u0020) through the end of the ASCII character range (\u00FF).
- You can also include the tab (\u0009), line feed (\u000A),
- and carriage return (\u000D) characters. Any of these characters
- are valid in a password. However, many tools, such as the Amazon Web Services
- Management Console, might restrict the ability to type certain characters
- because they have special meaning within that tool.
Changes the password of the IAM user who is calling this operation. - This operation can be performed using the CLI, the Amazon Web Services API, - or the My Security Credentials page in the Amazon Web Services Management - Console. The Amazon Web Services account root user password is not affected - by this operation.
Use UpdateLoginProfile to use the CLI, the - Amazon Web Services API, or the Users page in the IAM console to change - the password for any IAM user. For more information about modifying passwords, - see Managing - passwords in the IAM User Guide.
- operationId: POST_ChangePassword - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ChangePasswordRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidUserTypeException' - description: InvalidUserTypeException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/PasswordPolicyViolationException' - description: PasswordPolicyViolationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ChangePassword - /?Action=CreateAccessKey&Version=2010-05-08: - get: - description: Creates a new Amazon Web Services secret access key and corresponding
- Amazon Web Services access key ID for the specified user. The default status
- for new keys is Active.
If you do not specify a user name, - IAM determines the user name implicitly based on the Amazon Web Services access - key ID signing the request. This operation works for access keys under the - Amazon Web Services account. Consequently, you can use this operation to manage - Amazon Web Services account root user credentials. This is true even if the - Amazon Web Services account has no associated users.
For information - about quotas on the number of keys you can create, see IAM - and STS quotas in the IAM User Guide.
To ensure - the security of your Amazon Web Services account, the secret access key is - accessible only during key and user creation. You must save the key (for example, - in a text file) if you want to be able to access it again. If a secret key - is lost, you can delete the access keys for the associated user and then create - new keys.
The name of the IAM user that the new key will belong to.
-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: - _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - CreateAccessKeyResult: - $ref: '#/components/schemas/CreateAccessKeyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateAccessKey - 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' - post: - description: Creates a new Amazon Web Services secret access key and corresponding
- Amazon Web Services access key ID for the specified user. The default status
- for new keys is Active.
If you do not specify a user name, - IAM determines the user name implicitly based on the Amazon Web Services access - key ID signing the request. This operation works for access keys under the - Amazon Web Services account. Consequently, you can use this operation to manage - Amazon Web Services account root user credentials. This is true even if the - Amazon Web Services account has no associated users.
For information - about quotas on the number of keys you can create, see IAM - and STS quotas in the IAM User Guide.
To ensure - the security of your Amazon Web Services account, the secret access key is - accessible only during key and user creation. You must save the key (for example, - in a text file) if you want to be able to access it again. If a secret key - is lost, you can delete the access keys for the associated user and then create - new keys.
The account alias to create.
This parameter allows - (through its regex pattern) - a string of characters consisting of lowercase letters, digits, and dashes. - You cannot start or finish with a dash, nor can you have two dashes in a - row.
- in: query - name: AccountAlias - required: true - schema: - maxLength: 63 - minLength: 3 - pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$ - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateAccountAlias - 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' - post: - description: Creates an alias for your Amazon Web Services account. For information - about using an Amazon Web Services account alias, see Using - an alias for your Amazon Web Services account ID in the IAM User Guide. - operationId: POST_CreateAccountAlias - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateAccountAliasRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateAccountAlias - /?Action=CreateGroup&Version=2010-05-08: - get: - 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.
- operationId: GET_CreateGroup - parameters: - - 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".
- in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - CreateGroupResult: - $ref: '#/components/schemas/CreateGroupResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: 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' - post: - 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.
- operationId: POST_CreateGroup - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateGroupRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateGroupResult: - $ref: '#/components/schemas/CreateGroupResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateGroup - /?Action=CreateInstanceProfile&Version=2010-05-08: - get: - 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.
- operationId: GET_CreateInstanceProfile - parameters: - - 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: _+=,.@-
' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - 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.
- operationId: POST_CreateInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceProfileRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateInstanceProfileResult: - $ref: '#/components/schemas/CreateInstanceProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateInstanceProfile - /?Action=CreateLoginProfile&Version=2010-05-08: - get: - description:Creates a password for the specified IAM user. A password allows - an IAM user to access Amazon Web Services services through the Amazon Web - Services Management Console.
You can use the CLI, the Amazon Web Services - API, or the Users page in the IAM console to create a password for - any IAM user. Use ChangePassword to update your own existing password - in the My Security Credentials page in the Amazon Web Services Management - Console.
For more information about managing passwords, see Managing - passwords in the IAM User Guide.
- operationId: GET_CreateLoginProfile - parameters: - - description: 'The name of the IAM user to create a password for. The user - must already exist.
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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The new password for the user.
The regex
- pattern that is used to validate this parameter is a string of characters.
- That string can include almost any printable ASCII character from the space
- (\u0020) through the end of the ASCII character range (\u00FF).
- You can also include the tab (\u0009), line feed (\u000A),
- and carriage return (\u000D) characters. Any of these characters
- are valid in a password. However, many tools, such as the Amazon Web Services
- Management Console, might restrict the ability to type certain characters
- because they have special meaning within that tool.
Creates a password for the specified IAM user. A password allows - an IAM user to access Amazon Web Services services through the Amazon Web - Services Management Console.
You can use the CLI, the Amazon Web Services - API, or the Users page in the IAM console to create a password for - any IAM user. Use ChangePassword to update your own existing password - in the My Security Credentials page in the Amazon Web Services Management - Console.
For more information about managing passwords, see Managing - passwords in the IAM User Guide.
- operationId: POST_CreateLoginProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLoginProfileRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateLoginProfileResult: - $ref: '#/components/schemas/CreateLoginProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PasswordPolicyViolationException' - description: PasswordPolicyViolationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateLoginProfile - /?Action=CreateOpenIDConnectProvider&Version=2010-05-08: - get: - description:Creates an IAM entity to describe an identity provider (IdP) - that supports OpenID Connect (OIDC).
-The OIDC provider that you create with this operation can be used as a - principal in a role's trust policy. Such a policy establishes a trust relationship - between Amazon Web Services and the OIDC provider.
If you are using - an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't - need to create a separate IAM identity provider. These OIDC identity providers - are already built-in to Amazon Web Services and are available for your use. - Instead, you can move directly to creating new roles using your identity provider. - To learn more, see Creating - a role for web identity or OpenID connect federation in the IAM User - Guide.
When you create the IAM OIDC provider, you specify the following:
-The URL of the OIDC identity provider (IdP) to trust
A list of client IDs (also known as audiences) that identify the application - or applications allowed to authenticate using the OIDC provider
A list of thumbprints of one or more server certificates that the - IdP uses
You get all of this information from the OIDC - IdP you want to use to access Amazon Web Services.
Amazon Web - Services secures communication with some OIDC identity providers (IdPs) through - our library of trusted certificate authorities (CAs) instead of using a certificate - thumbprint to verify your IdP server certificate. These OIDC IdPs include - Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set - (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, - but is no longer used for validation.
The trust for - the OIDC provider is derived from the IAM provider that this operation creates. - Therefore, it is best to limit access to the CreateOpenIDConnectProvider - operation to highly privileged users.
The URL of the identity provider. The URL must begin with
- https:// and should correspond to the iss claim
- in the provider's OpenID Connect ID tokens. Per the OIDC standard, path
- components are allowed but query parameters are not. Typically the URL consists
- of only a hostname, like https://server.example.org or https://example.com.
- The URL should not contain a port number.
You cannot register the - same provider multiple times in a single Amazon Web Services account. If - you try to submit a URL that has already been used for an OpenID Connect - provider in the Amazon Web Services account, you will get an error.
- in: query - name: Url - required: true - schema: - description: Contains a URL that specifies the endpoint for an OpenID Connect - provider. - maxLength: 255 - minLength: 1 - type: string - - description:Provides a list of client IDs, also known as audiences. When
- a mobile or web app registers with an OpenID Connect provider, they establish
- a value that identifies the application. This is the value that's sent as
- the client_id parameter on OAuth requests.
You can register - multiple client IDs with the same provider. For example, you might have - multiple applications that use the same OIDC provider. You cannot register - more than 100 client IDs with a single IAM OIDC provider.
There is
- no defined format for a client ID. The CreateOpenIDConnectProviderRequest
- operation accepts client IDs up to 255 characters long.
A list of server certificate thumbprints for the OpenID Connect - (OIDC) identity provider's server certificates. Typically this list includes - only one entry. However, IAM lets you have up to five thumbprints for an - OIDC provider. This lets you maintain multiple thumbprints if the identity - provider is rotating certificates.
The server certificate thumbprint - is the hex-encoded SHA-1 hash value of the X.509 certificate used by the - domain where the OpenID Connect provider makes its keys available. It is - always a 40-character string.
You must provide at least one thumbprint
- when creating an IAM OIDC provider. For example, assume that the OIDC provider
- is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect.
- In that case, the thumbprint string would be the hex-encoded SHA-1 hash
- value of the certificate used by https://keys.server.example.com.
-
For more information about obtaining the OIDC provider thumbprint, - see Obtaining - the thumbprint for an OpenID Connect provider in the IAM User Guide.
- in: query - name: ThumbprintList - required: true - schema: - description: Contains a list of thumbprints of identity provider server - certificates. - items: - allOf: - - $ref: '#/components/schemas/thumbprintType' - - xml: - name: member - type: array - - description:A list of tags that you want to attach to the new IAM OpenID - Connect (OIDC) provider. 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 an IAM entity to describe an identity provider (IdP) - that supports OpenID Connect (OIDC).
-The OIDC provider that you create with this operation can be used as a - principal in a role's trust policy. Such a policy establishes a trust relationship - between Amazon Web Services and the OIDC provider.
If you are using - an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't - need to create a separate IAM identity provider. These OIDC identity providers - are already built-in to Amazon Web Services and are available for your use. - Instead, you can move directly to creating new roles using your identity provider. - To learn more, see Creating - a role for web identity or OpenID connect federation in the IAM User - Guide.
When you create the IAM OIDC provider, you specify the following:
-The URL of the OIDC identity provider (IdP) to trust
A list of client IDs (also known as audiences) that identify the application - or applications allowed to authenticate using the OIDC provider
A list of thumbprints of one or more server certificates that the - IdP uses
You get all of this information from the OIDC - IdP you want to use to access Amazon Web Services.
Amazon Web - Services secures communication with some OIDC identity providers (IdPs) through - our library of trusted certificate authorities (CAs) instead of using a certificate - thumbprint to verify your IdP server certificate. These OIDC IdPs include - Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set - (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, - but is no longer used for validation.
The trust for - the OIDC provider is derived from the IAM provider that this operation creates. - Therefore, it is best to limit access to the CreateOpenIDConnectProvider - operation to highly privileged users.
Creates a new managed policy for your Amazon Web Services account.
-This operation creates a policy version with a version identifier of v1
- and sets v1 as the policy's default version. For more information about policy
- versions, see Versioning
- for managed policies in the IAM User Guide.
As a best practice, - you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.
For more information - about managed policies in general, see Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_CreatePolicy - parameters: - - description:The friendly name of the policy.
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".
- in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The path for the policy.
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.
You cannot use an - asterisk (*) in the path name.
The JSON policy document that you want to use as the content - for the new policy.
You must provide policies in JSON format in IAM. - 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 maximum length - of the policy document that you can pass in this operation, including whitespace, - is listed below. To view the maximum character counts of a managed policy - with no whitespaces, see IAM - and STS character quotas.
To learn more about JSON policy grammar, - see Grammar - of the IAM JSON policy language in the IAM User Guide.
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)
A friendly description of the policy.
Typically used - to store information about the permissions defined in the policy. For example, - "Grants access to production DynamoDB tables."
The policy description - is immutable. After a value is assigned, it cannot be changed.
- in: query - name: Description - required: false - schema: - maxLength: 1000 - type: string - - description:A list of tags that you want to attach to the new IAM customer - managed policy. 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 managed policy for your Amazon Web Services account.
-This operation creates a policy version with a version identifier of v1
- and sets v1 as the policy's default version. For more information about policy
- versions, see Versioning
- for managed policies in the IAM User Guide.
As a best practice, - you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.
For more information - about managed policies in general, see Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_CreatePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreatePolicyResult: - $ref: '#/components/schemas/CreatePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreatePolicy - /?Action=CreatePolicyVersion&Version=2010-05-08: - get: - description:Creates a new version of the specified managed policy. To update - a managed policy, you create a new policy version. A managed policy can have - up to five versions. If the policy has five versions, you must delete an existing - version using DeletePolicyVersion before you create a new version.
-Optionally, you can set the new version as the policy's default version. - The default version is the version that is in effect for the IAM users, groups, - and roles to which the policy is attached.
For more information about - managed policy versions, see Versioning - for managed policies in the IAM User Guide.
- operationId: GET_CreatePolicyVersion - parameters: - - description:The Amazon Resource Name (ARN) of the IAM policy to which - you want to add a new version.
For more information about ARNs, see - Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description:The JSON policy document that you want to use as the content - for this new version of the policy.
You must provide policies in - JSON format in IAM. 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 - maximum length of the policy document that you can pass in this operation, - including whitespace, is listed below. To view the maximum character counts - of a managed policy with no whitespaces, see IAM - and STS character quotas.
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)
Specifies whether to set this version as the policy's default - version.
When this parameter is true, the new policy
- version becomes the operative version. That is, it becomes the version that
- is in effect for the IAM users, groups, and roles that the policy is attached
- to.
For more information about managed policy versions, see Versioning - for managed policies in the IAM User Guide.
- in: query - name: SetAsDefault - required: false - schema: - type: boolean - responses: - '200': - content: - text/xml: - schema: - properties: - CreatePolicyVersionResult: - $ref: '#/components/schemas/CreatePolicyVersionResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreatePolicyVersion - 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' - post: - description:Creates a new version of the specified managed policy. To update - a managed policy, you create a new policy version. A managed policy can have - up to five versions. If the policy has five versions, you must delete an existing - version using DeletePolicyVersion before you create a new version.
-Optionally, you can set the new version as the policy's default version. - The default version is the version that is in effect for the IAM users, groups, - and roles to which the policy is attached.
For more information about - managed policy versions, see Versioning - for managed policies in the IAM User Guide.
- operationId: POST_CreatePolicyVersion - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePolicyVersionRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreatePolicyVersionResult: - $ref: '#/components/schemas/CreatePolicyVersionResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreatePolicyVersion - /?Action=CreateRole&Version=2010-05-08: - get: - 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. - operationId: GET_CreateRole - parameters: - - 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".
- in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - 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.
- in: query - name: AssumeRolePolicyDocument - required: true - schema: - maxLength: 131072 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description: A description of the role. - in: query - name: Description - required: false - schema: - maxLength: 1000 - pattern: '[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*' - type: string - - 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 maximum of one hour is applied. This setting can have a value - from 1 hour to 12 hours.
Anyone who assumes the role from the 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 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. -
- maxLength: 2048 - minLength: 20 - type: string - - 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.
Creates an IAM resource that describes an identity provider - (IdP) that supports SAML 2.0.
The SAML provider resource that you create - with this operation can be used as a principal in an IAM role's trust policy. - Such a policy can enable federated users who sign in using the SAML IdP to - assume the role. You can create an IAM role that supports Web-based single - sign-on (SSO) to the Amazon Web Services Management Console or one that supports - API access to Amazon Web Services.
When you create the SAML provider - resource, you upload a SAML metadata document that you get from your IdP. - That document includes the issuer's name, expiration information, and keys - that can be used to validate the SAML authentication response (assertions) - that the IdP sends. You must generate the metadata document using the identity - management software that is used as your organization's IdP.
- This operation requires Signature - Version 4.
For more information, see Enabling - SAML 2.0 federated users to access the Amazon Web Services Management Console - and About - SAML 2.0-based federation in the IAM User Guide.
- operationId: GET_CreateSAMLProvider - parameters: - - description:An XML document generated by an identity provider (IdP) that - supports SAML 2.0. The document includes the issuer's name, expiration information, - and keys that can be used to validate the SAML authentication response (assertions) - that are received from the IdP. You must generate the metadata document - using the identity management software that is used as your organization's - IdP.
For more information, see About - SAML 2.0-based federation in the IAM User Guide
- in: query - name: SAMLMetadataDocument - required: true - schema: - maxLength: 10000000 - minLength: 1000 - type: string - - description: 'The name of the provider 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: _+=,.@-
' - in: query - name: Name - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w._-]+' - type: string - - description:A list of tags that you want to attach to the new IAM SAML - provider. 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 an IAM resource that describes an identity provider - (IdP) that supports SAML 2.0.
The SAML provider resource that you create - with this operation can be used as a principal in an IAM role's trust policy. - Such a policy can enable federated users who sign in using the SAML IdP to - assume the role. You can create an IAM role that supports Web-based single - sign-on (SSO) to the Amazon Web Services Management Console or one that supports - API access to Amazon Web Services.
When you create the SAML provider - resource, you upload a SAML metadata document that you get from your IdP. - That document includes the issuer's name, expiration information, and keys - that can be used to validate the SAML authentication response (assertions) - that the IdP sends. You must generate the metadata document using the identity - management software that is used as your organization's IdP.
- This operation requires Signature - Version 4.
For more information, see Enabling - SAML 2.0 federated users to access the Amazon Web Services Management Console - and About - SAML 2.0-based federation in the IAM User Guide.
- operationId: POST_CreateSAMLProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSAMLProviderRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateSAMLProviderResult: - $ref: '#/components/schemas/CreateSAMLProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateSAMLProvider - /?Action=CreateServiceLinkedRole&Version=2010-05-08: - get: - description:Creates an IAM role that is linked to a specific Amazon Web - Services service. The service controls the attached policies and when the - role can be deleted. This helps ensure that the service is not broken by an - unexpectedly changed or deleted role, which could put your Amazon Web Services - resources into an unknown state. Allowing the service to control the role - helps improve service stability and proper cleanup when a service and its - role are no longer needed. For more information, see Using - service-linked roles in the IAM User Guide.
To attach a - policy to this service-linked role, you must make the request using the Amazon - Web Services service that depends on this role.
- operationId: GET_CreateServiceLinkedRole - parameters: - - description: 'The service principal for the Amazon Web Services service
- to which this role is attached. You use a string similar to a URL but without
- the http:// in front. For example: elasticbeanstalk.amazonaws.com.
-
Service principals are unique and case-sensitive. To find the exact - service principal for your service-linked role, see Amazon - Web Services services that work with IAM in the IAM User Guide. - Look for the services that have Yes in the Service-Linked Role - column. Choose the Yes link to view the service-linked role documentation - for that service.
' - in: query - name: AWSServiceName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The description of the role. - in: query - name: Description - required: false - schema: - maxLength: 1000 - pattern: '[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*' - type: string - - description:A string that you provide, which is combined with the
- service-provided prefix to form the complete role name. If you make multiple
- requests for the same service, then you must supply a different CustomSuffix
- for each request. Otherwise the request fails with a duplicate role name
- error. For example, you could add -1 or -debug
- to the suffix.
Some services do not support the CustomSuffix
- parameter. If you provide an optional suffix and the operation fails, try
- the operation again without the suffix.
Creates an IAM role that is linked to a specific Amazon Web - Services service. The service controls the attached policies and when the - role can be deleted. This helps ensure that the service is not broken by an - unexpectedly changed or deleted role, which could put your Amazon Web Services - resources into an unknown state. Allowing the service to control the role - helps improve service stability and proper cleanup when a service and its - role are no longer needed. For more information, see Using - service-linked roles in the IAM User Guide.
To attach a - policy to this service-linked role, you must make the request using the Amazon - Web Services service that depends on this role.
- operationId: POST_CreateServiceLinkedRole - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateServiceLinkedRoleRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateServiceLinkedRoleResult: - $ref: '#/components/schemas/CreateServiceLinkedRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateServiceLinkedRole - /?Action=CreateServiceSpecificCredential&Version=2010-05-08: - get: - description: 'Generates a set of credentials consisting of a user name and - password that can be used to access the service specified in the request. - These credentials are generated by IAM, and can be used only for the specified - service.
You can have a maximum of two sets of service-specific credentials - for each supported service per user.
You can create service-specific - credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).
-You can reset the password to a new service-generated value by calling - ResetServiceSpecificCredential.
For more information about service-specific - credentials, see Using - IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access - keys in the IAM User Guide.
' - operationId: GET_CreateServiceSpecificCredential - parameters: - - description: 'The name of the IAM user that is to be associated with the - credentials. The new service-specific credentials have the same permissions - as the associated user except that they can be used only to access the specified - service.
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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The name of the Amazon Web Services service that is to be associated - with the credentials. The service you specify here is the only service that - can be accessed using these credentials. - in: query - name: ServiceName - required: true - schema: - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - CreateServiceSpecificCredentialResult: - $ref: '#/components/schemas/CreateServiceSpecificCredentialResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceNotSupportedException' - description: ServiceNotSupportedException - x-aws-operation-name: CreateServiceSpecificCredential - 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' - post: - description: 'Generates a set of credentials consisting of a user name and - password that can be used to access the service specified in the request. - These credentials are generated by IAM, and can be used only for the specified - service.
You can have a maximum of two sets of service-specific credentials - for each supported service per user.
You can create service-specific - credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).
-You can reset the password to a new service-generated value by calling - ResetServiceSpecificCredential.
For more information about service-specific - credentials, see Using - IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access - keys in the IAM User Guide.
' - operationId: POST_CreateServiceSpecificCredential - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateServiceSpecificCredentialRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateServiceSpecificCredentialResult: - $ref: '#/components/schemas/CreateServiceSpecificCredentialResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceNotSupportedException' - description: ServiceNotSupportedException - x-aws-operation-name: CreateServiceSpecificCredential - /?Action=CreateUser&Version=2010-05-08: - get: - description:Creates a new IAM user for your Amazon Web Services account.
-For information about quotas for the number of IAM users you can create, - see IAM - and STS quotas in the IAM User Guide.
- operationId: GET_CreateUser - parameters: - - description:The path for the user name. 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 user 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".
- in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The ARN of the policy that is used to set the permissions boundary - for the user. - in: query - name: PermissionsBoundary - required: false - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description:A list of tags that you want to attach to the new user. 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 IAM user for your Amazon Web Services account.
-For information about quotas for the number of IAM users you can create, - see IAM - and STS quotas in the IAM User Guide.
- operationId: POST_CreateUser - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateUserRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateUserResult: - $ref: '#/components/schemas/CreateUserResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateUser - /?Action=CreateVirtualMFADevice&Version=2010-05-08: - get: - description:Creates a new virtual MFA device for the Amazon Web Services - account. After creating the virtual MFA, use EnableMFADevice to attach - the MFA device to an IAM user. For more information about creating and working - with virtual MFA devices, see Using - a virtual MFA device in the IAM User Guide.
For information - about the maximum number of MFA devices you can create, see IAM - and STS quotas in the IAM User Guide.
The seed - information contained in the QR code and the Base32 string should be treated - like any other secret access information. In other words, protect the seed - information as you would your Amazon Web Services access keys or your passwords. - After you provision your virtual device, you should ensure that the information - is destroyed following secure procedures.
The path for the virtual MFA device. 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 virtual MFA device. Use with path to uniquely - identify a virtual MFA device.
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: _+=,.@-
' - in: query - name: VirtualMFADeviceName - required: true - schema: - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:A list of tags that you want to attach to the new IAM virtual - MFA device. 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 virtual MFA device for the Amazon Web Services - account. After creating the virtual MFA, use EnableMFADevice to attach - the MFA device to an IAM user. For more information about creating and working - with virtual MFA devices, see Using - a virtual MFA device in the IAM User Guide.
For information - about the maximum number of MFA devices you can create, see IAM - and STS quotas in the IAM User Guide.
The seed - information contained in the QR code and the Base32 string should be treated - like any other secret access information. In other words, protect the seed - information as you would your Amazon Web Services access keys or your passwords. - After you provision your virtual device, you should ensure that the information - is destroyed following secure procedures.
Deactivates the specified MFA device and removes it from association - with the user name for which it was originally enabled.
For more information - about creating and working with virtual MFA devices, see Enabling - a virtual multi-factor authentication (MFA) device in the IAM User - Guide.
- operationId: GET_DeactivateMFADevice - parameters: - - description: 'The name of the user whose MFA device you want to deactivate.
-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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the device ARN.
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: - =,.@:/-
' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeactivateMFADevice - 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' - post: - description:Deactivates the specified MFA device and removes it from association - with the user name for which it was originally enabled.
For more information - about creating and working with virtual MFA devices, see Enabling - a virtual multi-factor authentication (MFA) device in the IAM User - Guide.
- operationId: POST_DeactivateMFADevice - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeactivateMFADeviceRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeactivateMFADevice - /?Action=DeleteAccessKey&Version=2010-05-08: - get: - description:Deletes the access key pair associated with the specified IAM - user.
If you do not specify a user name, IAM determines the user name - implicitly based on the Amazon Web Services access key ID signing the request. - This operation works for access keys under the Amazon Web Services account. - Consequently, you can use this operation to manage Amazon Web Services account - root user credentials even if the Amazon Web Services account has no associated - users.
- operationId: GET_DeleteAccessKey - parameters: - - description: 'The name of the user whose access key pair you want to delete.
-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: - _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The access key ID for the access key ID and secret access - key you want to delete.
This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.
- in: query - name: AccessKeyId - required: true - schema: - maxLength: 128 - minLength: 16 - pattern: '[\w]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteAccessKey - 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' - post: - description:Deletes the access key pair associated with the specified IAM - user.
If you do not specify a user name, IAM determines the user name - implicitly based on the Amazon Web Services access key ID signing the request. - This operation works for access keys under the Amazon Web Services account. - Consequently, you can use this operation to manage Amazon Web Services account - root user credentials even if the Amazon Web Services account has no associated - users.
- operationId: POST_DeleteAccessKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteAccessKeyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteAccessKey - /?Action=DeleteAccountAlias&Version=2010-05-08: - get: - description: ' Deletes the specified Amazon Web Services account alias. For - information about using an Amazon Web Services account alias, see Using - an alias for your Amazon Web Services account ID in the IAM User Guide.' - operationId: GET_DeleteAccountAlias - parameters: - - description:The name of the account alias to delete.
This parameter - allows (through its regex pattern) - a string of characters consisting of lowercase letters, digits, and dashes. - You cannot start or finish with a dash, nor can you have two dashes in a - row.
- in: query - name: AccountAlias - required: true - schema: - maxLength: 63 - minLength: 3 - pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$ - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteAccountAlias - 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' - post: - description: ' Deletes the specified Amazon Web Services account alias. For - information about using an Amazon Web Services account alias, see Using - an alias for your Amazon Web Services account ID in the IAM User Guide.' - operationId: POST_DeleteAccountAlias - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteAccountAliasRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteAccountAlias - /?Action=DeleteAccountPasswordPolicy&Version=2010-05-08: - get: - description: Deletes the password policy for the Amazon Web Services account. - There are no parameters. - operationId: GET_DeleteAccountPasswordPolicy - parameters: [] - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteAccountPasswordPolicy - 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' - post: - description: Deletes the password policy for the Amazon Web Services account. - There are no parameters. - operationId: POST_DeleteAccountPasswordPolicy - parameters: [] - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteAccountPasswordPolicy - /?Action=DeleteGroup&Version=2010-05-08: - get: - description: Deletes the specified IAM group. The group must not contain any - users or have any attached policies. - operationId: GET_DeleteGroup - parameters: - - description: 'The name of the IAM group to delete.
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: _+=,.@-
' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteGroup - 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' - post: - description: Deletes the specified IAM group. The group must not contain any - users or have any attached policies. - operationId: POST_DeleteGroup - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteGroupRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteGroup - /?Action=DeleteGroupPolicy&Version=2010-05-08: - get: - description:Deletes the specified inline policy that is embedded in the - specified IAM group.
A group can also have managed policies attached - to it. To detach a managed policy from a group, use DetachGroupPolicy. - For more information about policies, refer to Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_DeleteGroupPolicy - parameters: - - description: 'The name (friendly name, not ARN) identifying the group that - the policy is embedded in.
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: _+=,.@-
' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name identifying the policy document to delete.
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: - _+=,.@-
' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteGroupPolicy - 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' - post: - description:Deletes the specified inline policy that is embedded in the - specified IAM group.
A group can also have managed policies attached - to it. To detach a managed policy from a group, use DetachGroupPolicy. - For more information about policies, refer to Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_DeleteGroupPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteGroupPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteGroupPolicy - /?Action=DeleteInstanceProfile&Version=2010-05-08: - get: - description:Deletes the specified instance profile. The instance profile - must not have an associated role.
Make sure that you do - not have any Amazon EC2 instances running with the instance profile you are - about to delete. Deleting a role or instance profile that is associated with - a running instance will break any applications running on the instance.
-For more information about instance profiles, see About - instance profiles.
- operationId: GET_DeleteInstanceProfile - parameters: - - description: 'The name of the instance profile to delete.
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: _+=,.@-
' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteInstanceProfile - 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' - post: - description:Deletes the specified instance profile. The instance profile - must not have an associated role.
Make sure that you do - not have any Amazon EC2 instances running with the instance profile you are - about to delete. Deleting a role or instance profile that is associated with - a running instance will break any applications running on the instance.
-For more information about instance profiles, see About - instance profiles.
- operationId: POST_DeleteInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteInstanceProfileRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteInstanceProfile - /?Action=DeleteLoginProfile&Version=2010-05-08: - get: - description:Deletes the password for the specified IAM user, which terminates - the user's ability to access Amazon Web Services services through the Amazon - Web Services Management Console.
You can use the CLI, the Amazon Web - Services API, or the Users page in the IAM console to delete a password - for any IAM user. You can use ChangePassword to update, but not delete, - your own password in the My Security Credentials page in the Amazon - Web Services Management Console.
Deleting a user's password - does not prevent a user from accessing Amazon Web Services through the command - line interface or the API. To prevent all user access, you must also either - make any access keys inactive or delete them. For more information about making - keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey. -
The name of the user whose password you want to delete.
-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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteLoginProfile - 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' - post: - description:Deletes the password for the specified IAM user, which terminates - the user's ability to access Amazon Web Services services through the Amazon - Web Services Management Console.
You can use the CLI, the Amazon Web - Services API, or the Users page in the IAM console to delete a password - for any IAM user. You can use ChangePassword to update, but not delete, - your own password in the My Security Credentials page in the Amazon - Web Services Management Console.
Deleting a user's password - does not prevent a user from accessing Amazon Web Services through the command - line interface or the API. To prevent all user access, you must also either - make any access keys inactive or delete them. For more information about making - keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey. -
Deletes an OpenID Connect identity provider (IdP) resource object - in IAM.
Deleting an IAM OIDC provider resource does not update any - roles that reference the provider as a principal in their trust policies. - Any attempt to assume a role that references a deleted provider fails.
-This operation is idempotent; it does not fail or return an error if you - call the operation for a provider that does not exist.
- operationId: GET_DeleteOpenIDConnectProvider - parameters: - - description: The Amazon Resource Name (ARN) of the IAM OpenID Connect provider - resource object to delete. You can get a list of OpenID Connect provider - resource ARNs by using the ListOpenIDConnectProviders operation. - in: query - name: OpenIDConnectProviderArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteOpenIDConnectProvider - 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' - post: - description:Deletes an OpenID Connect identity provider (IdP) resource object - in IAM.
Deleting an IAM OIDC provider resource does not update any - roles that reference the provider as a principal in their trust policies. - Any attempt to assume a role that references a deleted provider fails.
-This operation is idempotent; it does not fail or return an error if you - call the operation for a provider that does not exist.
- operationId: POST_DeleteOpenIDConnectProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteOpenIDConnectProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteOpenIDConnectProvider - /?Action=DeletePolicy&Version=2010-05-08: - get: - description:Deletes the specified managed policy.
Before you can - delete a managed policy, you must first detach the policy from all users, - groups, and roles that it is attached to. In addition, you must delete all - the policy's versions. The following steps describe the process for deleting - a managed policy:
Detach the policy from all users, groups, - and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, - or DetachRolePolicy. To list all the users, groups, and roles that - a policy is attached to, use ListEntitiesForPolicy.
Delete all versions of the policy using DeletePolicyVersion. To - list the policy's versions, use ListPolicyVersions. You cannot use - DeletePolicyVersion to delete the version that is marked as the default - version. You delete the policy's default version in the next step of the process.
-Delete the policy (this automatically deletes the policy's default - version) using this operation.
For information about managed - policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_DeletePolicy - parameters: - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to delete.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeletePolicy - 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' - post: - description:Deletes the specified managed policy.
Before you can - delete a managed policy, you must first detach the policy from all users, - groups, and roles that it is attached to. In addition, you must delete all - the policy's versions. The following steps describe the process for deleting - a managed policy:
Detach the policy from all users, groups, - and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, - or DetachRolePolicy. To list all the users, groups, and roles that - a policy is attached to, use ListEntitiesForPolicy.
Delete all versions of the policy using DeletePolicyVersion. To - list the policy's versions, use ListPolicyVersions. You cannot use - DeletePolicyVersion to delete the version that is marked as the default - version. You delete the policy's default version in the next step of the process.
-Delete the policy (this automatically deletes the policy's default - version) using this operation.
For information about managed - policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_DeletePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeletePolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeletePolicy - /?Action=DeletePolicyVersion&Version=2010-05-08: - get: - description:Deletes the specified version from the specified managed policy.
-You cannot delete the default version from a policy using this operation. - To delete the default version from a policy, use DeletePolicy. To find - out which version of a policy is marked as the default version, use ListPolicyVersions.
-For information about versions for managed policies, see Versioning - for managed policies in the IAM User Guide.
- operationId: GET_DeletePolicyVersion - parameters: - - description:The Amazon Resource Name (ARN) of the IAM policy from which - you want to delete a version.
For more information about ARNs, see - Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description:The policy version to delete.
This parameter allows - (through its regex pattern) - a string of characters that consists of the lowercase letter 'v' followed - by one or two digits, and optionally followed by a period '.' and a string - of letters and digits.
For more information about managed policy - versions, see Versioning - for managed policies in the IAM User Guide.
- in: query - name: VersionId - required: true - schema: - pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeletePolicyVersion - 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' - post: - description:Deletes the specified version from the specified managed policy.
-You cannot delete the default version from a policy using this operation. - To delete the default version from a policy, use DeletePolicy. To find - out which version of a policy is marked as the default version, use ListPolicyVersions.
-For information about versions for managed policies, see Versioning - for managed policies in the IAM User Guide.
- operationId: POST_DeletePolicyVersion - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeletePolicyVersionRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeletePolicyVersion - /?Action=DeleteRole&Version=2010-05-08: - get: - description:Deletes the specified role. The role must not have any policies - attached. For more information about roles, see Working - with roles.
Make sure that you do not have any Amazon - EC2 instances running with the role you are about to delete. Deleting a role - or instance profile that is associated with a running instance will break - any applications running on the instance.
The name of the role to delete.
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: _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteRole - 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' - post: - description:Deletes the specified role. The role must not have any policies - attached. For more information about roles, see Working - with roles.
Make sure that you do not have any Amazon - EC2 instances running with the role you are about to delete. Deleting a role - or instance profile that is associated with a running instance will break - any applications running on the instance.
Deletes the permissions boundary for the specified IAM role. -
Deleting the permissions boundary for a role might increase - its permissions. For example, it might allow anyone who assumes the role to - perform all the actions granted in its permissions policies.
Deletes the permissions boundary for the specified IAM role. -
Deleting the permissions boundary for a role might increase - its permissions. For example, it might allow anyone who assumes the role to - perform all the actions granted in its permissions policies.
Deletes the specified inline policy that is embedded in the - specified IAM role.
A role can also have managed policies attached - to it. To detach a managed policy from a role, use DetachRolePolicy. - For more information about policies, refer to Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_DeleteRolePolicy - parameters: - - description: 'The name (friendly name, not ARN) identifying the role that - the policy is embedded in.
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: _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name of the inline policy to delete from the specified - IAM role.
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: - _+=,.@-
' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteRolePolicy - 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' - post: - description:Deletes the specified inline policy that is embedded in the - specified IAM role.
A role can also have managed policies attached - to it. To detach a managed policy from a role, use DetachRolePolicy. - For more information about policies, refer to Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_DeleteRolePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteRolePolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteRolePolicy - /?Action=DeleteSAMLProvider&Version=2010-05-08: - get: - description:Deletes a SAML provider resource in IAM.
Deleting the - provider resource from IAM does not update any roles that reference the SAML - provider resource's ARN as a principal in their trust policies. Any attempt - to assume a role that references a non-existent provider resource ARN fails.
-This operation requires Signature - Version 4.
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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteSAMLProvider - 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' - post: - description:Deletes a SAML provider resource in IAM.
Deleting the - provider resource from IAM does not update any roles that reference the SAML - provider resource's ARN as a principal in their trust policies. Any attempt - to assume a role that references a non-existent provider resource ARN fails.
-This operation requires Signature - Version 4.
Deletes the specified SSH public key.
The SSH public - key deleted by this operation is used only for authenticating the associated - IAM user to an CodeCommit repository. For more information about using SSH - keys to authenticate to an CodeCommit repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.
- operationId: GET_DeleteSSHPublicKey - parameters: - - description: 'The name of the IAM user associated with the SSH public key.
-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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The unique identifier for the SSH public key.
This - parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.
- in: query - name: SSHPublicKeyId - required: true - schema: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: DeleteSSHPublicKey - 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' - post: - description:Deletes the specified SSH public key.
The SSH public - key deleted by this operation is used only for authenticating the associated - IAM user to an CodeCommit repository. For more information about using SSH - keys to authenticate to an CodeCommit repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.
- operationId: POST_DeleteSSHPublicKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSSHPublicKeyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: DeleteSSHPublicKey - /?Action=DeleteServerCertificate&Version=2010-05-08: - get: - description:Deletes the specified server certificate.
For more information - about working with server certificates, see Working - with server certificates in the IAM User Guide. This topic also - includes a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.
If you are using a server certificate - with Elastic Load Balancing, deleting the certificate could have implications - for your application. If Elastic Load Balancing doesn't detect the deletion - of bound certificates, it may continue to use the certificates. This could - cause Elastic Load Balancing to stop accepting traffic. We recommend that - you remove the reference to the certificate from Elastic Load Balancing before - using this command to delete the certificate. For more information, see DeleteLoadBalancerListeners - in the Elastic Load Balancing API Reference.
The name of the server certificate you want to delete.
-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: - _+=,.@-
' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteServerCertificate - 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' - post: - description:Deletes the specified server certificate.
For more information - about working with server certificates, see Working - with server certificates in the IAM User Guide. This topic also - includes a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.
If you are using a server certificate - with Elastic Load Balancing, deleting the certificate could have implications - for your application. If Elastic Load Balancing doesn't detect the deletion - of bound certificates, it may continue to use the certificates. This could - cause Elastic Load Balancing to stop accepting traffic. We recommend that - you remove the reference to the certificate from Elastic Load Balancing before - using this command to delete the certificate. For more information, see DeleteLoadBalancerListeners - in the Elastic Load Balancing API Reference.
Submits a service-linked role deletion request and returns
- a DeletionTaskId, which you can use to check the status of the
- deletion. Before you call this operation, confirm that the role has no active
- sessions and that any resources used by the role in the linked service are
- deleted. If you call this operation more than once for the same service-linked
- role and an earlier deletion task is not complete, then the DeletionTaskId
- of the earlier request is returned.
If you submit a deletion request - for a service-linked role whose linked service is still accessing a resource, - then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus - operation returns the reason for the failure, usually including the resources - that must be deleted. To delete the service-linked role, you must first remove - those resources from the linked service and then submit the deletion request - again. Resources are specific to the service that is linked to the role. For - more information about removing resources from a service, see the Amazon - Web Services documentation for your service.
For more information - about service-linked roles, see Roles - terms and concepts: Amazon Web Services service-linked role in the IAM - User Guide.
' - operationId: GET_DeleteServiceLinkedRole - parameters: - - description: The name of the service-linked role to be deleted. - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - DeleteServiceLinkedRoleResult: - $ref: '#/components/schemas/DeleteServiceLinkedRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteServiceLinkedRole - 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' - post: - description: 'Submits a service-linked role deletion request and returns
- a DeletionTaskId, which you can use to check the status of the
- deletion. Before you call this operation, confirm that the role has no active
- sessions and that any resources used by the role in the linked service are
- deleted. If you call this operation more than once for the same service-linked
- role and an earlier deletion task is not complete, then the DeletionTaskId
- of the earlier request is returned.
If you submit a deletion request - for a service-linked role whose linked service is still accessing a resource, - then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus - operation returns the reason for the failure, usually including the resources - that must be deleted. To delete the service-linked role, you must first remove - those resources from the linked service and then submit the deletion request - again. Resources are specific to the service that is linked to the role. For - more information about removing resources from a service, see the Amazon - Web Services documentation for your service.
For more information - about service-linked roles, see Roles - terms and concepts: Amazon Web Services service-linked role in the IAM - User Guide.
' - operationId: POST_DeleteServiceLinkedRole - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteServiceLinkedRoleRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - DeleteServiceLinkedRoleResult: - $ref: '#/components/schemas/DeleteServiceLinkedRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteServiceLinkedRole - /?Action=DeleteServiceSpecificCredential&Version=2010-05-08: - get: - description: Deletes the specified service-specific credential. - operationId: GET_DeleteServiceSpecificCredential - parameters: - - description: 'The name of the IAM user associated with the service-specific - credential. If this value is not specified, then the operation assumes the - user whose credentials are used to call the operation.
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: _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The unique identifier of the service-specific credential. - You can get this value by calling ListServiceSpecificCredentials.
-This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.
- in: query - name: ServiceSpecificCredentialId - required: true - schema: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: DeleteServiceSpecificCredential - 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' - post: - description: Deletes the specified service-specific credential. - operationId: POST_DeleteServiceSpecificCredential - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteServiceSpecificCredentialRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: DeleteServiceSpecificCredential - /?Action=DeleteSigningCertificate&Version=2010-05-08: - get: - description:Deletes a signing certificate associated with the specified - IAM user.
If you do not specify a user name, IAM determines the user - name implicitly based on the Amazon Web Services access key ID signing the - request. This operation works for access keys under the Amazon Web Services - account. Consequently, you can use this operation to manage Amazon Web Services - account root user credentials even if the Amazon Web Services account has - no associated IAM users.
- operationId: GET_DeleteSigningCertificate - parameters: - - description: 'The name of the user the signing certificate belongs to.
-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: - _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The ID of the signing certificate to delete.
The format - of this parameter, as described by its regex - pattern, is a string of characters that can be upper- or lower-cased letters - or digits.
- in: query - name: CertificateId - required: true - schema: - maxLength: 128 - minLength: 24 - pattern: '[\w]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteSigningCertificate - 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' - post: - description:Deletes a signing certificate associated with the specified - IAM user.
If you do not specify a user name, IAM determines the user - name implicitly based on the Amazon Web Services access key ID signing the - request. This operation works for access keys under the Amazon Web Services - account. Consequently, you can use this operation to manage Amazon Web Services - account root user credentials even if the Amazon Web Services account has - no associated IAM users.
- operationId: POST_DeleteSigningCertificate - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSigningCertificateRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteSigningCertificate - /?Action=DeleteUser&Version=2010-05-08: - get: - description:Deletes the specified IAM user. Unlike the Amazon Web Services - Management Console, when you delete a user programmatically, you must delete - the items attached to the user manually, or the deletion fails. For more information, - see Deleting - an IAM user. Before attempting to delete a user, remove the following - items:
Password (DeleteLoginProfile)
Access keys (DeleteAccessKey)
Signing certificate - (DeleteSigningCertificate)
SSH public key (DeleteSSHPublicKey)
-Git credentials (DeleteServiceSpecificCredential)
-Multi-factor authentication (MFA) device (DeactivateMFADevice, - DeleteVirtualMFADevice)
Inline policies (DeleteUserPolicy)
-Attached managed policies (DetachUserPolicy)
Group memberships (RemoveUserFromGroup)
The name of the user to delete.
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: _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteUser - 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' - post: - description:Deletes the specified IAM user. Unlike the Amazon Web Services - Management Console, when you delete a user programmatically, you must delete - the items attached to the user manually, or the deletion fails. For more information, - see Deleting - an IAM user. Before attempting to delete a user, remove the following - items:
Password (DeleteLoginProfile)
Access keys (DeleteAccessKey)
Signing certificate - (DeleteSigningCertificate)
SSH public key (DeleteSSHPublicKey)
-Git credentials (DeleteServiceSpecificCredential)
-Multi-factor authentication (MFA) device (DeactivateMFADevice, - DeleteVirtualMFADevice)
Inline policies (DeleteUserPolicy)
-Attached managed policies (DetachUserPolicy)
Group memberships (RemoveUserFromGroup)
Deletes the permissions boundary for the specified IAM user.
-Deleting the permissions boundary for a user might increase - its permissions by allowing the user to perform all the actions granted in - its permissions policies.
Deletes the permissions boundary for the specified IAM user.
-Deleting the permissions boundary for a user might increase - its permissions by allowing the user to perform all the actions granted in - its permissions policies.
Deletes the specified inline policy that is embedded in the - specified IAM user.
A user can also have managed policies attached - to it. To detach a managed policy from a user, use DetachUserPolicy. - For more information about policies, refer to Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_DeleteUserPolicy - parameters: - - description: 'The name (friendly name, not ARN) identifying the user that - the policy is embedded in.
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: _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name identifying the policy document to delete.
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: - _+=,.@-
' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteUserPolicy - 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' - post: - description:Deletes the specified inline policy that is embedded in the - specified IAM user.
A user can also have managed policies attached - to it. To detach a managed policy from a user, use DetachUserPolicy. - For more information about policies, refer to Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_DeleteUserPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteUserPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteUserPolicy - /?Action=DeleteVirtualMFADevice&Version=2010-05-08: - get: - description:Deletes a virtual MFA device.
You must deactivate - a user's virtual MFA device before you can delete it. For information about - deactivating MFA devices, see DeactivateMFADevice.
The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the same as the ARN.
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: - =,.@:/-
' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteVirtualMFADevice - 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' - post: - description:Deletes a virtual MFA device.
You must deactivate - a user's virtual MFA device before you can delete it. For information about - deactivating MFA devices, see DeactivateMFADevice.
Removes the specified managed policy from the specified IAM - group.
A group can also have inline policies embedded with it. To delete - an inline policy, use DeleteGroupPolicy. For information about policies, - see Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_DetachGroupPolicy - parameters: - - description: 'The name (friendly name, not ARN) of the IAM group to detach - the policy from.
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: - _+=,.@-
' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to detach.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DetachGroupPolicy - 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' - post: - description:Removes the specified managed policy from the specified IAM - group.
A group can also have inline policies embedded with it. To delete - an inline policy, use DeleteGroupPolicy. For information about policies, - see Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_DetachGroupPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachGroupPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DetachGroupPolicy - /?Action=DetachRolePolicy&Version=2010-05-08: - get: - description:Removes the specified managed policy from the specified role.
-A role can also have inline policies embedded with it. To delete an inline - policy, use DeleteRolePolicy. For information about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_DetachRolePolicy - parameters: - - description: 'The name (friendly name, not ARN) of the IAM role to detach - the policy from.
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: - _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to detach.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DetachRolePolicy - 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' - post: - description:Removes the specified managed policy from the specified role.
-A role can also have inline policies embedded with it. To delete an inline - policy, use DeleteRolePolicy. For information about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_DetachRolePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachRolePolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DetachRolePolicy - /?Action=DetachUserPolicy&Version=2010-05-08: - get: - description:Removes the specified managed policy from the specified user.
-A user can also have inline policies embedded with it. To delete an inline - policy, use DeleteUserPolicy. For information about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_DetachUserPolicy - parameters: - - description: 'The name (friendly name, not ARN) of the IAM user to detach - the policy from.
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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The Amazon Resource Name (ARN) of the IAM policy you want - to detach.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DetachUserPolicy - 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' - post: - description:Removes the specified managed policy from the specified user.
-A user can also have inline policies embedded with it. To delete an inline - policy, use DeleteUserPolicy. For information about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_DetachUserPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachUserPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DetachUserPolicy - /?Action=EnableMFADevice&Version=2010-05-08: - get: - description: Enables the specified MFA device and associates it with the specified - IAM user. When enabled, the MFA device is required for every subsequent login - by the IAM user associated with the device. - operationId: GET_EnableMFADevice - parameters: - - description: 'The name of the IAM user for whom you want to enable the - MFA device.
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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the device ARN.
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: - =,.@:/-
' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - - description:An authentication code emitted by the device.
The - format for this parameter is a string of six digits.
Submit - your request immediately after generating the authentication codes. If you - generate the codes and then wait too long to submit the request, the MFA - device successfully associates with the user but the MFA device becomes - out of sync. This happens because time-based one-time passwords (TOTP) expire - after a short period of time. If this happens, you can resync - the device.
A subsequent authentication code emitted by the device.
-The format for this parameter is a string of six digits.
Submit your request immediately after generating the authentication codes. - If you generate the codes and then wait too long to submit the request, - the MFA device successfully associates with the user but the MFA device - becomes out of sync. This happens because time-based one-time passwords - (TOTP) expire after a short period of time. If this happens, you can resync - the device.
Generates a report for service last accessed data for Organizations.\ - \ You can generate a report for any entities (organization root, organizational\ - \ unit, or account) or policies in your organization.
To call this\ - \ operation, you must be signed in using your Organizations management account\ - \ credentials. You can use your long-term IAM user or root user credentials,\ - \ or temporary credentials from assuming an IAM role. SCPs must be enabled\ - \ for your organization root. You must have the required IAM and Organizations\ - \ permissions. For more information, see Refining permissions using service last accessed data in the IAM User\ - \ Guide.
You can generate a service last accessed data report for\ - \ entities by specifying only the entity's path. This data includes a list\ - \ of services that are allowed by any service control policies (SCPs) that\ - \ apply to the entity.
You can generate a service last accessed data\ - \ report for a policy by specifying an entity's path and an optional Organizations\ - \ policy ID. This data includes a list of services that are allowed by the\ - \ specified SCP.
For each service in both report types, the data includes\ - \ the most recent account activity that the policy allows to account principals\ - \ in the entity or the entity's children. For important information about\ - \ the data, reporting period, permissions required, troubleshooting, and supported\ - \ Regions see Reducing permissions using service last accessed data in the IAM User\ - \ Guide.
The data includes\_all\_attempts to access\ - \ Amazon Web Services, not just the successful ones. This includes all attempts\ - \ that were made using the Amazon Web Services Management Console, the Amazon\ - \ Web Services API through any of the SDKs, or any of the command line tools.\ - \ An unexpected entry in the service last accessed data does not mean that\ - \ an account has been compromised, because the request might have been denied.\ - \ Refer to your CloudTrail logs as the authoritative source for information\ - \ about all API calls and whether they were successful or denied access. For\ - \ more information, see\_Logging IAM events with CloudTrail in the IAM User Guide.
\ - \This operation returns a JobId. Use this parameter\
- \ in the GetOrganizationsAccessReport operation to check\
- \ the status of the report generation. To check the status of this request,\
- \ use the JobId parameter in the GetOrganizationsAccessReport\
- \ operation and test the JobStatus response parameter.\
- \ When the job is complete, you can retrieve the report.
To generate\ - \ a service last accessed data report for entities, specify an entity path\ - \ without specifying the optional Organizations policy ID. The type of entity\ - \ that you specify determines the data returned in the report.
Root \u2013 When you specify the organizations root as the entity,\ - \ the resulting report lists all of the services allowed by SCPs that are\ - \ attached to your root. For each service, the report includes data for all\ - \ accounts in your organization except the management account, because the\ - \ management account is not limited by SCPs.
OU\ - \ \u2013 When you specify an organizational unit (OU) as the entity, the resulting\ - \ report lists all of the services allowed by SCPs that are attached to the\ - \ OU and its parents. For each service, the report includes data for all accounts\ - \ in the OU or its children. This data excludes the management account, because\ - \ the management account is not limited by SCPs.
management\ - \ account \u2013 When you specify the management account, the resulting\ - \ report lists all Amazon Web Services services, because the management account\ - \ is not limited by SCPs. For each service, the report includes data for only\ - \ the management account.
Account \u2013 When you\ - \ specify another account as the entity, the resulting report lists all of\ - \ the services allowed by SCPs that are attached to the account and its parents.\ - \ For each service, the report includes data for only the specified account.
\ - \To generate a service last accessed data report for policies,\ - \ specify an entity path and the optional Organizations policy ID. The type\ - \ of entity that you specify determines the data returned for each service.
\ - \Root \u2013 When you specify the root entity and a\ - \ policy ID, the resulting report lists all of the services that are allowed\ - \ by the specified SCP. For each service, the report includes data for all\ - \ accounts in your organization to which the SCP applies. This data excludes\ - \ the management account, because the management account is not limited by\ - \ SCPs. If the SCP is not attached to any entities in the organization, then\ - \ the report will return a list of services with no data.
\ - \ OU \u2013 When you specify an OU entity and a policy ID, the resulting\ - \ report lists all of the services that are allowed by the specified SCP.\ - \ For each service, the report includes data for all accounts in the OU or\ - \ its children to which the SCP applies. This means that other accounts outside\ - \ the OU that are affected by the SCP might not be included in the data. This\ - \ data excludes the management account, because the management account is\ - \ not limited by SCPs. If the SCP is not attached to the OU or one of its\ - \ children, the report will return a list of services with no data.
management account \u2013 When you specify the management\ - \ account, the resulting report lists all Amazon Web Services services, because\ - \ the management account is not limited by SCPs. If you specify a policy ID\ - \ in the CLI or API, the policy is ignored. For each service, the report includes\ - \ data for only the management account.
Account\ - \ \u2013 When you specify another account entity and a policy ID, the resulting\ - \ report lists all of the services that are allowed by the specified SCP.\ - \ For each service, the report includes data for only the specified account.\ - \ This means that other accounts in the organization that are affected by\ - \ the SCP might not be included in the data. If the SCP is not attached to\ - \ the account, the report will return a list of services with no data.
\ - \Service last accessed data does not use other policy\ - \ types when determining whether a principal could access a service. These\ - \ other policy types include identity-based policies, resource-based policies,\ - \ access control lists, IAM permissions boundaries, and STS assume role policies.\ - \ It only applies SCP logic. For more about the evaluation of policy types,\ - \ see Evaluating policies in the IAM User Guide.
For\ - \ more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.
" - operationId: GET_GenerateOrganizationsAccessReport - parameters: - - description: The path of the Organizations entity (root, OU, or account). - You can build an entity path using the known structure of your organization. - For example, assume that your account ID is123456789012 and
- its parent OU ID is ou-rge0-awsabcde. The organization root
- ID is r-f6g7h8i9j0example and your organization ID is o-a1b2c3d4e5.
- Your entity path is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.
- in: query
- name: EntityPath
- required: true
- schema:
- maxLength: 427
- minLength: 19
- pattern: ^o-[0-9a-z]{10,32}\/r-[0-9a-z]{4,32}[0-9a-z-\/]*
- type: string
- - description: The identifier of the Organizations service control policy - (SCP). This parameter is optional.
This ID is used to generate information - about when an account principal that is limited by the SCP attempted to - access an Amazon Web Services service.
- in: query - name: OrganizationsPolicyId - required: false - schema: - pattern: ^p-[0-9a-zA-Z_]{8,128}$ - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GenerateOrganizationsAccessReportResult: - $ref: '#/components/schemas/GenerateOrganizationsAccessReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ReportGenerationLimitExceededException' - description: ReportGenerationLimitExceededException - x-aws-operation-name: GenerateOrganizationsAccessReport - 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' - post: - description: "Generates a report for service last accessed data for Organizations.\ - \ You can generate a report for any entities (organization root, organizational\ - \ unit, or account) or policies in your organization.
To call this\ - \ operation, you must be signed in using your Organizations management account\ - \ credentials. You can use your long-term IAM user or root user credentials,\ - \ or temporary credentials from assuming an IAM role. SCPs must be enabled\ - \ for your organization root. You must have the required IAM and Organizations\ - \ permissions. For more information, see Refining permissions using service last accessed data in the IAM User\ - \ Guide.
You can generate a service last accessed data report for\ - \ entities by specifying only the entity's path. This data includes a list\ - \ of services that are allowed by any service control policies (SCPs) that\ - \ apply to the entity.
You can generate a service last accessed data\ - \ report for a policy by specifying an entity's path and an optional Organizations\ - \ policy ID. This data includes a list of services that are allowed by the\ - \ specified SCP.
For each service in both report types, the data includes\ - \ the most recent account activity that the policy allows to account principals\ - \ in the entity or the entity's children. For important information about\ - \ the data, reporting period, permissions required, troubleshooting, and supported\ - \ Regions see Reducing permissions using service last accessed data in the IAM User\ - \ Guide.
The data includes\_all\_attempts to access\ - \ Amazon Web Services, not just the successful ones. This includes all attempts\ - \ that were made using the Amazon Web Services Management Console, the Amazon\ - \ Web Services API through any of the SDKs, or any of the command line tools.\ - \ An unexpected entry in the service last accessed data does not mean that\ - \ an account has been compromised, because the request might have been denied.\ - \ Refer to your CloudTrail logs as the authoritative source for information\ - \ about all API calls and whether they were successful or denied access. For\ - \ more information, see\_Logging IAM events with CloudTrail in the IAM User Guide.
\ - \This operation returns a JobId. Use this parameter\
- \ in the GetOrganizationsAccessReport operation to check\
- \ the status of the report generation. To check the status of this request,\
- \ use the JobId parameter in the GetOrganizationsAccessReport\
- \ operation and test the JobStatus response parameter.\
- \ When the job is complete, you can retrieve the report.
To generate\ - \ a service last accessed data report for entities, specify an entity path\ - \ without specifying the optional Organizations policy ID. The type of entity\ - \ that you specify determines the data returned in the report.
Root \u2013 When you specify the organizations root as the entity,\ - \ the resulting report lists all of the services allowed by SCPs that are\ - \ attached to your root. For each service, the report includes data for all\ - \ accounts in your organization except the management account, because the\ - \ management account is not limited by SCPs.
OU\ - \ \u2013 When you specify an organizational unit (OU) as the entity, the resulting\ - \ report lists all of the services allowed by SCPs that are attached to the\ - \ OU and its parents. For each service, the report includes data for all accounts\ - \ in the OU or its children. This data excludes the management account, because\ - \ the management account is not limited by SCPs.
management\ - \ account \u2013 When you specify the management account, the resulting\ - \ report lists all Amazon Web Services services, because the management account\ - \ is not limited by SCPs. For each service, the report includes data for only\ - \ the management account.
Account \u2013 When you\ - \ specify another account as the entity, the resulting report lists all of\ - \ the services allowed by SCPs that are attached to the account and its parents.\ - \ For each service, the report includes data for only the specified account.
\ - \To generate a service last accessed data report for policies,\ - \ specify an entity path and the optional Organizations policy ID. The type\ - \ of entity that you specify determines the data returned for each service.
\ - \Root \u2013 When you specify the root entity and a\ - \ policy ID, the resulting report lists all of the services that are allowed\ - \ by the specified SCP. For each service, the report includes data for all\ - \ accounts in your organization to which the SCP applies. This data excludes\ - \ the management account, because the management account is not limited by\ - \ SCPs. If the SCP is not attached to any entities in the organization, then\ - \ the report will return a list of services with no data.
\ - \ OU \u2013 When you specify an OU entity and a policy ID, the resulting\ - \ report lists all of the services that are allowed by the specified SCP.\ - \ For each service, the report includes data for all accounts in the OU or\ - \ its children to which the SCP applies. This means that other accounts outside\ - \ the OU that are affected by the SCP might not be included in the data. This\ - \ data excludes the management account, because the management account is\ - \ not limited by SCPs. If the SCP is not attached to the OU or one of its\ - \ children, the report will return a list of services with no data.
management account \u2013 When you specify the management\ - \ account, the resulting report lists all Amazon Web Services services, because\ - \ the management account is not limited by SCPs. If you specify a policy ID\ - \ in the CLI or API, the policy is ignored. For each service, the report includes\ - \ data for only the management account.
Account\ - \ \u2013 When you specify another account entity and a policy ID, the resulting\ - \ report lists all of the services that are allowed by the specified SCP.\ - \ For each service, the report includes data for only the specified account.\ - \ This means that other accounts in the organization that are affected by\ - \ the SCP might not be included in the data. If the SCP is not attached to\ - \ the account, the report will return a list of services with no data.
\ - \Service last accessed data does not use other policy\ - \ types when determining whether a principal could access a service. These\ - \ other policy types include identity-based policies, resource-based policies,\ - \ access control lists, IAM permissions boundaries, and STS assume role policies.\ - \ It only applies SCP logic. For more about the evaluation of policy types,\ - \ see Evaluating policies in the IAM User Guide.
For\ - \ more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.
" - operationId: POST_GenerateOrganizationsAccessReport - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GenerateOrganizationsAccessReportRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GenerateOrganizationsAccessReportResult: - $ref: '#/components/schemas/GenerateOrganizationsAccessReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ReportGenerationLimitExceededException' - description: ReportGenerationLimitExceededException - x-aws-operation-name: GenerateOrganizationsAccessReport - /?Action=GenerateServiceLastAccessedDetails&Version=2010-05-08: - get: - description: "Generates a report that includes details about when an IAM\ - \ resource (user, group, role, or policy) was last used in an attempt to access\ - \ Amazon Web Services services. Recent activity usually appears within four\ - \ hours. IAM reports activity for at least the last 400 days, or less if your\ - \ Region began supporting this feature within the last year. For more information,\ - \ see Regions where data is tracked.
The service last accessed\ - \ data includes\_all\_attempts to access an Amazon Web Services API, not just\ - \ the successful ones. This includes all attempts that were made using the\ - \ Amazon Web Services Management Console, the Amazon Web Services API through\ - \ any of the SDKs, or any of the command line tools. An unexpected entry in\ - \ the service last accessed data does not mean that your account has been\ - \ compromised, because the request might have been denied. Refer to your CloudTrail\ - \ logs as the authoritative source for information about all API calls and\ - \ whether they were successful or denied access. For more information, see\_\ - Logging IAM events with CloudTrail in the IAM User Guide.
\ - \The GenerateServiceLastAccessedDetails operation\
- \ returns a JobId. Use this parameter in the following operations\
- \ to retrieve the following details from your report:
GetServiceLastAccessedDetails\ - \ \u2013 Use this operation for users, groups, roles, or policies to list\ - \ every Amazon Web Services service that the resource could access using permissions\ - \ policies. For each service, the response includes information about the\ - \ most recent access attempt.
The JobId returned by GenerateServiceLastAccessedDetail\
- \ must be used by the same role within a session, or by the same user when\
- \ used to call GetServiceLastAccessedDetail.
\ - \ GetServiceLastAccessedDetailsWithEntities \u2013 Use this operation\ - \ for groups and policies to list information about the associated entities\ - \ (users or roles) that attempted to access a specific Amazon Web Services\ - \ service.
To check the status of the GenerateServiceLastAccessedDetails\
- \ request, use the JobId parameter in the same operations and\
- \ test the JobStatus response parameter.
For additional\ - \ information about the permissions policies that allow an identity (user,\ - \ group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess\ - \ operation.
Service last accessed data does not use other policy\ - \ types when determining whether a resource could access a service. These\ - \ other policy types include resource-based policies, access control lists,\ - \ Organizations policies, IAM permissions boundaries, and STS assume role\ - \ policies. It only applies permissions policy logic. For more about the evaluation\ - \ of policy types, see Evaluating policies in the IAM User Guide.
For\ - \ more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User\ - \ Guide.
" - operationId: GET_GenerateServiceLastAccessedDetails - parameters: - - description: The ARN of the IAM resource (user, group, role, or managed policy) - used to generate information about when the resource was last used in an - attempt to access an Amazon Web Services service. - in: query - name: Arn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description: The level of detail that you want to generate. You can specify - whether you want to generate information about the last attempt to access - services or actions. If you specify service-level granularity, this operation - generates only service data. If you specify action-level granularity, it - generates service and action data. If you don't include this optional parameter, - the operation generates service data. - in: query - name: Granularity - required: false - schema: - enum: - - SERVICE_LEVEL - - ACTION_LEVEL - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GenerateServiceLastAccessedDetailsResult: - $ref: '#/components/schemas/GenerateServiceLastAccessedDetailsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GenerateServiceLastAccessedDetails - 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' - post: - description: "Generates a report that includes details about when an IAM\ - \ resource (user, group, role, or policy) was last used in an attempt to access\ - \ Amazon Web Services services. Recent activity usually appears within four\ - \ hours. IAM reports activity for at least the last 400 days, or less if your\ - \ Region began supporting this feature within the last year. For more information,\ - \ see Regions where data is tracked.
The service last accessed\ - \ data includes\_all\_attempts to access an Amazon Web Services API, not just\ - \ the successful ones. This includes all attempts that were made using the\ - \ Amazon Web Services Management Console, the Amazon Web Services API through\ - \ any of the SDKs, or any of the command line tools. An unexpected entry in\ - \ the service last accessed data does not mean that your account has been\ - \ compromised, because the request might have been denied. Refer to your CloudTrail\ - \ logs as the authoritative source for information about all API calls and\ - \ whether they were successful or denied access. For more information, see\_\ - Logging IAM events with CloudTrail in the IAM User Guide.
\ - \The GenerateServiceLastAccessedDetails operation\
- \ returns a JobId. Use this parameter in the following operations\
- \ to retrieve the following details from your report:
GetServiceLastAccessedDetails\ - \ \u2013 Use this operation for users, groups, roles, or policies to list\ - \ every Amazon Web Services service that the resource could access using permissions\ - \ policies. For each service, the response includes information about the\ - \ most recent access attempt.
The JobId returned by GenerateServiceLastAccessedDetail\
- \ must be used by the same role within a session, or by the same user when\
- \ used to call GetServiceLastAccessedDetail.
\ - \ GetServiceLastAccessedDetailsWithEntities \u2013 Use this operation\ - \ for groups and policies to list information about the associated entities\ - \ (users or roles) that attempted to access a specific Amazon Web Services\ - \ service.
To check the status of the GenerateServiceLastAccessedDetails\
- \ request, use the JobId parameter in the same operations and\
- \ test the JobStatus response parameter.
For additional\ - \ information about the permissions policies that allow an identity (user,\ - \ group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess\ - \ operation.
Service last accessed data does not use other policy\ - \ types when determining whether a resource could access a service. These\ - \ other policy types include resource-based policies, access control lists,\ - \ Organizations policies, IAM permissions boundaries, and STS assume role\ - \ policies. It only applies permissions policy logic. For more about the evaluation\ - \ of policy types, see Evaluating policies in the IAM User Guide.
For\ - \ more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User\ - \ Guide.
" - operationId: POST_GenerateServiceLastAccessedDetails - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GenerateServiceLastAccessedDetailsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GenerateServiceLastAccessedDetailsResult: - $ref: '#/components/schemas/GenerateServiceLastAccessedDetailsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GenerateServiceLastAccessedDetails - /?Action=GetAccessKeyLastUsed&Version=2010-05-08: - get: - description: Retrieves information about when the specified access key was last - used. The information includes the date and time of last use, along with the - Amazon Web Services service and Region that were specified in the last request - made with that key. - operationId: GET_GetAccessKeyLastUsed - parameters: - - description:The identifier of an access key.
This parameter allows - (through its regex pattern) - a string of characters that can consist of any upper or lowercased letter - or digit.
- in: query - name: AccessKeyId - required: true - schema: - maxLength: 128 - minLength: 16 - pattern: '[\w]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetAccessKeyLastUsedResult: - $ref: '#/components/schemas/GetAccessKeyLastUsedResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: GetAccessKeyLastUsed - 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' - post: - description: Retrieves information about when the specified access key was last - used. The information includes the date and time of last use, along with the - Amazon Web Services service and Region that were specified in the last request - made with that key. - operationId: POST_GetAccessKeyLastUsed - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetAccessKeyLastUsedRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetAccessKeyLastUsedResult: - $ref: '#/components/schemas/GetAccessKeyLastUsedResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: GetAccessKeyLastUsed - /?Action=GetAccountAuthorizationDetails&Version=2010-05-08: - get: - description:Retrieves information about all IAM users, groups, roles, and - policies in your Amazon Web Services account, including their relationships - to one another. Use this operation to obtain a snapshot of the configuration - of IAM permissions (users, groups, roles, and policies) in your account.
-Policies returned by this operation are URL-encoded compliant with
- RFC 3986. You can use a
- URL decoding method to convert the policy back to plain JSON text. For example,
- if you use Java, you can use the decode method of the java.net.URLDecoder
- utility class in the Java SDK. Other languages and SDKs provide similar functionality.
You can optionally filter the results using the Filter
- parameter. You can paginate the results using the MaxItems and
- Marker parameters.
A list of entity types used to filter the results. Only the
- entities that match the types you specify are included in the output. Use
- the value LocalManagedPolicy to include customer managed policies.
The format for this parameter is a comma-separated (if more than one) - list of strings. Each string value in the list must be one of the valid - values listed below.
- in: query - name: Filter - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/EntityType' - - xml: - name: member - type: array - - description:Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- responses:
- '200':
- content:
- text/xml:
- schema:
- properties:
- GetAccountAuthorizationDetailsResult:
- $ref: '#/components/schemas/GetAccountAuthorizationDetailsResponse'
- type: object
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ServiceFailureException'
- description: ServiceFailureException
- x-aws-operation-name: GetAccountAuthorizationDetails
- 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'
- post:
- description: Retrieves information about all IAM users, groups, roles, and - policies in your Amazon Web Services account, including their relationships - to one another. Use this operation to obtain a snapshot of the configuration - of IAM permissions (users, groups, roles, and policies) in your account.
-Policies returned by this operation are URL-encoded compliant with
- RFC 3986. You can use a
- URL decoding method to convert the policy back to plain JSON text. For example,
- if you use Java, you can use the decode method of the java.net.URLDecoder
- utility class in the Java SDK. Other languages and SDKs provide similar functionality.
You can optionally filter the results using the Filter
- parameter. You can paginate the results using the MaxItems and
- Marker parameters.
Retrieves information about IAM entity usage and IAM quotas - in the Amazon Web Services account.
For information about IAM quotas, - see IAM - and STS quotas in the IAM User Guide.
- operationId: GET_GetAccountSummary - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - GetAccountSummaryResult: - $ref: '#/components/schemas/GetAccountSummaryResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetAccountSummary - 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' - post: - description:Retrieves information about IAM entity usage and IAM quotas - in the Amazon Web Services account.
For information about IAM quotas, - see IAM - and STS quotas in the IAM User Guide.
- operationId: POST_GetAccountSummary - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - GetAccountSummaryResult: - $ref: '#/components/schemas/GetAccountSummaryResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetAccountSummary - /?Action=GetContextKeysForCustomPolicy&Version=2010-05-08: - get: - description:Gets a list of all of the context keys referenced in the input - policies. The policies are supplied as a list of one or more strings. To get - the context keys from policies associated with an IAM user, group, or role, - use GetContextKeysForPrincipalPolicy.
Context keys are variables
- maintained by Amazon Web Services and its services that provide details about
- the context of an API query request. Context keys can be evaluated by testing
- against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy
- to understand what key names and values you must supply when you call SimulateCustomPolicy.
- Note that all parameters are shown in unencoded form here for clarity but
- must be URL encoded to be included as a part of a real HTML request.
A list of policies for which you want the list of context - keys referenced in those policies. Each document is specified as a string - containing the complete, valid JSON text of an IAM policy.
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)
Gets a list of all of the context keys referenced in the input - policies. The policies are supplied as a list of one or more strings. To get - the context keys from policies associated with an IAM user, group, or role, - use GetContextKeysForPrincipalPolicy.
Context keys are variables
- maintained by Amazon Web Services and its services that provide details about
- the context of an API query request. Context keys can be evaluated by testing
- against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy
- to understand what key names and values you must supply when you call SimulateCustomPolicy.
- Note that all parameters are shown in unencoded form here for clarity but
- must be URL encoded to be included as a part of a real HTML request.
Gets a list of all of the context keys referenced in all the - IAM policies that are attached to the specified IAM entity. The entity can - be an IAM user, group, or role. If you specify a user, then the request also - includes all of the policies attached to groups that the user is a member - of.
You can optionally include a list of one or more additional policies, - specified as strings. If you want to include only a list of policies - by string, use GetContextKeysForCustomPolicy instead.
Note: - This operation discloses information about the permissions granted to other - users. If you do not want users to see other user's permissions, then consider - allowing them to use GetContextKeysForCustomPolicy instead.
Context - keys are variables maintained by Amazon Web Services and its services that - provide details about the context of an API query request. Context keys can - be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy - to understand what key names and values you must supply when you call SimulatePrincipalPolicy.
- operationId: GET_GetContextKeysForPrincipalPolicy - parameters: - - description:The ARN of a user, group, or role whose policies contain the - context keys that you want listed. If you specify a user, the list includes - context keys that are found in all policies that are attached to the user. - The list also includes all groups that the user is a member of. If you pick - a group or a role, then it includes only those context keys that are found - in policies attached to that entity. Note that all parameters are shown - in unencoded form here for clarity, but must be URL encoded to be included - as a part of a real HTML request.
For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicySourceArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description:An optional list of additional policies for which you want - the list of context keys that are referenced.
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)
Gets a list of all of the context keys referenced in all the - IAM policies that are attached to the specified IAM entity. The entity can - be an IAM user, group, or role. If you specify a user, then the request also - includes all of the policies attached to groups that the user is a member - of.
You can optionally include a list of one or more additional policies, - specified as strings. If you want to include only a list of policies - by string, use GetContextKeysForCustomPolicy instead.
Note: - This operation discloses information about the permissions granted to other - users. If you do not want users to see other user's permissions, then consider - allowing them to use GetContextKeysForCustomPolicy instead.
Context - keys are variables maintained by Amazon Web Services and its services that - provide details about the context of an API query request. Context keys can - be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy - to understand what key names and values you must supply when you call SimulatePrincipalPolicy.
- operationId: POST_GetContextKeysForPrincipalPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetContextKeysForPrincipalPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetContextKeysForPrincipalPolicyResult: - $ref: '#/components/schemas/GetContextKeysForPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GetContextKeysForPrincipalPolicy - /?Action=GetCredentialReport&Version=2010-05-08: - get: - description: ' Retrieves a credential report for the Amazon Web Services account. - For more information about the credential report, see Getting - credential reports in the IAM User Guide.' - operationId: GET_GetCredentialReport - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - GetCredentialReportResult: - $ref: '#/components/schemas/GetCredentialReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/CredentialReportNotPresentException' - description: CredentialReportNotPresentException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/CredentialReportExpiredException' - description: CredentialReportExpiredException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/CredentialReportNotReadyException' - description: CredentialReportNotReadyException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetCredentialReport - 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' - post: - description: ' Retrieves a credential report for the Amazon Web Services account. - For more information about the credential report, see Getting - credential reports in the IAM User Guide.' - operationId: POST_GetCredentialReport - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - GetCredentialReportResult: - $ref: '#/components/schemas/GetCredentialReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/CredentialReportNotPresentException' - description: CredentialReportNotPresentException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/CredentialReportExpiredException' - description: CredentialReportExpiredException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/CredentialReportNotReadyException' - description: CredentialReportNotReadyException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetCredentialReport - /?Action=GetGroup&Version=2010-05-08: - get: - description: ' Returns a list of IAM users that are in the specified IAM group. - You can paginate the results using theMaxItems and Marker
- parameters.'
- operationId: GET_GetGroup
- parameters:
- - description: 'The name of the group.
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: _+=,.@-
' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
MaxItems and Marker
- parameters.'
- operationId: POST_GetGroup
- parameters:
- - description: Pagination limit
- in: query
- name: MaxItems
- required: false
- schema:
- type: string
- - description: Pagination token
- in: query
- name: Marker
- required: false
- schema:
- type: string
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetGroupRequest'
- responses:
- '200':
- content:
- text/xml:
- schema:
- properties:
- GetGroupResult:
- $ref: '#/components/schemas/GetGroupResponse'
- type: object
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/NoSuchEntityException'
- description: NoSuchEntityException
- '481':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ServiceFailureException'
- description: ServiceFailureException
- x-aws-operation-name: GetGroup
- /?Action=GetGroupPolicy&Version=2010-05-08:
- get:
- description: Retrieves the specified inline policy document that is embedded - in the specified IAM group.
Policies returned by this operation
- are URL-encoded compliant with RFC
- 3986. You can use a URL decoding method to convert the policy back to
- plain JSON text. For example, if you use Java, you can use the decode
- method of the java.net.URLDecoder utility class in the Java SDK.
- Other languages and SDKs provide similar functionality.
An - IAM group can also have managed policies attached to it. To retrieve a managed - policy document that is attached to a group, use GetPolicy to determine - the policy's default version, then use GetPolicyVersion to retrieve - the policy document.
For more information about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_GetGroupPolicy - parameters: - - description: 'The name of the group the policy is associated with.
-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: - _+=,.@-
' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name of the policy document to get.
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: _+=,.@-
' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetGroupPolicyResult: - $ref: '#/components/schemas/GetGroupPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetGroupPolicy - 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' - post: - description:Retrieves the specified inline policy document that is embedded - in the specified IAM group.
Policies returned by this operation
- are URL-encoded compliant with RFC
- 3986. You can use a URL decoding method to convert the policy back to
- plain JSON text. For example, if you use Java, you can use the decode
- method of the java.net.URLDecoder utility class in the Java SDK.
- Other languages and SDKs provide similar functionality.
An - IAM group can also have managed policies attached to it. To retrieve a managed - policy document that is attached to a group, use GetPolicy to determine - the policy's default version, then use GetPolicyVersion to retrieve - the policy document.
For more information about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_GetGroupPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetGroupPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetGroupPolicyResult: - $ref: '#/components/schemas/GetGroupPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetGroupPolicy - /?Action=GetInstanceProfile&Version=2010-05-08: - get: - description: ' Retrieves information about the specified instance profile, including - the instance profile''s path, GUID, ARN, and role. For more information about - instance profiles, see About - instance profiles in the IAM User Guide.' - operationId: GET_GetInstanceProfile - parameters: - - description: 'The name of the instance profile to get information about.
-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: - _+=,.@-
' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetInstanceProfileResult: - $ref: '#/components/schemas/GetInstanceProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetInstanceProfile - 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' - post: - description: ' Retrieves information about the specified instance profile, including - the instance profile''s path, GUID, ARN, and role. For more information about - instance profiles, see About - instance profiles in the IAM User Guide.' - operationId: POST_GetInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceProfileRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetInstanceProfileResult: - $ref: '#/components/schemas/GetInstanceProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetInstanceProfile - /?Action=GetLoginProfile&Version=2010-05-08: - get: - description:Retrieves the user name for the specified IAM user. A login
- profile is created when you create a password for the user to access the Amazon
- Web Services Management Console. If the user does not exist or does not have
- a password, the operation returns a 404 (NoSuchEntity) error.
If you create an IAM user with access to the console, the CreateDate
- reflects the date you created the initial password for the user.
If
- you create an IAM user with programmatic access, and then later add a password
- for the user to access the Amazon Web Services Management Console, the CreateDate
- reflects the initial password creation date. A user with programmatic access
- does not have a login profile unless you create a password for the user to
- access the Amazon Web Services Management Console.
The name of the user whose login profile you want to retrieve.
-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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetLoginProfileResult: - $ref: '#/components/schemas/GetLoginProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetLoginProfile - 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' - post: - description:Retrieves the user name for the specified IAM user. A login
- profile is created when you create a password for the user to access the Amazon
- Web Services Management Console. If the user does not exist or does not have
- a password, the operation returns a 404 (NoSuchEntity) error.
If you create an IAM user with access to the console, the CreateDate
- reflects the date you created the initial password for the user.
If
- you create an IAM user with programmatic access, and then later add a password
- for the user to access the Amazon Web Services Management Console, the CreateDate
- reflects the initial password creation date. A user with programmatic access
- does not have a login profile unless you create a password for the user to
- access the Amazon Web Services Management Console.
The Amazon Resource Name (ARN) of the OIDC provider resource - object in IAM to get information for. You can get a list of OIDC provider - resource ARNs by using the ListOpenIDConnectProviders operation.
-For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: OpenIDConnectProviderArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetOpenIDConnectProviderResult: - $ref: '#/components/schemas/GetOpenIDConnectProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetOpenIDConnectProvider - 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' - post: - description: Returns information about the specified OpenID Connect (OIDC) provider - resource object in IAM. - operationId: POST_GetOpenIDConnectProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetOpenIDConnectProviderRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetOpenIDConnectProviderResult: - $ref: '#/components/schemas/GetOpenIDConnectProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetOpenIDConnectProvider - /?Action=GetOrganizationsAccessReport&Version=2010-05-08: - get: - description:Retrieves the service last accessed data report for Organizations
- that was previously generated using the GenerateOrganizationsAccessReport
- operation. This operation retrieves the status of your report job
- and the report contents.
Depending on the parameters that you passed - when you generated the report, the data returned could include different information. - For details, see GenerateOrganizationsAccessReport.
To call - this operation, you must be signed in to the management account in your organization. - SCPs must be enabled for your organization root. You must have permissions - to perform this operation. For more information, see Refining - permissions using service last accessed data in the IAM User Guide.
-For each service that principals in an account (root users, IAM users, - or IAM roles) could access using SCPs, the operation returns details about - the most recent access attempt. If there was no attempt, the service is listed - without details about the most recent attempt to access the service. If the - operation fails, it returns the reason that it failed.
By default, - the list is sorted by service namespace.
- operationId: GET_GetOrganizationsAccessReport - parameters: - - description: The identifier of the request generated by the GenerateOrganizationsAccessReport - operation. - in: query - name: JobId - required: true - schema: - maxLength: 36 - minLength: 36 - type: string - - description:Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: The key that is used to sort the results. If you choose the namespace
- key, the results are returned in alphabetical order. If you choose the time
- key, the results are sorted numerically by the date and time.
- in: query
- name: SortKey
- required: false
- schema:
- enum:
- - SERVICE_NAMESPACE_ASCENDING
- - SERVICE_NAMESPACE_DESCENDING
- - LAST_AUTHENTICATED_TIME_ASCENDING
- - LAST_AUTHENTICATED_TIME_DESCENDING
- type: string
- responses:
- '200':
- content:
- text/xml:
- schema:
- properties:
- GetOrganizationsAccessReportResult:
- $ref: '#/components/schemas/GetOrganizationsAccessReportResponse'
- type: object
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/NoSuchEntityException'
- description: NoSuchEntityException
- x-aws-operation-name: GetOrganizationsAccessReport
- 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'
- post:
- description: Retrieves the service last accessed data report for Organizations
- that was previously generated using the GenerateOrganizationsAccessReport
- operation. This operation retrieves the status of your report job
- and the report contents.
Depending on the parameters that you passed - when you generated the report, the data returned could include different information. - For details, see GenerateOrganizationsAccessReport.
To call - this operation, you must be signed in to the management account in your organization. - SCPs must be enabled for your organization root. You must have permissions - to perform this operation. For more information, see Refining - permissions using service last accessed data in the IAM User Guide.
-For each service that principals in an account (root users, IAM users, - or IAM roles) could access using SCPs, the operation returns details about - the most recent access attempt. If there was no attempt, the service is listed - without details about the most recent attempt to access the service. If the - operation fails, it returns the reason that it failed.
By default, - the list is sorted by service namespace.
- operationId: POST_GetOrganizationsAccessReport - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetOrganizationsAccessReportRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetOrganizationsAccessReportResult: - $ref: '#/components/schemas/GetOrganizationsAccessReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: GetOrganizationsAccessReport - /?Action=GetPolicy&Version=2010-05-08: - get: - description:Retrieves information about the specified managed policy, including - the policy's default version and the total number of IAM users, groups, and - roles to which the policy is attached. To retrieve the list of the specific - users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. - This operation returns metadata about the policy. To retrieve the actual policy - document for a specific version of the policy, use GetPolicyVersion.
-This operation retrieves information about managed policies. To retrieve - information about an inline policy that is embedded with an IAM user, group, - or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
-For more information about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_GetPolicy - parameters: - - description:The Amazon Resource Name (ARN) of the managed policy that - you want information about.
For more information about ARNs, see - Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetPolicyResult: - $ref: '#/components/schemas/GetPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetPolicy - 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' - post: - description:Retrieves information about the specified managed policy, including - the policy's default version and the total number of IAM users, groups, and - roles to which the policy is attached. To retrieve the list of the specific - users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. - This operation returns metadata about the policy. To retrieve the actual policy - document for a specific version of the policy, use GetPolicyVersion.
-This operation retrieves information about managed policies. To retrieve - information about an inline policy that is embedded with an IAM user, group, - or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
-For more information about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_GetPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetPolicyResult: - $ref: '#/components/schemas/GetPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetPolicy - /?Action=GetPolicyVersion&Version=2010-05-08: - get: - description:Retrieves information about the specified version of the specified - managed policy, including the policy document.
Policies returned
- by this operation are URL-encoded compliant with RFC
- 3986. You can use a URL decoding method to convert the policy back to
- plain JSON text. For example, if you use Java, you can use the decode
- method of the java.net.URLDecoder utility class in the Java SDK.
- Other languages and SDKs provide similar functionality.
To - list the available versions for a policy, use ListPolicyVersions.
-This operation retrieves information about managed policies. To retrieve - information about an inline policy that is embedded in a user, group, or role, - use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
-For more information about the types of policies, see Managed - policies and inline policies in the IAM User Guide.
For - more information about managed policy versions, see Versioning - for managed policies in the IAM User Guide.
- operationId: GET_GetPolicyVersion - parameters: - - description:The Amazon Resource Name (ARN) of the managed policy that - you want information about.
For more information about ARNs, see - Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description:Identifies the policy version to retrieve.
This parameter - allows (through its regex pattern) - a string of characters that consists of the lowercase letter 'v' followed - by one or two digits, and optionally followed by a period '.' and a string - of letters and digits.
- in: query - name: VersionId - required: true - schema: - pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetPolicyVersionResult: - $ref: '#/components/schemas/GetPolicyVersionResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetPolicyVersion - 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' - post: - description:Retrieves information about the specified version of the specified - managed policy, including the policy document.
Policies returned
- by this operation are URL-encoded compliant with RFC
- 3986. You can use a URL decoding method to convert the policy back to
- plain JSON text. For example, if you use Java, you can use the decode
- method of the java.net.URLDecoder utility class in the Java SDK.
- Other languages and SDKs provide similar functionality.
To - list the available versions for a policy, use ListPolicyVersions.
-This operation retrieves information about managed policies. To retrieve - information about an inline policy that is embedded in a user, group, or role, - use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.
-For more information about the types of policies, see Managed - policies and inline policies in the IAM User Guide.
For - more information about managed policy versions, see Versioning - for managed policies in the IAM User Guide.
- operationId: POST_GetPolicyVersion - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetPolicyVersionRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetPolicyVersionResult: - $ref: '#/components/schemas/GetPolicyVersionResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetPolicyVersion - /?Action=GetRole&Version=2010-05-08: - get: - description:Retrieves information about the specified role, including the - role's path, GUID, ARN, and the role's trust policy that grants permission - to assume the role. For more information about roles, see Working - with roles.
Policies returned by this operation are URL-encoded
- compliant with RFC 3986.
- You can use a URL decoding method to convert the policy back to plain JSON
- text. For example, if you use Java, you can use the decode method
- of the java.net.URLDecoder utility class in the Java SDK. Other
- languages and SDKs provide similar functionality.
The name of the IAM role to get information about.
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: - _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetRoleResult: - $ref: '#/components/schemas/GetRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetRole - 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' - post: - description:Retrieves information about the specified role, including the - role's path, GUID, ARN, and the role's trust policy that grants permission - to assume the role. For more information about roles, see Working - with roles.
Policies returned by this operation are URL-encoded
- compliant with RFC 3986.
- You can use a URL decoding method to convert the policy back to plain JSON
- text. For example, if you use Java, you can use the decode method
- of the java.net.URLDecoder utility class in the Java SDK. Other
- languages and SDKs provide similar functionality.
Retrieves the specified inline policy document that is embedded - with the specified IAM role.
Policies returned by this operation
- are URL-encoded compliant with RFC
- 3986. You can use a URL decoding method to convert the policy back to
- plain JSON text. For example, if you use Java, you can use the decode
- method of the java.net.URLDecoder utility class in the Java SDK.
- Other languages and SDKs provide similar functionality.
An - IAM role can also have managed policies attached to it. To retrieve a managed - policy document that is attached to a role, use GetPolicy to determine - the policy's default version, then use GetPolicyVersion to retrieve - the policy document.
For more information about policies, see Managed - policies and inline policies in the IAM User Guide.
For - more information about roles, see Using - roles to delegate permissions and federate identities.
- operationId: GET_GetRolePolicy - parameters: - - description: 'The name of the role associated with the policy.
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: - _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name of the policy document to get.
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: _+=,.@-
' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetRolePolicyResult: - $ref: '#/components/schemas/GetRolePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetRolePolicy - 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' - post: - description:Retrieves the specified inline policy document that is embedded - with the specified IAM role.
Policies returned by this operation
- are URL-encoded compliant with RFC
- 3986. You can use a URL decoding method to convert the policy back to
- plain JSON text. For example, if you use Java, you can use the decode
- method of the java.net.URLDecoder utility class in the Java SDK.
- Other languages and SDKs provide similar functionality.
An - IAM role can also have managed policies attached to it. To retrieve a managed - policy document that is attached to a role, use GetPolicy to determine - the policy's default version, then use GetPolicyVersion to retrieve - the policy document.
For more information about policies, see Managed - policies and inline policies in the IAM User Guide.
For - more information about roles, see Using - roles to delegate permissions and federate identities.
- operationId: POST_GetRolePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetRolePolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetRolePolicyResult: - $ref: '#/components/schemas/GetRolePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetRolePolicy - /?Action=GetSAMLProvider&Version=2010-05-08: - get: - description:Returns the SAML provider metadocument that was uploaded when - the IAM SAML provider resource object was created or updated.
This - operation requires Signature - Version 4.
The Amazon Resource Name (ARN) of the SAML provider resource - object in IAM to get information about.
For more information about - ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: SAMLProviderArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetSAMLProviderResult: - $ref: '#/components/schemas/GetSAMLProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetSAMLProvider - 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' - post: - description:Returns the SAML provider metadocument that was uploaded when - the IAM SAML provider resource object was created or updated.
This - operation requires Signature - Version 4.
Retrieves the specified SSH public key, including metadata about - the key.
The SSH public key retrieved by this operation is used only - for authenticating the associated IAM user to an CodeCommit repository. For - more information about using SSH keys to authenticate to an CodeCommit repository, - see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.
- operationId: GET_GetSSHPublicKey - parameters: - - description: 'The name of the IAM user associated with the SSH public key.
-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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The unique identifier for the SSH public key.
This - parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.
- in: query - name: SSHPublicKeyId - required: true - schema: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - - description: Specifies the public key encoding format to use in the response. - To retrieve the public key in ssh-rsa format, useSSH. To retrieve
- the public key in PEM format, use PEM.
- in: query
- name: Encoding
- required: true
- schema:
- enum:
- - SSH
- - PEM
- type: string
- responses:
- '200':
- content:
- text/xml:
- schema:
- properties:
- GetSSHPublicKeyResult:
- $ref: '#/components/schemas/GetSSHPublicKeyResponse'
- type: object
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/NoSuchEntityException'
- description: NoSuchEntityException
- '481':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/UnrecognizedPublicKeyEncodingException'
- description: UnrecognizedPublicKeyEncodingException
- x-aws-operation-name: GetSSHPublicKey
- 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'
- post:
- description: Retrieves the specified SSH public key, including metadata about - the key.
The SSH public key retrieved by this operation is used only - for authenticating the associated IAM user to an CodeCommit repository. For - more information about using SSH keys to authenticate to an CodeCommit repository, - see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.
- operationId: POST_GetSSHPublicKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSSHPublicKeyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetSSHPublicKeyResult: - $ref: '#/components/schemas/GetSSHPublicKeyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnrecognizedPublicKeyEncodingException' - description: UnrecognizedPublicKeyEncodingException - x-aws-operation-name: GetSSHPublicKey - /?Action=GetServerCertificate&Version=2010-05-08: - get: - description:Retrieves information about the specified server certificate - stored in IAM.
For more information about working with server certificates, - see Working - with server certificates in the IAM User Guide. This topic includes - a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.
- operationId: GET_GetServerCertificate - parameters: - - description: 'The name of the server certificate you want to retrieve information - about.
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: - _+=,.@-
' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetServerCertificateResult: - $ref: '#/components/schemas/GetServerCertificateResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetServerCertificate - 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' - post: - description:Retrieves information about the specified server certificate - stored in IAM.
For more information about working with server certificates, - see Working - with server certificates in the IAM User Guide. This topic includes - a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.
- operationId: POST_GetServerCertificate - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetServerCertificateRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetServerCertificateResult: - $ref: '#/components/schemas/GetServerCertificateResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetServerCertificate - /?Action=GetServiceLastAccessedDetails&Version=2010-05-08: - get: - description: "Retrieves a service last accessed report that was created using\
- \ the GenerateServiceLastAccessedDetails operation. You can use\
- \ the JobId parameter in GetServiceLastAccessedDetails\
- \ to retrieve the status of your report job. When the report is complete,\
- \ you can retrieve the generated report. The report includes a list of Amazon\
- \ Web Services services that the resource (user, group, role, or managed policy)\
- \ can access.
Service last accessed data does not use other\ - \ policy types when determining whether a resource could access a service.\ - \ These other policy types include resource-based policies, access control\ - \ lists, Organizations policies, IAM permissions boundaries, and STS assume\ - \ role policies. It only applies permissions policy logic. For more about\ - \ the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For\
- \ each service that the resource could access using permissions policies,\
- \ the operation returns details about the most recent access attempt. If there\
- \ was no attempt, the service is listed without details about the most recent\
- \ attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails\
- \ operation returns the reason that it failed.
The GetServiceLastAccessedDetails\
- \ operation returns a list of services. This list includes the number of entities\
- \ that have attempted to access the service and the date and time of the last\
- \ attempt. It also returns the ARN of the following entity, depending on the\
- \ resource ARN that you used to generate the report:
User\ - \ \u2013 Returns the user ARN that you used to generate the report
Group \u2013 Returns the ARN of the group member (user)\ - \ that last attempted to access the service
Role\ - \ \u2013 Returns the role ARN that you used to generate the report
Policy \u2013 Returns the ARN of the user or role that last\ - \ used the policy to attempt to access the service
By default,\ - \ the list is sorted by service namespace.
If you specified ACTION_LEVEL\
- \ granularity when you generated the report, this operation returns service\
- \ and action last accessed data. This includes the most recent access attempt\
- \ for each tracked action within a service. Otherwise, this operation returns\
- \ only service data.
For more information about service and action\ - \ last accessed data, see Reducing permissions using service last accessed data in the IAM User\ - \ Guide.
" - operationId: GET_GetServiceLastAccessedDetails - parameters: - - description: The ID of the request generated by the GenerateServiceLastAccessedDetails - operation. TheJobId returned by GenerateServiceLastAccessedDetail
- must be used by the same role within a session, or by the same user when
- used to call GetServiceLastAccessedDetail.
- in: query
- name: JobId
- required: true
- schema:
- maxLength: 36
- minLength: 36
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- responses:
- '200':
- content:
- text/xml:
- schema:
- properties:
- GetServiceLastAccessedDetailsResult:
- $ref: '#/components/schemas/GetServiceLastAccessedDetailsResponse'
- type: object
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/NoSuchEntityException'
- description: NoSuchEntityException
- '481':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/InvalidInputException'
- description: InvalidInputException
- x-aws-operation-name: GetServiceLastAccessedDetails
- 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'
- post:
- description: "Retrieves a service last accessed report that was created using\
- \ the GenerateServiceLastAccessedDetails operation. You can use\
- \ the JobId parameter in GetServiceLastAccessedDetails\
- \ to retrieve the status of your report job. When the report is complete,\
- \ you can retrieve the generated report. The report includes a list of Amazon\
- \ Web Services services that the resource (user, group, role, or managed policy)\
- \ can access.
Service last accessed data does not use other\ - \ policy types when determining whether a resource could access a service.\ - \ These other policy types include resource-based policies, access control\ - \ lists, Organizations policies, IAM permissions boundaries, and STS assume\ - \ role policies. It only applies permissions policy logic. For more about\ - \ the evaluation of policy types, see Evaluating policies in the IAM User Guide.
For\
- \ each service that the resource could access using permissions policies,\
- \ the operation returns details about the most recent access attempt. If there\
- \ was no attempt, the service is listed without details about the most recent\
- \ attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails\
- \ operation returns the reason that it failed.
The GetServiceLastAccessedDetails\
- \ operation returns a list of services. This list includes the number of entities\
- \ that have attempted to access the service and the date and time of the last\
- \ attempt. It also returns the ARN of the following entity, depending on the\
- \ resource ARN that you used to generate the report:
User\ - \ \u2013 Returns the user ARN that you used to generate the report
Group \u2013 Returns the ARN of the group member (user)\ - \ that last attempted to access the service
Role\ - \ \u2013 Returns the role ARN that you used to generate the report
Policy \u2013 Returns the ARN of the user or role that last\ - \ used the policy to attempt to access the service
By default,\ - \ the list is sorted by service namespace.
If you specified ACTION_LEVEL\
- \ granularity when you generated the report, this operation returns service\
- \ and action last accessed data. This includes the most recent access attempt\
- \ for each tracked action within a service. Otherwise, this operation returns\
- \ only service data.
For more information about service and action\ - \ last accessed data, see Reducing permissions using service last accessed data in the IAM User\ - \ Guide.
" - operationId: POST_GetServiceLastAccessedDetails - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetServiceLastAccessedDetailsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetServiceLastAccessedDetailsResult: - $ref: '#/components/schemas/GetServiceLastAccessedDetailsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GetServiceLastAccessedDetails - /?Action=GetServiceLastAccessedDetailsWithEntities&Version=2010-05-08: - get: - description: "After you generate a group or policy report using the GenerateServiceLastAccessedDetails\
- \ operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities.\
- \ This operation retrieves the status of your report job and a list of entities\
- \ that could have used group or policy permissions to access the specified\
- \ service.
Group \u2013 For a group report, this\ - \ operation returns a list of users in the group that could have used the\ - \ group\u2019s policies in an attempt to access the service.
Policy \u2013 For a policy report, this operation returns a list\ - \ of entities (users or roles) that could have used the policy in an attempt\ - \ to access the service.
You can also use this operation\ - \ for user or role reports to retrieve details about those entities.
If\
- \ the operation fails, the GetServiceLastAccessedDetailsWithEntities\
- \ operation returns the reason that it failed.
By default, the list\ - \ of associated entities is sorted by date, with the most recent access listed\ - \ first.
" - operationId: GET_GetServiceLastAccessedDetailsWithEntities - parameters: - - description: The ID of the request generated by theGenerateServiceLastAccessedDetails
- operation.
- in: query
- name: JobId
- required: true
- schema:
- maxLength: 36
- minLength: 36
- type: string
- - description: "The service namespace for an Amazon Web Services service.\ - \ Provide the service namespace to learn when the IAM entity last attempted\ - \ to access the specified service.
To learn the service namespace\
- \ for a service, see Actions, resources, and condition keys for Amazon Web Services services\
- \ in the IAM User Guide. Choose the name of the service to view details\
- \ for that service. In the first paragraph, find the service prefix. For\
- \ example, (service prefix: a4b). For more information about\
- \ service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\
- \ General Reference.
Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- responses:
- '200':
- content:
- text/xml:
- schema:
- properties:
- GetServiceLastAccessedDetailsWithEntitiesResult:
- $ref: '#/components/schemas/GetServiceLastAccessedDetailsWithEntitiesResponse'
- type: object
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/NoSuchEntityException'
- description: NoSuchEntityException
- '481':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/InvalidInputException'
- description: InvalidInputException
- x-aws-operation-name: GetServiceLastAccessedDetailsWithEntities
- 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'
- post:
- description: "After you generate a group or policy report using the GenerateServiceLastAccessedDetails\
- \ operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities.\
- \ This operation retrieves the status of your report job and a list of entities\
- \ that could have used group or policy permissions to access the specified\
- \ service.
Group \u2013 For a group report, this\ - \ operation returns a list of users in the group that could have used the\ - \ group\u2019s policies in an attempt to access the service.
Policy \u2013 For a policy report, this operation returns a list\ - \ of entities (users or roles) that could have used the policy in an attempt\ - \ to access the service.
You can also use this operation\ - \ for user or role reports to retrieve details about those entities.
If\
- \ the operation fails, the GetServiceLastAccessedDetailsWithEntities\
- \ operation returns the reason that it failed.
By default, the list\ - \ of associated entities is sorted by date, with the most recent access listed\ - \ first.
" - operationId: POST_GetServiceLastAccessedDetailsWithEntities - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetServiceLastAccessedDetailsWithEntitiesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetServiceLastAccessedDetailsWithEntitiesResult: - $ref: '#/components/schemas/GetServiceLastAccessedDetailsWithEntitiesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GetServiceLastAccessedDetailsWithEntities - /?Action=GetServiceLinkedRoleDeletionStatus&Version=2010-05-08: - get: - description: Retrieves the status of your service-linked role deletion. After - you use DeleteServiceLinkedRole to submit a service-linked role for - deletion, you can use theDeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus
- to check the status of the deletion. If the deletion fails, this operation
- returns the reason that it failed, if that information is returned by the
- service.
- operationId: GET_GetServiceLinkedRoleDeletionStatus
- parameters:
- - description: The deletion task identifier. This identifier is returned by
- the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
- in: query
- name: DeletionTaskId
- required: true
- schema:
- maxLength: 1000
- minLength: 1
- type: string
- responses:
- '200':
- content:
- text/xml:
- schema:
- properties:
- GetServiceLinkedRoleDeletionStatusResult:
- $ref: '#/components/schemas/GetServiceLinkedRoleDeletionStatusResponse'
- type: object
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/NoSuchEntityException'
- description: NoSuchEntityException
- '481':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/InvalidInputException'
- description: InvalidInputException
- '482':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ServiceFailureException'
- description: ServiceFailureException
- x-aws-operation-name: GetServiceLinkedRoleDeletionStatus
- 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'
- post:
- description: Retrieves the status of your service-linked role deletion. After
- you use DeleteServiceLinkedRole to submit a service-linked role for
- deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus
- to check the status of the deletion. If the deletion fails, this operation
- returns the reason that it failed, if that information is returned by the
- service.
- operationId: POST_GetServiceLinkedRoleDeletionStatus
- parameters: []
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/GetServiceLinkedRoleDeletionStatusRequest'
- responses:
- '200':
- content:
- text/xml:
- schema:
- properties:
- GetServiceLinkedRoleDeletionStatusResult:
- $ref: '#/components/schemas/GetServiceLinkedRoleDeletionStatusResponse'
- type: object
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/NoSuchEntityException'
- description: NoSuchEntityException
- '481':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/InvalidInputException'
- description: InvalidInputException
- '482':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ServiceFailureException'
- description: ServiceFailureException
- x-aws-operation-name: GetServiceLinkedRoleDeletionStatus
- /?Action=GetUser&Version=2010-05-08:
- get:
- description: Retrieves information about the specified IAM user, including - the user's creation date, path, unique ID, and ARN.
If you do not specify - a user name, IAM determines the user name implicitly based on the Amazon Web - Services access key ID used to sign the request to this operation.
- operationId: GET_GetUser - parameters: - - description: 'The name of the user to get information about.
This - parameter is optional. If it is not included, it defaults to the user making - the request. 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: - _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetUserResult: - $ref: '#/components/schemas/GetUserResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetUser - 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' - post: - description:Retrieves information about the specified IAM user, including - the user's creation date, path, unique ID, and ARN.
If you do not specify - a user name, IAM determines the user name implicitly based on the Amazon Web - Services access key ID used to sign the request to this operation.
- operationId: POST_GetUser - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetUserRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetUserResult: - $ref: '#/components/schemas/GetUserResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetUser - /?Action=GetUserPolicy&Version=2010-05-08: - get: - description:Retrieves the specified inline policy document that is embedded - in the specified IAM user.
Policies returned by this operation
- are URL-encoded compliant with RFC
- 3986. You can use a URL decoding method to convert the policy back to
- plain JSON text. For example, if you use Java, you can use the decode
- method of the java.net.URLDecoder utility class in the Java SDK.
- Other languages and SDKs provide similar functionality.
An - IAM user can also have managed policies attached to it. To retrieve a managed - policy document that is attached to a user, use GetPolicy to determine - the policy's default version. Then use GetPolicyVersion to retrieve - the policy document.
For more information about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_GetUserPolicy - parameters: - - description: 'The name of the user who the policy is associated with.
-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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name of the policy document to get.
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: _+=,.@-
' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetUserPolicyResult: - $ref: '#/components/schemas/GetUserPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetUserPolicy - 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' - post: - description:Retrieves the specified inline policy document that is embedded - in the specified IAM user.
Policies returned by this operation
- are URL-encoded compliant with RFC
- 3986. You can use a URL decoding method to convert the policy back to
- plain JSON text. For example, if you use Java, you can use the decode
- method of the java.net.URLDecoder utility class in the Java SDK.
- Other languages and SDKs provide similar functionality.
An - IAM user can also have managed policies attached to it. To retrieve a managed - policy document that is attached to a user, use GetPolicy to determine - the policy's default version. Then use GetPolicyVersion to retrieve - the policy document.
For more information about policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_GetUserPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetUserPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetUserPolicyResult: - $ref: '#/components/schemas/GetUserPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetUserPolicy - /?Action=ListAccessKeys&Version=2010-05-08: - get: - description:Returns information about the access key IDs associated with - the specified IAM user. If there is none, the operation returns an empty list.
-Although each user is limited to a small number of keys, you can still
- paginate the results using the MaxItems and Marker
- parameters.
If the UserName field is not specified, the
- user name is determined implicitly based on the Amazon Web Services access
- key ID used to sign the request. This operation works for access keys under
- the Amazon Web Services account. Consequently, you can use this operation
- to manage Amazon Web Services account root user credentials even if the Amazon
- Web Services account has no associated users.
To ensure the - security of your Amazon Web Services account, the secret access key is accessible - only during key and user creation.
The name of the user.
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: _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Returns information about the access key IDs associated with - the specified IAM user. If there is none, the operation returns an empty list.
-Although each user is limited to a small number of keys, you can still
- paginate the results using the MaxItems and Marker
- parameters.
If the UserName field is not specified, the
- user name is determined implicitly based on the Amazon Web Services access
- key ID used to sign the request. This operation works for access keys under
- the Amazon Web Services account. Consequently, you can use this operation
- to manage Amazon Web Services account root user credentials even if the Amazon
- Web Services account has no associated users.
To ensure the - security of your Amazon Web Services account, the secret access key is accessible - only during key and user creation.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists all managed policies that are attached to the specified - IAM group.
An IAM group can also have inline policies embedded with - it. To list the inline policies for a group, use ListGroupPolicies. - For information about policies, see Managed - policies and inline policies in the IAM User Guide.
You
- can paginate the results using the MaxItems and Marker
- parameters. You can use the PathPrefix parameter to limit the
- list of policies to only those matching the specified path prefix. If there
- are no policies attached to the specified group (or none that match the specified
- path prefix), the operation returns an empty list.
The name (friendly name, not ARN) of the group to list attached - policies for.
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: - _+=,.@-
' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies.
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.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists all managed policies that are attached to the specified - IAM group.
An IAM group can also have inline policies embedded with - it. To list the inline policies for a group, use ListGroupPolicies. - For information about policies, see Managed - policies and inline policies in the IAM User Guide.
You
- can paginate the results using the MaxItems and Marker
- parameters. You can use the PathPrefix parameter to limit the
- list of policies to only those matching the specified path prefix. If there
- are no policies attached to the specified group (or none that match the specified
- path prefix), the operation returns an empty list.
Lists all managed policies that are attached to the specified - IAM role.
An IAM role can also have inline policies embedded with it. - To list the inline policies for a role, use ListRolePolicies. For information - about policies, see Managed - policies and inline policies in the IAM User Guide.
You
- can paginate the results using the MaxItems and Marker
- parameters. You can use the PathPrefix parameter to limit the
- list of policies to only those matching the specified path prefix. If there
- are no policies attached to the specified role (or none that match the specified
- path prefix), the operation returns an empty list.
The name (friendly name, not ARN) of the role to list attached - policies for.
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: - _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies.
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.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists all managed policies that are attached to the specified - IAM role.
An IAM role can also have inline policies embedded with it. - To list the inline policies for a role, use ListRolePolicies. For information - about policies, see Managed - policies and inline policies in the IAM User Guide.
You
- can paginate the results using the MaxItems and Marker
- parameters. You can use the PathPrefix parameter to limit the
- list of policies to only those matching the specified path prefix. If there
- are no policies attached to the specified role (or none that match the specified
- path prefix), the operation returns an empty list.
Lists all managed policies that are attached to the specified - IAM user.
An IAM user can also have inline policies embedded with it. - To list the inline policies for a user, use ListUserPolicies. For information - about policies, see Managed - policies and inline policies in the IAM User Guide.
You
- can paginate the results using the MaxItems and Marker
- parameters. You can use the PathPrefix parameter to limit the
- list of policies to only those matching the specified path prefix. If there
- are no policies attached to the specified group (or none that match the specified
- path prefix), the operation returns an empty list.
The name (friendly name, not ARN) of the user to list attached - policies for.
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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies.
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.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists all managed policies that are attached to the specified - IAM user.
An IAM user can also have inline policies embedded with it. - To list the inline policies for a user, use ListUserPolicies. For information - about policies, see Managed - policies and inline policies in the IAM User Guide.
You
- can paginate the results using the MaxItems and Marker
- parameters. You can use the PathPrefix parameter to limit the
- list of policies to only those matching the specified path prefix. If there
- are no policies attached to the specified group (or none that match the specified
- path prefix), the operation returns an empty list.
Lists all IAM users, groups, and roles that the specified managed - policy is attached to.
You can use the optional EntityFilter
- parameter to limit the results to a particular type of entity (users, groups,
- or roles). For example, to list only the roles that are attached to the specified
- policy, set EntityFilter to Role.
You can
- paginate the results using the MaxItems and Marker
- parameters.
The Amazon Resource Name (ARN) of the IAM policy for which - you want the versions.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description:The entity type to use for filtering the results.
For
- example, when EntityFilter is Role, only the roles
- that are attached to the specified policy are returned. This parameter is
- optional. If it is not included, all attached entities (users, groups, and
- roles) are returned. The argument for this parameter must be one of the
- valid values listed below.
The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all entities.
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 policy usage method to use for filtering the results.
\ - \To list only permissions policies, set\_PolicyUsageFilter\_\
- to\_PermissionsPolicy. To list only the policies used to set\
- \ permissions boundaries, set\_the value to\_PermissionsBoundary.
This parameter is optional. If it is not included, all policies are\ - \ returned.
" - in: query - name: PolicyUsageFilter - required: false - schema: - description:The policy usage type that indicates whether the policy - is used as a permissions policy or as the permissions boundary for an - entity.
For more information about permissions boundaries, see - Permissions - boundaries for IAM identities in the IAM User Guide.
- enum: - - PermissionsPolicy - - PermissionsBoundary - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists all IAM users, groups, and roles that the specified managed - policy is attached to.
You can use the optional EntityFilter
- parameter to limit the results to a particular type of entity (users, groups,
- or roles). For example, to list only the roles that are attached to the specified
- policy, set EntityFilter to Role.
You can
- paginate the results using the MaxItems and Marker
- parameters.
Lists the names of the inline policies that are embedded in - the specified IAM group.
An IAM group can also have managed policies - attached to it. To list the managed policies that are attached to a group, - use ListAttachedGroupPolicies. For more information about policies, - see Managed - policies and inline policies in the IAM User Guide.
You
- can paginate the results using the MaxItems and Marker
- parameters. If there are no inline policies embedded with the specified group,
- the operation returns an empty list.
The name of the group to list policies for.
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: _+=,.@-
' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the names of the inline policies that are embedded in - the specified IAM group.
An IAM group can also have managed policies - attached to it. To list the managed policies that are attached to a group, - use ListAttachedGroupPolicies. For more information about policies, - see Managed - policies and inline policies in the IAM User Guide.
You
- can paginate the results using the MaxItems and Marker
- parameters. If there are no inline policies embedded with the specified group,
- the operation returns an empty list.
Lists the IAM groups that have the specified path prefix.
- You can paginate the results using the MaxItems and Marker
- parameters.
The path prefix for filtering the results. For example, the
- prefix /division_abc/subdivision_xyz/ gets all groups whose
- path starts with /division_abc/subdivision_xyz/.
This
- parameter is optional. If it is not included, it defaults to a slash (/),
- listing all groups. 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.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the IAM groups that have the specified path prefix.
- You can paginate the results using the MaxItems and Marker
- parameters.
Lists the IAM groups that the specified IAM user belongs to.
-You can paginate the results using the MaxItems and Marker
- parameters.
The name of the user to list groups for.
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: _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the IAM groups that the specified IAM user belongs to.
-You can paginate the results using the MaxItems and Marker
- parameters.
The name of the IAM instance profile whose tags you want - to see.
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: - _+=,.@-
' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the instance profiles that have the specified path prefix. - If there are none, the operation returns an empty list. For more information - about instance profiles, see About - instance profiles.
IAM resource-listing operations return - a subset of the available attributes for the resource. For example, this operation - does not return tags, even though they are an attribute of the returned object. - To view all of the information for an instance profile, see GetInstanceProfile.
-You can paginate the results using the MaxItems and
- Marker parameters.
The path prefix for filtering the results. For example, the
- prefix /application_abc/component_xyz/ gets all instance profiles
- whose path starts with /application_abc/component_xyz/.
This parameter is optional. If it is not included, it defaults to a slash
- (/), listing all instance profiles. 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.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the instance profiles that have the specified path prefix. - If there are none, the operation returns an empty list. For more information - about instance profiles, see About - instance profiles.
IAM resource-listing operations return - a subset of the available attributes for the resource. For example, this operation - does not return tags, even though they are an attribute of the returned object. - To view all of the information for an instance profile, see GetInstanceProfile.
-You can paginate the results using the MaxItems and
- Marker parameters.
Lists the instance profiles that have the specified associated - IAM role. If there are none, the operation returns an empty list. For more - information about instance profiles, go to About - instance profiles.
You can paginate the results using the MaxItems
- and Marker parameters.
The name of the role to list instance profiles for.
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: - _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the instance profiles that have the specified associated - IAM role. If there are none, the operation returns an empty list. For more - information about instance profiles, go to About - instance profiles.
You can paginate the results using the MaxItems
- and Marker parameters.
The unique identifier for the IAM virtual MFA device whose - tags you want to see. For virtual MFA devices, the serial number is the - same as the ARN.
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: - _+=,.@-
' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the MFA devices for an IAM user. If the request includes - a IAM user name, then this operation lists all the MFA devices associated - with the specified user. If you do not specify a user name, IAM determines - the user name implicitly based on the Amazon Web Services access key ID signing - the request for this operation.
You can paginate the results using
- the MaxItems and Marker parameters.
The name of the user whose MFA devices you want to list.
-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: - _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the MFA devices for an IAM user. If the request includes - a IAM user name, then this operation lists all the MFA devices associated - with the specified user. If you do not specify a user name, IAM determines - the user name implicitly based on the Amazon Web Services access key ID signing - the request for this operation.
You can paginate the results using
- the MaxItems and Marker parameters.
Lists the tags that are attached to the specified OpenID Connect - (OIDC)-compatible identity provider. The returned list of tags is sorted by - tag key. For more information, see About - web identity federation.
For more information about tagging, see - Tagging - IAM resources in the IAM User Guide.
- operationId: GET_ListOpenIDConnectProviderTags - parameters: - - description: 'The ARN of the OpenID Connect (OIDC) identity provider whose - tags you want to see.
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: - _+=,.@-
' - in: query - name: OpenIDConnectProviderArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the tags that are attached to the specified OpenID Connect - (OIDC)-compatible identity provider. The returned list of tags is sorted by - tag key. For more information, see About - web identity federation.
For more information about tagging, see - Tagging - IAM resources in the IAM User Guide.
- operationId: POST_ListOpenIDConnectProviderTags - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListOpenIDConnectProviderTagsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListOpenIDConnectProviderTagsResult: - $ref: '#/components/schemas/ListOpenIDConnectProviderTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: ListOpenIDConnectProviderTags - /?Action=ListOpenIDConnectProviders&Version=2010-05-08: - get: - description:Lists information about the IAM OpenID Connect (OIDC) provider - resource objects defined in the Amazon Web Services account.
IAM - resource-listing operations return a subset of the available attributes for - the resource. For example, this operation does not return tags, even though - they are an attribute of the returned object. To view all of the information - for an OIDC provider, see GetOpenIDConnectProvider.
Lists information about the IAM OpenID Connect (OIDC) provider - resource objects defined in the Amazon Web Services account.
IAM - resource-listing operations return a subset of the available attributes for - the resource. For example, this operation does not return tags, even though - they are an attribute of the returned object. To view all of the information - for an OIDC provider, see GetOpenIDConnectProvider.
Lists all the managed policies that are available in your Amazon - Web Services account, including your own customer-defined managed policies - and all Amazon Web Services managed policies.
You can filter the list
- of policies that is returned using the optional OnlyAttached,
- Scope, and PathPrefix parameters. For example, to
- list only the customer managed policies in your Amazon Web Services account,
- set Scope to Local. To list only Amazon Web Services
- managed policies, set Scope to AWS.
You can
- paginate the results using the MaxItems and Marker
- parameters.
For more information about managed policies, see Managed - policies and inline policies in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes - for the resource. For example, this operation does not return tags, even though - they are an attribute of the returned object. To view all of the information - for a customer manged policy, see GetPolicy.
The scope to use for filtering the results.
To list
- only Amazon Web Services managed policies, set Scope to AWS.
- To list only the customer managed policies in your Amazon Web Services account,
- set Scope to Local.
This parameter is optional.
- If it is not included, or if it is set to All, all policies
- are returned.
A flag to filter the results to only the attached policies.
-When OnlyAttached is true, the returned list
- contains only the policies that are attached to an IAM user, group, or role.
- When OnlyAttached is false, or when the parameter
- is not included, all policies are returned.
\u0021)
- through the DEL character (\u007F), including most punctuation
- characters, digits, and upper and lowercased letters.
- in: query
- name: PathPrefix
- required: false
- schema:
- maxLength: 512
- minLength: 1
- pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/
- type: string
- - description: "The policy usage method to use for filtering the results.
\ - \To list only permissions policies, set\_PolicyUsageFilter\_\
- to\_PermissionsPolicy. To list only the policies used to set\
- \ permissions boundaries, set\_the value to\_PermissionsBoundary.
This parameter is optional. If it is not included, all policies are\ - \ returned.
" - in: query - name: PolicyUsageFilter - required: false - schema: - description:The policy usage type that indicates whether the policy - is used as a permissions policy or as the permissions boundary for an - entity.
For more information about permissions boundaries, see - Permissions - boundaries for IAM identities in the IAM User Guide.
- enum: - - PermissionsPolicy - - PermissionsBoundary - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists all the managed policies that are available in your Amazon - Web Services account, including your own customer-defined managed policies - and all Amazon Web Services managed policies.
You can filter the list
- of policies that is returned using the optional OnlyAttached,
- Scope, and PathPrefix parameters. For example, to
- list only the customer managed policies in your Amazon Web Services account,
- set Scope to Local. To list only Amazon Web Services
- managed policies, set Scope to AWS.
You can
- paginate the results using the MaxItems and Marker
- parameters.
For more information about managed policies, see Managed - policies and inline policies in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes - for the resource. For example, this operation does not return tags, even though - they are an attribute of the returned object. To view all of the information - for a customer manged policy, see GetPolicy.
Retrieves a list of policies that the IAM identity (user, group,\ - \ or role) can use to access each specified service.
This operation\ - \ does not use other policy types when determining whether a resource could\ - \ access a service. These other policy types include resource-based policies,\ - \ access control lists, Organizations policies, IAM permissions boundaries,\ - \ and STS assume role policies. It only applies permissions policy logic.\ - \ For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
The\ - \ list of policies returned by the operation depends on the ARN of the identity\ - \ that you provide.
User \u2013 The list of policies\ - \ includes the managed and inline policies that are attached to the user directly.\ - \ The list also includes any additional managed and inline policies that are\ - \ attached to the group to which the user belongs.
Group\ - \ \u2013 The list of policies includes only the managed and inline policies\ - \ that are attached to the group directly. Policies that are attached to the\ - \ group\u2019s user are not included.
Role \u2013\ - \ The list of policies includes only the managed and inline policies that\ - \ are attached to the role.
For each managed policy, this\
- \ operation returns the ARN and policy name. For each inline policy, it returns\
- \ the policy name and the entity to which it is attached. Inline policies\
- \ do not have an ARN. For more information about these policy types, see
Policies that are attached to users and roles as permissions boundaries\ - \ are not returned. To view which managed policy is currently used to set\ - \ the permissions boundary for a user or role, use the GetUser or GetRole\ - \ operations.
" - operationId: GET_ListPoliciesGrantingServiceAccess - parameters: - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: The ARN of the IAM identity (user, group, or role) whose policies
- you want to list.
- in: query
- name: Arn
- required: true
- schema:
- 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description: "The service namespace for the Amazon Web Services services\ - \ whose policies you want to list.
To learn the service namespace\
- \ for a service, see Actions, resources, and condition keys for Amazon Web Services services\
- \ in the IAM User Guide. Choose the name of the service to view details\
- \ for that service. In the first paragraph, find the service prefix. For\
- \ example, (service prefix: a4b). For more information about\
- \ service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\
- \ General Reference.
Retrieves a list of policies that the IAM identity (user, group,\ - \ or role) can use to access each specified service.
This operation\ - \ does not use other policy types when determining whether a resource could\ - \ access a service. These other policy types include resource-based policies,\ - \ access control lists, Organizations policies, IAM permissions boundaries,\ - \ and STS assume role policies. It only applies permissions policy logic.\ - \ For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.
The\ - \ list of policies returned by the operation depends on the ARN of the identity\ - \ that you provide.
User \u2013 The list of policies\ - \ includes the managed and inline policies that are attached to the user directly.\ - \ The list also includes any additional managed and inline policies that are\ - \ attached to the group to which the user belongs.
Group\ - \ \u2013 The list of policies includes only the managed and inline policies\ - \ that are attached to the group directly. Policies that are attached to the\ - \ group\u2019s user are not included.
Role \u2013\ - \ The list of policies includes only the managed and inline policies that\ - \ are attached to the role.
For each managed policy, this\
- \ operation returns the ARN and policy name. For each inline policy, it returns\
- \ the policy name and the entity to which it is attached. Inline policies\
- \ do not have an ARN. For more information about these policy types, see
Policies that are attached to users and roles as permissions boundaries\ - \ are not returned. To view which managed policy is currently used to set\ - \ the permissions boundary for a user or role, use the GetUser or GetRole\ - \ operations.
" - operationId: POST_ListPoliciesGrantingServiceAccess - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListPoliciesGrantingServiceAccessRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListPoliciesGrantingServiceAccessResult: - $ref: '#/components/schemas/ListPoliciesGrantingServiceAccessResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: ListPoliciesGrantingServiceAccess - /?Action=ListPolicyTags&Version=2010-05-08: - get: - description: Lists the tags that are attached to the specified IAM customer - managed policy. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_ListPolicyTags - parameters: - - description: 'The ARN of the IAM customer managed policy whose tags you - want to see.
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: - _+=,.@-
' - in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists information about the versions of the specified managed - policy, including the version that is currently set as the policy's default - version.
For more information about managed policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_ListPolicyVersions - parameters: - - description:The Amazon Resource Name (ARN) of the IAM policy for which - you want the versions.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists information about the versions of the specified managed - policy, including the version that is currently set as the policy's default - version.
For more information about managed policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_ListPolicyVersions - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListPolicyVersionsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListPolicyVersionsResult: - $ref: '#/components/schemas/ListPolicyVersionsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListPolicyVersions - /?Action=ListRolePolicies&Version=2010-05-08: - get: - description:Lists the names of the inline policies that are embedded in - the specified IAM role.
An IAM role can also have managed policies - attached to it. To list the managed policies that are attached to a role, - use ListAttachedRolePolicies. For more information about policies, - see Managed - policies and inline policies in the IAM User Guide.
You
- can paginate the results using the MaxItems and Marker
- parameters. If there are no inline policies embedded with the specified role,
- the operation returns an empty list.
The name of the role to list policies for.
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: _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the names of the inline policies that are embedded in - the specified IAM role.
An IAM role can also have managed policies - attached to it. To list the managed policies that are attached to a role, - use ListAttachedRolePolicies. For more information about policies, - see Managed - policies and inline policies in the IAM User Guide.
You
- can paginate the results using the MaxItems and Marker
- parameters. If there are no inline policies embedded with the specified role,
- the operation returns an empty list.
The name of the IAM role for which you want to see the list - of tags.
This parameter accepts (through its regex - pattern) a string of characters that consist of upper and lowercase - alphanumeric characters with no spaces. You can also include any of the - following characters: _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the IAM roles that have the specified path prefix. If - there are none, the operation returns an empty list. For more information - about roles, see Working - with roles.
IAM resource-listing operations return a subset - of the available attributes for the resource. For example, this operation - does not return tags, even though they are an attribute of the returned object. - To view all of the information for a role, see GetRole.
You can paginate the results using the MaxItems and Marker
- parameters.
The path prefix for filtering the results. For example, the
- prefix /application_abc/component_xyz/ gets all roles whose
- path starts with /application_abc/component_xyz/.
This
- parameter is optional. If it is not included, it defaults to a slash (/),
- listing all roles. 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.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the IAM roles that have the specified path prefix. If - there are none, the operation returns an empty list. For more information - about roles, see Working - with roles.
IAM resource-listing operations return a subset - of the available attributes for the resource. For example, this operation - does not return tags, even though they are an attribute of the returned object. - To view all of the information for a role, see GetRole.
You can paginate the results using the MaxItems and Marker
- parameters.
Lists the tags that are attached to the specified Security Assertion - Markup Language (SAML) identity provider. The returned list of tags is sorted - by tag key. For more information, see About - SAML 2.0-based federation.
For more information about tagging, - see Tagging - IAM resources in the IAM User Guide.
- operationId: GET_ListSAMLProviderTags - parameters: - - description: 'The ARN of the Security Assertion Markup Language (SAML) - identity provider whose tags you want to see.
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: _+=,.@-
' - in: query - name: SAMLProviderArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the tags that are attached to the specified Security Assertion - Markup Language (SAML) identity provider. The returned list of tags is sorted - by tag key. For more information, see About - SAML 2.0-based federation.
For more information about tagging, - see Tagging - IAM resources in the IAM User Guide.
- operationId: POST_ListSAMLProviderTags - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListSAMLProviderTagsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListSAMLProviderTagsResult: - $ref: '#/components/schemas/ListSAMLProviderTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: ListSAMLProviderTags - /?Action=ListSAMLProviders&Version=2010-05-08: - get: - description:Lists the SAML provider resource objects defined in IAM in the - account. IAM resource-listing operations return a subset of the available - attributes for the resource. For example, this operation does not return tags, - even though they are an attribute of the returned object. To view all of the - information for a SAML provider, see GetSAMLProvider.
This operation requires Signature - Version 4.
Lists the SAML provider resource objects defined in IAM in the - account. IAM resource-listing operations return a subset of the available - attributes for the resource. For example, this operation does not return tags, - even though they are an attribute of the returned object. To view all of the - information for a SAML provider, see GetSAMLProvider.
This operation requires Signature - Version 4.
Returns information about the SSH public keys associated with - the specified IAM user. If none exists, the operation returns an empty list.
-The SSH public keys returned by this operation are used only for authenticating - the IAM user to an CodeCommit repository. For more information about using - SSH keys to authenticate to an CodeCommit repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.
-Although each user is limited to a small number of keys, you can still
- paginate the results using the MaxItems and Marker
- parameters.
The name of the IAM user to list SSH public keys for. If
- none is specified, the UserName field is determined implicitly
- based on the Amazon Web Services access key used to sign the request.
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: - _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Returns information about the SSH public keys associated with - the specified IAM user. If none exists, the operation returns an empty list.
-The SSH public keys returned by this operation are used only for authenticating - the IAM user to an CodeCommit repository. For more information about using - SSH keys to authenticate to an CodeCommit repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.
-Although each user is limited to a small number of keys, you can still
- paginate the results using the MaxItems and Marker
- parameters.
Lists the tags that are attached to the specified IAM server - certificate. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide.
For certificates - in a Region supported by Certificate Manager (ACM), we recommend that you - don't use IAM server certificates. Instead, use ACM to provision, manage, - and deploy your server certificates. For more information about IAM server - certificates, Working - with server certificates in the IAM User Guide.
The name of the IAM server certificate whose tags you want - to see.
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: - _+=,.@-
' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the tags that are attached to the specified IAM server - certificate. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide.
For certificates - in a Region supported by Certificate Manager (ACM), we recommend that you - don't use IAM server certificates. Instead, use ACM to provision, manage, - and deploy your server certificates. For more information about IAM server - certificates, Working - with server certificates in the IAM User Guide.
Lists the server certificates stored in IAM that have the specified - path prefix. If none exist, the operation returns an empty list.
You
- can paginate the results using the MaxItems and Marker
- parameters.
For more information about working with server certificates, - see Working - with server certificates in the IAM User Guide. This topic also - includes a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.
IAM resource-listing operations return - a subset of the available attributes for the resource. For example, this operation - does not return tags, even though they are an attribute of the returned object. - To view all of the information for a servercertificate, see GetServerCertificate.
- The path prefix for filtering the results. For example:
- /company/servercerts would get all server certificates for
- which the path starts with /company/servercerts.
This
- parameter is optional. If it is not included, it defaults to a slash (/),
- listing all server certificates. 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.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the server certificates stored in IAM that have the specified - path prefix. If none exist, the operation returns an empty list.
You
- can paginate the results using the MaxItems and Marker
- parameters.
For more information about working with server certificates, - see Working - with server certificates in the IAM User Guide. This topic also - includes a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.
IAM resource-listing operations return - a subset of the available attributes for the resource. For example, this operation - does not return tags, even though they are an attribute of the returned object. - To view all of the information for a servercertificate, see GetServerCertificate.
-The name of the user whose service-specific credentials you - want information about. If this value is not specified, then the operation - assumes the user whose credentials are used to call the operation.
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: - _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Filters the returned results to only those for the specified - Amazon Web Services service. If not specified, then Amazon Web Services - returns service-specific credentials for all services. - in: query - name: ServiceName - required: false - schema: - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - ListServiceSpecificCredentialsResult: - $ref: '#/components/schemas/ListServiceSpecificCredentialsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceNotSupportedException' - description: ServiceNotSupportedException - x-aws-operation-name: ListServiceSpecificCredentials - 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' - post: - description: Returns information about the service-specific credentials associated - with the specified IAM user. If none exists, the operation returns an empty - list. The service-specific credentials returned by this operation are used - only for authenticating the IAM user to a specific service. For more information - about using service-specific credentials to authenticate to an Amazon Web - Services service, see Set - up service-specific credentials in the CodeCommit User Guide. - operationId: POST_ListServiceSpecificCredentials - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListServiceSpecificCredentialsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListServiceSpecificCredentialsResult: - $ref: '#/components/schemas/ListServiceSpecificCredentialsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceNotSupportedException' - description: ServiceNotSupportedException - x-aws-operation-name: ListServiceSpecificCredentials - /?Action=ListSigningCertificates&Version=2010-05-08: - get: - description:Returns information about the signing certificates associated - with the specified IAM user. If none exists, the operation returns an empty - list.
Although each user is limited to a small number of signing certificates,
- you can still paginate the results using the MaxItems and Marker
- parameters.
If the UserName field is not specified, the
- user name is determined implicitly based on the Amazon Web Services access
- key ID used to sign the request for this operation. This operation works for
- access keys under the Amazon Web Services account. Consequently, you can use
- this operation to manage Amazon Web Services account root user credentials
- even if the Amazon Web Services account has no associated users.
The name of the IAM user whose signing certificates you want - to examine.
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: - _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Returns information about the signing certificates associated - with the specified IAM user. If none exists, the operation returns an empty - list.
Although each user is limited to a small number of signing certificates,
- you can still paginate the results using the MaxItems and Marker
- parameters.
If the UserName field is not specified, the
- user name is determined implicitly based on the Amazon Web Services access
- key ID used to sign the request for this operation. This operation works for
- access keys under the Amazon Web Services account. Consequently, you can use
- this operation to manage Amazon Web Services account root user credentials
- even if the Amazon Web Services account has no associated users.
Lists the names of the inline policies embedded in the specified - IAM user.
An IAM user can also have managed policies attached to it. - To list the managed policies that are attached to a user, use ListAttachedUserPolicies. - For more information about policies, see Managed - policies and inline policies in the IAM User Guide.
You
- can paginate the results using the MaxItems and Marker
- parameters. If there are no inline policies embedded with the specified user,
- the operation returns an empty list.
The name of the user to list policies for.
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: _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the names of the inline policies embedded in the specified - IAM user.
An IAM user can also have managed policies attached to it. - To list the managed policies that are attached to a user, use ListAttachedUserPolicies. - For more information about policies, see Managed - policies and inline policies in the IAM User Guide.
You
- can paginate the results using the MaxItems and Marker
- parameters. If there are no inline policies embedded with the specified user,
- the operation returns an empty list.
The name of the IAM user whose tags you want to see.
-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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of theMarker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the IAM users that have the specified path prefix. If - no path prefix is specified, the operation returns all users in the Amazon - Web Services account. If there are none, the operation returns an empty list.
-IAM resource-listing operations return a subset of the available - attributes for the resource. For example, this operation does not return tags, - even though they are an attribute of the returned object. To view all of the - information for a user, see GetUser.
You can paginate
- the results using the MaxItems and Marker parameters.
The path prefix for filtering the results. For example:
- /division_abc/subdivision_xyz/, which would get all user names
- whose path starts with /division_abc/subdivision_xyz/.
This parameter is optional. If it is not included, it defaults to a slash
- (/), listing all user names. 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.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the IAM users that have the specified path prefix. If - no path prefix is specified, the operation returns all users in the Amazon - Web Services account. If there are none, the operation returns an empty list.
-IAM resource-listing operations return a subset of the available - attributes for the resource. For example, this operation does not return tags, - even though they are an attribute of the returned object. To view all of the - information for a user, see GetUser.
You can paginate
- the results using the MaxItems and Marker parameters.
Lists the virtual MFA devices defined in the Amazon Web Services
- account by assignment status. If you do not specify an assignment status,
- the operation returns a list of all virtual MFA devices. Assignment status
- can be Assigned, Unassigned, or Any.
IAM resource-listing operations return a subset of the available - attributes for the resource. For example, this operation does not return tags, - even though they are an attribute of the returned object. To view tag information - for a virtual MFA device, see ListMFADeviceTags.
You
- can paginate the results using the MaxItems and Marker
- parameters.
Unassigned or Assigned)
- of the devices to list. If you do not specify an AssignmentStatus,
- the operation defaults to Any, which lists both assigned and
- unassigned virtual MFA devices.,'
- in: query
- name: AssignmentStatus
- required: false
- schema:
- enum:
- - Assigned
- - Unassigned
- - Any
- type: string
- - description: Use this parameter only when paginating results and only after
- you receive a response indicating that the results are truncated. Set it
- to the value of the Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- - description: Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Lists the virtual MFA devices defined in the Amazon Web Services
- account by assignment status. If you do not specify an assignment status,
- the operation returns a list of all virtual MFA devices. Assignment status
- can be Assigned, Unassigned, or Any.
IAM resource-listing operations return a subset of the available - attributes for the resource. For example, this operation does not return tags, - even though they are an attribute of the returned object. To view tag information - for a virtual MFA device, see ListMFADeviceTags.
You
- can paginate the results using the MaxItems and Marker
- parameters.
Adds or updates an inline policy document that is embedded in - the specified IAM group.
A user can also have managed policies attached - to it. To attach a managed policy to a group, use AttachGroupPolicy. - To create a new managed policy, use CreatePolicy. For information about - policies, see Managed - policies and inline policies in the IAM User Guide.
For - information about the maximum number of inline policies that you can embed - in a group, see IAM - and STS quotas in the IAM User Guide.
Because policy
- documents can be large, you should use POST rather than GET when calling PutGroupPolicy.
- For general information about using the Query API with IAM, see Making
- query requests in the IAM User Guide.
The name of the group to associate the policy with.
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: - _+=,.@-.
' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name of the policy document.
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: _+=,.@-
' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The policy document.
You must provide policies in JSON - format in IAM. 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)
Adds or updates an inline policy document that is embedded in - the specified IAM group.
A user can also have managed policies attached - to it. To attach a managed policy to a group, use AttachGroupPolicy. - To create a new managed policy, use CreatePolicy. For information about - policies, see Managed - policies and inline policies in the IAM User Guide.
For - information about the maximum number of inline policies that you can embed - in a group, see IAM - and STS quotas in the IAM User Guide.
Because policy
- documents can be large, you should use POST rather than GET when calling PutGroupPolicy.
- For general information about using the Query API with IAM, see Making
- query requests in the IAM User Guide.
Adds or updates the policy that is specified as the IAM role's - permissions boundary. You can use an Amazon Web Services managed policy or - a customer managed policy to set the boundary for a role. Use the boundary - to control the maximum permissions that the role can have. Setting a permissions - boundary is an advanced feature that can affect the permissions for the role.
-You cannot set the boundary for a service-linked role.
Policies used as permissions boundaries do not provide permissions. You - must also attach a permissions policy to the role. To learn how the effective - permissions for a role are evaluated, see IAM - JSON policy evaluation logic in the IAM User Guide.
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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: PutRolePermissionsBoundary - 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' - post: - description:Adds or updates the policy that is specified as the IAM role's - permissions boundary. You can use an Amazon Web Services managed policy or - a customer managed policy to set the boundary for a role. Use the boundary - to control the maximum permissions that the role can have. Setting a permissions - boundary is an advanced feature that can affect the permissions for the role.
-You cannot set the boundary for a service-linked role.
Policies used as permissions boundaries do not provide permissions. You - must also attach a permissions policy to the role. To learn how the effective - permissions for a role are evaluated, see IAM - JSON policy evaluation logic in the IAM User Guide.
Adds or updates an inline policy document that is embedded in - the specified IAM role.
When you embed an inline policy in a role, - the inline policy is used as part of the role's access (permissions) policy. - The role's trust policy is created at the same time as the role, using CreateRole. - You can update a role's trust policy using UpdateAssumeRolePolicy. - For more information about IAM roles, see Using - roles to delegate permissions and federate identities.
A role can - also have a managed policy attached to it. To attach a managed policy to a - role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. - For information about policies, see Managed - policies and inline policies in the IAM User Guide.
For - information about the maximum number of inline policies that you can embed - with a role, see IAM - and STS quotas in the IAM User Guide.
Because policy
- documents can be large, you should use POST rather than GET when calling PutRolePolicy.
- For general information about using the Query API with IAM, see Making
- query requests in the IAM User Guide.
The name of the role to associate the policy with.
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: - _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name of the policy document.
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: _+=,.@-
' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The policy document.
You must provide policies in JSON - format in IAM. 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)
Adds or updates an inline policy document that is embedded in - the specified IAM role.
When you embed an inline policy in a role, - the inline policy is used as part of the role's access (permissions) policy. - The role's trust policy is created at the same time as the role, using CreateRole. - You can update a role's trust policy using UpdateAssumeRolePolicy. - For more information about IAM roles, see Using - roles to delegate permissions and federate identities.
A role can - also have a managed policy attached to it. To attach a managed policy to a - role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. - For information about policies, see Managed - policies and inline policies in the IAM User Guide.
For - information about the maximum number of inline policies that you can embed - with a role, see IAM - and STS quotas in the IAM User Guide.
Because policy
- documents can be large, you should use POST rather than GET when calling PutRolePolicy.
- For general information about using the Query API with IAM, see Making
- query requests in the IAM User Guide.
Adds or updates the policy that is specified as the IAM user's - permissions boundary. You can use an Amazon Web Services managed policy or - a customer managed policy to set the boundary for a user. Use the boundary - to control the maximum permissions that the user can have. Setting a permissions - boundary is an advanced feature that can affect the permissions for the user.
-Policies that are used as permissions boundaries do not provide - permissions. You must also attach a permissions policy to the user. To learn - how the effective permissions for a user are evaluated, see IAM - JSON policy evaluation logic in the IAM User Guide.
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. -
- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: PutUserPermissionsBoundary - 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' - post: - description:Adds or updates the policy that is specified as the IAM user's - permissions boundary. You can use an Amazon Web Services managed policy or - a customer managed policy to set the boundary for a user. Use the boundary - to control the maximum permissions that the user can have. Setting a permissions - boundary is an advanced feature that can affect the permissions for the user.
-Policies that are used as permissions boundaries do not provide - permissions. You must also attach a permissions policy to the user. To learn - how the effective permissions for a user are evaluated, see IAM - JSON policy evaluation logic in the IAM User Guide.
Adds or updates an inline policy document that is embedded in - the specified IAM user.
An IAM user can also have a managed policy - attached to it. To attach a managed policy to a user, use AttachUserPolicy. - To create a new managed policy, use CreatePolicy. For information about - policies, see Managed - policies and inline policies in the IAM User Guide.
For - information about the maximum number of inline policies that you can embed - in a user, see IAM - and STS quotas in the IAM User Guide.
Because policy
- documents can be large, you should use POST rather than GET when calling PutUserPolicy.
- For general information about using the Query API with IAM, see Making
- query requests in the IAM User Guide.
The name of the user to associate the policy with.
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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name of the policy document.
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: _+=,.@-
' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The policy document.
You must provide policies in JSON - format in IAM. 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)
Adds or updates an inline policy document that is embedded in - the specified IAM user.
An IAM user can also have a managed policy - attached to it. To attach a managed policy to a user, use AttachUserPolicy. - To create a new managed policy, use CreatePolicy. For information about - policies, see Managed - policies and inline policies in the IAM User Guide.
For - information about the maximum number of inline policies that you can embed - in a user, see IAM - and STS quotas in the IAM User Guide.
Because policy
- documents can be large, you should use POST rather than GET when calling PutUserPolicy.
- For general information about using the Query API with IAM, see Making
- query requests in the IAM User Guide.
Removes the specified client ID (also known as audience) from - the list of client IDs registered for the specified IAM OpenID Connect (OIDC) - provider resource object.
This operation is idempotent; it does not - fail or return an error if you try to remove a client ID that does not exist.
- operationId: GET_RemoveClientIDFromOpenIDConnectProvider - parameters: - - description:The Amazon Resource Name (ARN) of the IAM OIDC provider resource - to remove the client ID from. You can get a list of OIDC provider ARNs by - using the ListOpenIDConnectProviders operation.
For more information - about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: OpenIDConnectProviderArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description: The client ID (also known as audience) to remove from the IAM - OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider. - in: query - name: ClientID - required: true - schema: - maxLength: 255 - minLength: 1 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: RemoveClientIDFromOpenIDConnectProvider - 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' - post: - description:Removes the specified client ID (also known as audience) from - the list of client IDs registered for the specified IAM OpenID Connect (OIDC) - provider resource object.
This operation is idempotent; it does not - fail or return an error if you try to remove a client ID that does not exist.
- operationId: POST_RemoveClientIDFromOpenIDConnectProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RemoveClientIDFromOpenIDConnectProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: RemoveClientIDFromOpenIDConnectProvider - /?Action=RemoveRoleFromInstanceProfile&Version=2010-05-08: - get: - description:Removes the specified IAM role from the specified EC2 instance - profile.
Make sure that you do not have any Amazon EC2 - instances running with the role you are about to remove from the instance - profile. Removing a role from an instance profile that is associated with - a running instance might break any applications running on the instance.
-For more information about IAM roles, see Working - with roles. For more information about instance profiles, see About - instance profiles.
- operationId: GET_RemoveRoleFromInstanceProfile - parameters: - - description: 'The name of the instance profile to update.
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: _+=,.@-
' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name of the role to remove.
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: _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: RemoveRoleFromInstanceProfile - 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' - post: - description:Removes the specified IAM role from the specified EC2 instance - profile.
Make sure that you do not have any Amazon EC2 - instances running with the role you are about to remove from the instance - profile. Removing a role from an instance profile that is associated with - a running instance might break any applications running on the instance.
-For more information about IAM roles, see Working - with roles. For more information about instance profiles, see About - instance profiles.
- operationId: POST_RemoveRoleFromInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RemoveRoleFromInstanceProfileRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: RemoveRoleFromInstanceProfile - /?Action=RemoveUserFromGroup&Version=2010-05-08: - get: - description: Removes the specified user from the specified group. - operationId: GET_RemoveUserFromGroup - parameters: - - description: 'The name of the group to update.
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: _+=,.@-
' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'The name of the user to remove.
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: _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: RemoveUserFromGroup - 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' - post: - description: Removes the specified user from the specified group. - operationId: POST_RemoveUserFromGroup - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RemoveUserFromGroupRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: RemoveUserFromGroup - /?Action=ResetServiceSpecificCredential&Version=2010-05-08: - get: - description: Resets the password for a service-specific credential. The new - password is Amazon Web Services generated and cryptographically strong. It - cannot be configured by the user. Resetting the password immediately invalidates - the previous password associated with this user. - operationId: GET_ResetServiceSpecificCredential - parameters: - - description: 'The name of the IAM user associated with the service-specific - credential. If this value is not specified, then the operation assumes the - user whose credentials are used to call the operation.
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: _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The unique identifier of the service-specific credential.
-This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.
- in: query - name: ServiceSpecificCredentialId - required: true - schema: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - ResetServiceSpecificCredentialResult: - $ref: '#/components/schemas/ResetServiceSpecificCredentialResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: ResetServiceSpecificCredential - 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' - post: - description: Resets the password for a service-specific credential. The new - password is Amazon Web Services generated and cryptographically strong. It - cannot be configured by the user. Resetting the password immediately invalidates - the previous password associated with this user. - operationId: POST_ResetServiceSpecificCredential - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetServiceSpecificCredentialRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ResetServiceSpecificCredentialResult: - $ref: '#/components/schemas/ResetServiceSpecificCredentialResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: ResetServiceSpecificCredential - /?Action=ResyncMFADevice&Version=2010-05-08: - get: - description:Synchronizes the specified MFA device with its IAM resource - object on the Amazon Web Services servers.
For more information about - creating and working with virtual MFA devices, see Using - a virtual MFA device in the IAM User Guide.
- operationId: GET_ResyncMFADevice - parameters: - - description: 'The name of the user whose MFA device you want to resynchronize.
-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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: 'Serial number that uniquely identifies the MFA device.
-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: - _+=,.@-
' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - - description:An authentication code emitted by the device.
The format - for this parameter is a sequence of six digits.
- in: query - name: AuthenticationCode1 - required: true - schema: - maxLength: 6 - minLength: 6 - pattern: '[\d]+' - type: string - - description:A subsequent authentication code emitted by the device.
-The format for this parameter is a sequence of six digits.
- in: query - name: AuthenticationCode2 - required: true - schema: - maxLength: 6 - minLength: 6 - pattern: '[\d]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidAuthenticationCodeException' - description: InvalidAuthenticationCodeException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ResyncMFADevice - 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' - post: - description:Synchronizes the specified MFA device with its IAM resource - object on the Amazon Web Services servers.
For more information about - creating and working with virtual MFA devices, see Using - a virtual MFA device in the IAM User Guide.
- operationId: POST_ResyncMFADevice - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResyncMFADeviceRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidAuthenticationCodeException' - description: InvalidAuthenticationCodeException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ResyncMFADevice - /?Action=SetDefaultPolicyVersion&Version=2010-05-08: - get: - description:Sets the specified version of the specified policy as the policy's - default (operative) version.
This operation affects all users, groups, - and roles that the policy is attached to. To list the users, groups, and roles - that the policy is attached to, use ListEntitiesForPolicy.
For - information about managed policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: GET_SetDefaultPolicyVersion - parameters: - - description:The Amazon Resource Name (ARN) of the IAM policy whose default - version you want to set.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description:The version of the policy to set as the default (operative) - version.
For more information about managed policy versions, see - Versioning - for managed policies in the IAM User Guide.
- in: query - name: VersionId - required: true - schema: - pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? +openapi: 3.0.0 +info: + title: IAM + version: 1.0.0 +paths: {} +components: + schemas: + Policy: + description: |- + Contains information about an attached policy. + An attached policy is a managed policy that has been attached to a user, group, or role. + For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. + type: object + additionalProperties: false + properties: + PolicyDocument: + description: The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). + type: object + PolicyName: + description: The friendly name (not ARN) identifying the policy. type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: SetDefaultPolicyVersion - 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' - post: - description:Sets the specified version of the specified policy as the policy's - default (operative) version.
This operation affects all users, groups, - and roles that the policy is attached to. To list the users, groups, and roles - that the policy is attached to, use ListEntitiesForPolicy.
For - information about managed policies, see Managed - policies and inline policies in the IAM User Guide.
- operationId: POST_SetDefaultPolicyVersion - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/SetDefaultPolicyVersionRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: SetDefaultPolicyVersion - /?Action=SetSecurityTokenServicePreferences&Version=2010-05-08: - get: - description:Sets the specified version of the global endpoint token as the - token version used for the Amazon Web Services account.
By default,
- Security Token Service (STS) is available as a global service, and all STS
- requests go to a single endpoint at https://sts.amazonaws.com.
- Amazon Web Services recommends using Regional STS endpoints to reduce latency,
- build in redundancy, and increase session token availability. For information
- about Regional endpoints for STS, see Security
- Token Service endpoints and quotas in the Amazon Web Services General
- Reference.
If you make an STS call to the global endpoint, the - resulting session tokens might be valid in some Regions but not others. It - depends on the version that is set in this operation. Version 1 tokens are - valid only in Amazon Web Services Regions that are available by default. These - tokens do not work in manually enabled Regions, such as Asia Pacific (Hong - Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens - are longer and might affect systems where you temporarily store tokens. For - information, see Activating - and deactivating STS in an Amazon Web Services Region in the IAM User - Guide.
To view the current session token version, see the GlobalEndpointTokenVersion
- entry in the response of the GetAccountSummary operation.
The version of the global endpoint token. Version 1 tokens - are valid only in Amazon Web Services Regions that are available by default. - These tokens do not work in manually enabled Regions, such as Asia Pacific - (Hong Kong). Version 2 tokens are valid in all Regions. However, version - 2 tokens are longer and might affect systems where you temporarily store - tokens.
For information, see Activating - and deactivating STS in an Amazon Web Services Region in the IAM - User Guide.
- in: query - name: GlobalEndpointTokenVersion - required: true - schema: - enum: - - v1Token - - v2Token + required: + - PolicyName + - PolicyDocument + Group: + type: object + properties: + Arn: + description: '' type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: SetSecurityTokenServicePreferences - 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' - post: - description:Sets the specified version of the global endpoint token as the - token version used for the Amazon Web Services account.
By default,
- Security Token Service (STS) is available as a global service, and all STS
- requests go to a single endpoint at https://sts.amazonaws.com.
- Amazon Web Services recommends using Regional STS endpoints to reduce latency,
- build in redundancy, and increase session token availability. For information
- about Regional endpoints for STS, see Security
- Token Service endpoints and quotas in the Amazon Web Services General
- Reference.
If you make an STS call to the global endpoint, the - resulting session tokens might be valid in some Regions but not others. It - depends on the version that is set in this operation. Version 1 tokens are - valid only in Amazon Web Services Regions that are available by default. These - tokens do not work in manually enabled Regions, such as Asia Pacific (Hong - Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens - are longer and might affect systems where you temporarily store tokens. For - information, see Activating - and deactivating STS in an Amazon Web Services Region in the IAM User - Guide.
To view the current session token version, see the GlobalEndpointTokenVersion
- entry in the response of the GetAccountSummary operation.
Simulate how a set of IAM policies and optionally a resource-based - policy works with a list of API operations and Amazon Web Services resources - to determine the policies' effective permissions. The policies are provided - as strings.
The simulation does not perform the API operations; it - only checks the authorization to determine if the simulated policies allow - or deny the operations. You can simulate resources that don't exist in your - account.
If you want to simulate existing policies that are attached - to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
-Context keys are variables that are maintained by Amazon Web Services and
- its services and which provide details about the context of an API query request.
- You can use the Condition element of an IAM policy to evaluate
- context keys. To get the list of context keys that the policies require for
- correct simulation, use GetContextKeysForCustomPolicy.
If the
- output is long, you can use MaxItems and Marker
- parameters to paginate the results.
For more information about using - the policy simulator, see Testing - IAM policies with the IAM policy simulator in the IAM User Guide.
- operationId: GET_SimulateCustomPolicy - parameters: - - description:A list of policy documents to include in the simulation. Each
- document is specified as a string containing the complete, valid JSON text
- of an IAM policy. Do not include any resource-based policies in this parameter.
- Any resource-based policy must be submitted with the ResourcePolicy
- parameter. The policies cannot be "scope-down" policies, such as you could
- include in a call to GetFederationToken
- or one of the AssumeRole
- API operations. In other words, do not use policies designed to restrict
- what a user can do while using the temporary credentials.
The maximum - length of the policy document that you can pass in this operation, including - whitespace, is listed below. To view the maximum character counts of a managed - policy with no whitespaces, see IAM - and STS character quotas.
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)
The IAM permissions boundary policy to simulate. The permissions - boundary sets the maximum permissions that an IAM entity can have. You can - input only one permissions boundary when you pass a policy to this operation. - For more information about permissions boundaries, see Permissions - boundaries for IAM entities in the IAM User Guide. The policy - input is specified as a string that contains the complete, valid JSON text - of a permissions boundary policy.
The maximum length of the policy - document that you can pass in this operation, including whitespace, is listed - below. To view the maximum character counts of a managed policy with no - whitespaces, see IAM - and STS character quotas.
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)
iam:CreateUser. This operation
- does not support using wildcards (*) in an action name.
- in: query
- name: ActionNames
- required: true
- schema:
+ uniqueItems: true
+ x-insertionOrder: false
items:
- allOf:
- - $ref: '#/components/schemas/ActionNameType'
- - xml:
- name: member
+ type: string
+ Path:
+ description: |-
+ The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) 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](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) 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.
+ type: string
+ Policies:
+ description: |-
+ Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group).
+ The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.
+ For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
type: array
- - description: A list of ARNs of Amazon Web Services resources to include
- in the simulation. If this parameter is not provided, then the value defaults
- to * (all resources). Each API in the ActionNames
- parameter is evaluated for each resource in this list. The simulation determines
- the access result (allowed or denied) of each combination and reports it
- in the response. You can simulate resources that don't exist in your account.
The simulation does not automatically retrieve policies for the specified
- resources. If you want to include a resource policy in the simulation, then
- you must include the policy as a string in the ResourcePolicy
- parameter.
If you include a ResourcePolicy, then it
- must be applicable to all of the resources included in the simulation or
- you receive an invalid input error.
For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: ResourceArns - required: false - schema: + uniqueItems: false + x-insertionOrder: false items: - allOf: - - $ref: '#/components/schemas/ResourceNameType' - - xml: - name: member - type: array - - description:A resource-based policy to include in the simulation provided - as a string. Each resource in the simulation is treated as if it had this - policy attached. You can include only one resource-based policy in a simulation.
-The maximum length of the policy document that you can pass in this operation, - including whitespace, is listed below. To view the maximum character counts - of a managed policy with no whitespaces, see IAM - and STS character quotas.
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)
An ARN representing the Amazon Web Services account ID that
- specifies the owner of any simulated resource that does not identify its
- owner in the resource ARN. Examples of resource ARNs include an S3 bucket
- or object. If ResourceOwner is specified, it is also used as
- the account owner of any ResourcePolicy included in the simulation.
- If the ResourceOwner parameter is not specified, then the owner
- of the resources and the resource policy defaults to the account of the
- identity provided in CallerArn. This parameter is required
- only if you specify a resource-based policy and account that owns the resource
- is different from the account that owns the simulated calling user CallerArn.
The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root.
- For example, to represent the account with the 112233445566 ID, use the
- following ARN: arn:aws:iam::112233445566-ID:root.
The ARN of the IAM user that you want to use as the simulated
- caller of the API operations. CallerArn is required if you
- include a ResourcePolicy so that the policy's Principal
- element has a value to use in evaluating the policy.
You can specify - only the ARN of an IAM user. You cannot specify the ARN of an assumed role, - federated user, or a service principal.
- in: query - name: CallerArn - required: false - schema: - maxLength: 2048 - minLength: 1 + GroupName: + description: |- + The name of the group to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. + type: string + required: + - PolicyName + - GroupName + x-stackql-resource-name: group_policy + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM group. + A group can also have managed policies attached to it. To attach a managed policy to a group, use [AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. + For information about the maximum number of inline policies that you can embed in a group, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::GroupPolicy + x-stackql-primary-identifier: + - PolicyName + - GroupName + x-create-only-properties: + - PolicyName + - GroupName + x-required-properties: + - PolicyName + - GroupName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - iam:PutGroupPolicy + - iam:GetGroupPolicy + read: + - iam:GetGroupPolicy + update: + - iam:PutGroupPolicy + - iam:GetGroupPolicy + delete: + - iam:DeleteGroupPolicy + - iam:GetGroupPolicy + InstanceProfile: + type: object + properties: + Path: type: string - - description: A list of context keys and corresponding values for the simulation - to use. Whenever a context key is evaluated in one of the simulated IAM - permissions policies, the corresponding value is supplied. - in: query - name: ContextEntries - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/ContextEntry' - - xml: - name: member + description: |- + The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) 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](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) 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. + Roles: type: array - - description:Specifies the type of simulation to run. Different API operations - that support resource-based policies require different combinations of resources. - By specifying the type of simulation to run, you enable the policy simulator - to enforce the presence of the required resources to ensure reliable simulation - results. If your simulation does not match one of the following scenarios, - then you can omit this parameter. The following list shows each of the supported - scenario values and the resources that you must define to run the simulation.
-Each of the EC2 scenarios requires that you specify instance, image, - and security-group resources. If your scenario includes an EBS volume, then - you must specify that volume as a resource. If the EC2 scenario includes - VPC, then you must supply the network-interface resource. If it includes - an IP subnet, then you must specify the subnet resource. For more information - on the EC2 scenario options, see Supported - platforms in the Amazon EC2 User Guide.
EC2-Classic-InstanceStore -
instance, image, security-group
EC2-Classic-EBS -
instance, image, security-group, volume
EC2-VPC-InstanceStore -
instance, image, security-group, network-interface
EC2-VPC-InstanceStore-Subnet
instance, image, security-group, - network-interface, subnet
EC2-VPC-EBS
instance, - image, security-group, network-interface, volume
EC2-VPC-EBS-Subnet -
instance, image, security-group, network-interface, subnet, volume
-Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- responses:
- '200':
- content:
- text/xml:
- schema:
- properties:
- SimulateCustomPolicyResult:
- $ref: '#/components/schemas/SimulatePolicyResponse'
- type: object
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/InvalidInputException'
- description: InvalidInputException
- '481':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/PolicyEvaluationException'
- description: PolicyEvaluationException
- x-aws-operation-name: SimulateCustomPolicy
- 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'
- post:
- description: Simulate how a set of IAM policies and optionally a resource-based - policy works with a list of API operations and Amazon Web Services resources - to determine the policies' effective permissions. The policies are provided - as strings.
The simulation does not perform the API operations; it - only checks the authorization to determine if the simulated policies allow - or deny the operations. You can simulate resources that don't exist in your - account.
If you want to simulate existing policies that are attached - to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
-Context keys are variables that are maintained by Amazon Web Services and
- its services and which provide details about the context of an API query request.
- You can use the Condition element of an IAM policy to evaluate
- context keys. To get the list of context keys that the policies require for
- correct simulation, use GetContextKeysForCustomPolicy.
If the
- output is long, you can use MaxItems and Marker
- parameters to paginate the results.
For more information about using - the policy simulator, see Testing - IAM policies with the IAM policy simulator in the IAM User Guide.
- operationId: POST_SimulateCustomPolicy - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: + description: The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions. + uniqueItems: true + x-insertionOrder: false + items: + type: string + InstanceProfileName: type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: + description: |- + The name of the instance profile to create. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + Arn: type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/SimulateCustomPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - SimulateCustomPolicyResult: - $ref: '#/components/schemas/SimulatePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyEvaluationException' - description: PolicyEvaluationException - x-aws-operation-name: SimulateCustomPolicy - /?Action=SimulatePrincipalPolicy&Version=2010-05-08: - get: - description:Simulate how a set of IAM policies attached to an IAM entity - works with a list of API operations and Amazon Web Services resources to determine - the policies' effective permissions. The entity can be an IAM user, group, - or role. If you specify a user, then the simulation also includes all of the - policies that are attached to groups that the user belongs to. You can simulate - resources that don't exist in your account.
You can optionally include - a list of one or more additional policies specified as strings to include - in the simulation. If you want to simulate only policies specified as strings, - use SimulateCustomPolicy instead.
You can also optionally include - one resource-based policy to be evaluated with each of the resources included - in the simulation.
The simulation does not perform the API operations; - it only checks the authorization to determine if the simulated policies allow - or deny the operations.
Note: This operation discloses information - about the permissions granted to other users. If you do not want users to - see other user's permissions, then consider allowing them to use SimulateCustomPolicy - instead.
Context keys are variables maintained by Amazon Web Services
- and its services that provide details about the context of an API query request.
- You can use the Condition element of an IAM policy to evaluate
- context keys. To get the list of context keys that the policies require for
- correct simulation, use GetContextKeysForPrincipalPolicy.
If
- the output is long, you can use the MaxItems and Marker
- parameters to paginate the results.
For more information about using - the policy simulator, see Testing - IAM policies with the IAM policy simulator in the IAM User Guide.
- operationId: GET_SimulatePrincipalPolicy - parameters: - - description:The Amazon Resource Name (ARN) of a user, group, or role whose - policies you want to include in the simulation. If you specify a user, group, - or role, the simulation includes all policies that are associated with that - entity. If you specify a user, the simulation also includes all policies - that are attached to any groups the user belongs to.
The maximum - length of the policy document that you can pass in this operation, including - whitespace, is listed below. To view the maximum character counts of a managed - policy with no whitespaces, see IAM - and STS character quotas.
For more information about ARNs, see - Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: PolicySourceArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 + description: '' + required: + - Roles + x-stackql-resource-name: instance_profile + description: |- + Creates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html). + For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*. + x-type-name: AWS::IAM::InstanceProfile + x-stackql-primary-identifier: + - InstanceProfileName + x-create-only-properties: + - InstanceProfileName + - Path + x-read-only-properties: + - Arn + x-required-properties: + - Roles + x-required-permissions: + create: + - iam:CreateInstanceProfile + - iam:PassRole + - iam:AddRoleToInstanceProfile + - iam:GetInstanceProfile + read: + - iam:GetInstanceProfile + update: + - iam:PassRole + - iam:RemoveRoleFromInstanceProfile + - iam:AddRoleToInstanceProfile + - iam:GetInstanceProfile + delete: + - iam:GetInstanceProfile + - iam:RemoveRoleFromInstanceProfile + - iam:DeleteInstanceProfile + list: + - iam:ListInstanceProfiles + ManagedPolicy: + type: object + properties: + Description: type: string - - description:An optional list of additional policy documents to include - in the simulation. Each document is specified as a string containing the - complete, valid JSON text of an IAM policy.
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)
The IAM permissions boundary policy to simulate. The permissions - boundary sets the maximum permissions that the entity can have. You can - input only one permissions boundary when you pass a policy to this operation. - An IAM entity can only have one permissions boundary in effect at a time. - For example, if a permissions boundary is attached to an entity and you - pass in a different permissions boundary policy using this parameter, then - the new permissions boundary policy is used for the simulation. For more - information about permissions boundaries, see Permissions - boundaries for IAM entities in the IAM User Guide. The policy - input is specified as a string containing the complete, valid JSON text - of a permissions boundary policy.
The maximum length of the policy - document that you can pass in this operation, including whitespace, is listed - below. To view the maximum character counts of a managed policy with no - whitespaces, see IAM - and STS character quotas.
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)
iam:CreateUser.
- in: query
- name: ActionNames
- required: true
- schema:
+ description: |-
+ The name (friendly name, not ARN) of the role to attach the policy to.
+ This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
+ If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy.
+ uniqueItems: true
items:
- allOf:
- - $ref: '#/components/schemas/ActionNameType'
- - xml:
- name: member
+ type: string
+ Users:
+ x-insertionOrder: false
type: array
- - description: A list of ARNs of Amazon Web Services resources to include
- in the simulation. If this parameter is not provided, then the value defaults
- to * (all resources). Each API in the ActionNames
- parameter is evaluated for each resource in this list. The simulation determines
- the access result (allowed or denied) of each combination and reports it
- in the response. You can simulate resources that don't exist in your account.
The simulation does not automatically retrieve policies for the specified
- resources. If you want to include a resource policy in the simulation, then
- you must include the policy as a string in the ResourcePolicy
- parameter.
For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: ResourceArns - required: false - schema: + description: |- + The name (friendly name, not ARN) of the IAM user to attach the policy to. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + uniqueItems: true items: - allOf: - - $ref: '#/components/schemas/ResourceNameType' - - xml: - name: member - type: array - - description:A resource-based policy to include in the simulation provided - as a string. Each resource in the simulation is treated as if it had this - policy attached. You can include only one resource-based policy in a simulation.
-The maximum length of the policy document that you can pass in this operation, - including whitespace, is listed below. To view the maximum character counts - of a managed policy with no whitespaces, see IAM - and STS character quotas.
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)
ResourceOwner
- is specified, it is also used as the account owner of any ResourcePolicy
- included in the simulation. If the ResourceOwner parameter
- is not specified, then the owner of the resources and the resource policy
- defaults to the account of the identity provided in CallerArn.
- This parameter is required only if you specify a resource-based policy and
- account that owns the resource is different from the account that owns the
- simulated calling user CallerArn.
- in: query
- name: ResourceOwner
- required: false
- schema:
- maxLength: 2048
- minLength: 1
+ description: ''
+ AttachmentCount:
+ type: integer
+ description: ''
+ CreateDate:
type: string
- - description: The ARN of the IAM user that you want to specify as the simulated
- caller of the API operations. If you do not specify a CallerArn,
- it defaults to the ARN of the user that you specify in PolicySourceArn,
- if you specified a user. If you include both a PolicySourceArn
- (for example, arn:aws:iam::123456789012:user/David) and a CallerArn
- (for example, arn:aws:iam::123456789012:user/Bob), the result
- is that you simulate calling the API operations as Bob, as if Bob had David's
- policies.
You can specify only the ARN of an IAM user. You cannot - specify the ARN of an assumed role, federated user, or a service principal.
- CallerArn is required if you include a ResourcePolicy
- and the PolicySourceArn is not the ARN for an IAM user. This
- is required so that the resource-based policy's Principal element
- has a value to use in evaluating the policy.
For more information - about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: CallerArn - required: false - schema: - maxLength: 2048 - minLength: 1 + description: '' + UpdateDate: type: string - - description: A list of context keys and corresponding values for the simulation - to use. Whenever a context key is evaluated in one of the simulated IAM - permissions policies, the corresponding value is supplied. - in: query - name: ContextEntries - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/ContextEntry' - - xml: - name: member - type: array - - description:Specifies the type of simulation to run. Different API operations - that support resource-based policies require different combinations of resources. - By specifying the type of simulation to run, you enable the policy simulator - to enforce the presence of the required resources to ensure reliable simulation - results. If your simulation does not match one of the following scenarios, - then you can omit this parameter. The following list shows each of the supported - scenario values and the resources that you must define to run the simulation.
-Each of the EC2 scenarios requires that you specify instance, image, - and security group resources. If your scenario includes an EBS volume, then - you must specify that volume as a resource. If the EC2 scenario includes - VPC, then you must supply the network interface resource. If it includes - an IP subnet, then you must specify the subnet resource. For more information - on the EC2 scenario options, see Supported - platforms in the Amazon EC2 User Guide.
EC2-Classic-InstanceStore -
instance, image, security group
EC2-Classic-EBS -
instance, image, security group, volume
EC2-VPC-InstanceStore -
instance, image, security group, network interface
EC2-VPC-InstanceStore-Subnet
instance, image, security - group, network interface, subnet
EC2-VPC-EBS
-instance, image, security group, network interface, volume
EC2-VPC-EBS-Subnet
instance, image, security group, - network interface, subnet, volume
Use this only when paginating results to indicate the maximum
- number of items you want in the response. If additional items exist beyond
- the maximum you specify, the IsTruncated response element is
- true.
If you do not include this parameter, the number
- of items defaults to 100. Note that IAM might return fewer results, even
- when there are more results available. In that case, the IsTruncated
- response element returns true, and Marker contains
- a value to include in the subsequent call that tells the service where to
- continue from.
Marker element in the response that you
- received to indicate where the next call should start.
- in: query
- name: Marker
- required: false
- schema:
- maxLength: 320
- minLength: 1
- pattern: '[\u0020-\u00FF]+'
- type: string
- responses:
- '200':
- content:
- text/xml:
- schema:
- properties:
- SimulatePrincipalPolicyResult:
- $ref: '#/components/schemas/SimulatePolicyResponse'
- type: object
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/NoSuchEntityException'
- description: NoSuchEntityException
- '481':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/InvalidInputException'
- description: InvalidInputException
- '482':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/PolicyEvaluationException'
- description: PolicyEvaluationException
- x-aws-operation-name: SimulatePrincipalPolicy
- 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'
- post:
- description: Simulate how a set of IAM policies attached to an IAM entity - works with a list of API operations and Amazon Web Services resources to determine - the policies' effective permissions. The entity can be an IAM user, group, - or role. If you specify a user, then the simulation also includes all of the - policies that are attached to groups that the user belongs to. You can simulate - resources that don't exist in your account.
You can optionally include - a list of one or more additional policies specified as strings to include - in the simulation. If you want to simulate only policies specified as strings, - use SimulateCustomPolicy instead.
You can also optionally include - one resource-based policy to be evaluated with each of the resources included - in the simulation.
The simulation does not perform the API operations; - it only checks the authorization to determine if the simulated policies allow - or deny the operations.
Note: This operation discloses information - about the permissions granted to other users. If you do not want users to - see other user's permissions, then consider allowing them to use SimulateCustomPolicy - instead.
Context keys are variables maintained by Amazon Web Services
- and its services that provide details about the context of an API query request.
- You can use the Condition element of an IAM policy to evaluate
- context keys. To get the list of context keys that the policies require for
- correct simulation, use GetContextKeysForPrincipalPolicy.
If
- the output is long, you can use the MaxItems and Marker
- parameters to paginate the results.
For more information about using - the policy simulator, see Testing - IAM policies with the IAM policy simulator in the IAM User Guide.
- operationId: POST_SimulatePrincipalPolicy - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: + description: '' + PolicyId: type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: + description: '' + required: + - PolicyDocument + x-stackql-resource-name: managed_policy + description: |- + Creates a new managed policy for your AWS-account. + This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*. + As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*. + For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::ManagedPolicy + x-stackql-primary-identifier: + - PolicyArn + x-create-only-properties: + - ManagedPolicyName + - Description + - Path + x-read-only-properties: + - PolicyArn + - AttachmentCount + - CreateDate + - DefaultVersionId + - IsAttachable + - PermissionsBoundaryUsageCount + - PolicyId + - UpdateDate + x-required-properties: + - PolicyDocument + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - iam:CreatePolicy + - iam:AttachGroupPolicy + - iam:AttachUserPolicy + - iam:AttachRolePolicy + read: + - iam:GetPolicy + - iam:ListEntitiesForPolicy + - iam:GetPolicyVersion + update: + - iam:DetachRolePolicy + - iam:GetPolicy + - iam:ListPolicyVersions + - iam:DetachGroupPolicy + - iam:DetachUserPolicy + - iam:CreatePolicyVersion + - iam:DeletePolicyVersion + - iam:AttachGroupPolicy + - iam:AttachUserPolicy + - iam:AttachRolePolicy + delete: + - iam:DetachRolePolicy + - iam:GetPolicy + - iam:ListPolicyVersions + - iam:DetachGroupPolicy + - iam:DetachUserPolicy + - iam:DeletePolicyVersion + - iam:DeletePolicy + - iam:ListEntitiesForPolicy + list: + - iam:ListPolicies + Tag: + description: A key-value pair to associate with a resource. + type: object + additionalProperties: false + properties: + Value: + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/SimulatePrincipalPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - SimulatePrincipalPolicyResult: - $ref: '#/components/schemas/SimulatePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyEvaluationException' - description: PolicyEvaluationException - x-aws-operation-name: SimulatePrincipalPolicy - /?Action=TagInstanceProfile&Version=2010-05-08: - get: - description:Adds one or more tags to an IAM instance profile. If a tag with - the same key name already exists, then that tag is overwritten with the new - value.
Each tag consists of a key name and an associated value. By - assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources - to aid in organization and search. For example, you could search for all resources - with the key name Project and the value MyImportantProject. - Or search for all resources with the key name Cost Center and the value - 41200.
Access control - Include tags in - IAM user-based and resource-based policies. You can use tags to restrict access - to only an IAM instance profile that has a specified tag attached. For examples - of policies that show how to use tags to control access, see Control - access using IAM tags 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. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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 name of the IAM instance profile to which you want to - add tags.
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: - _+=,.@-
' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The list of tags that you want to attach to the IAM instance - profile. Each tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagInstanceProfile - 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' - post: - description:Adds one or more tags to an IAM instance profile. If a tag with - the same key name already exists, then that tag is overwritten with the new - value.
Each tag consists of a key name and an associated value. By - assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources - to aid in organization and search. For example, you could search for all resources - with the key name Project and the value MyImportantProject. - Or search for all resources with the key name Cost Center and the value - 41200.
Access control - Include tags in - IAM user-based and resource-based policies. You can use tags to restrict access - to only an IAM instance profile that has a specified tag attached. For examples - of policies that show how to use tags to control access, see Control - access using IAM tags 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. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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.
Adds one or more tags to an IAM virtual multi-factor authentication - (MFA) device. If a tag with the same key name already exists, then that tag - is overwritten with the new value.
A tag consists of a key name and - an associated value. By assigning tags to your resources, you can do the following:
-Administrative grouping and discovery - Attach tags to - resources to aid in organization and search. For example, you could search - for all resources with the key name Project and the value MyImportantProject. - Or search for all resources with the key name Cost Center and the value - 41200.
Access control - Include tags in - IAM user-based and resource-based policies. You can use tags to restrict access - to only an IAM virtual MFA device that has a specified tag attached. For examples - of policies that show how to use tags to control access, see Control - access using IAM tags 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. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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 unique identifier for the IAM virtual MFA device to which - you want to add tags. For virtual MFA devices, the serial number is the - same as the ARN.
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: - _+=,.@-
' - in: query - name: SerialNumber - required: true - schema: maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - - description: The list of tags that you want to attach to the IAM virtual MFA - device. Each tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagMFADevice - 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' - post: - description:Adds one or more tags to an IAM virtual multi-factor authentication - (MFA) device. If a tag with the same key name already exists, then that tag - is overwritten with the new value.
A tag consists of a key name and - an associated value. By assigning tags to your resources, you can do the following:
-Administrative grouping and discovery - Attach tags to - resources to aid in organization and search. For example, you could search - for all resources with the key name Project and the value MyImportantProject. - Or search for all resources with the key name Cost Center and the value - 41200.
Access control - Include tags in - IAM user-based and resource-based policies. You can use tags to restrict access - to only an IAM virtual MFA device that has a specified tag attached. For examples - of policies that show how to use tags to control access, see Control - access using IAM tags 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. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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.
Adds one or more tags to an OpenID Connect (OIDC)-compatible - identity provider. For more information about these providers, see About - web identity federation. If a tag with the same key name already exists, - then that tag is overwritten with the new value.
A tag consists of - a key name and an associated value. By assigning tags to your resources, you - can do the following:
Administrative grouping and discovery - - Attach tags to resources to aid in organization and search. For example, - you could search for all resources with the key name Project and the - value MyImportantProject. Or search for all resources with the key - name Cost Center and the value 41200.
Access - control - Include tags in IAM user-based and resource-based policies. - You can use tags to restrict access to only an OIDC provider that has a specified - tag attached. For examples of policies that show how to use tags to control - access, see Control - access using IAM tags 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. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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 ARN of the OIDC identity provider in IAM to which you - want to add tags.
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: - _+=,.@-
' - in: query - name: OpenIDConnectProviderArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description: The list of tags that you want to attach to the OIDC identity - provider in IAM. Each tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagOpenIDConnectProvider - 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' - post: - description:Adds one or more tags to an OpenID Connect (OIDC)-compatible - identity provider. For more information about these providers, see About - web identity federation. If a tag with the same key name already exists, - then that tag is overwritten with the new value.
A tag consists of - a key name and an associated value. By assigning tags to your resources, you - can do the following:
Administrative grouping and discovery - - Attach tags to resources to aid in organization and search. For example, - you could search for all resources with the key name Project and the - value MyImportantProject. Or search for all resources with the key - name Cost Center and the value 41200.
Access - control - Include tags in IAM user-based and resource-based policies. - You can use tags to restrict access to only an OIDC provider that has a specified - tag attached. For examples of policies that show how to use tags to control - access, see Control - access using IAM tags 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. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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.
Adds one or more tags to an IAM customer managed policy. If - a tag with the same key name already exists, then that tag is overwritten - with the new value.
A tag consists of a key name and an associated - value. By assigning tags to your resources, you can do the following:
-Administrative grouping and discovery - Attach tags to - resources to aid in organization and search. For example, you could search - for all resources with the key name Project and the value MyImportantProject. - Or search for all resources with the key name Cost Center and the value - 41200.
Access control - Include tags in - IAM user-based and resource-based policies. You can use tags to restrict access - to only an IAM customer managed policy that has a specified tag attached. - For examples of policies that show how to use tags to control access, see - Control - access using IAM tags 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. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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 ARN of the IAM customer managed policy to which you want - to add tags.
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: - _+=,.@-
' - in: query - name: PolicyArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 + Key: + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' type: string - - description: The list of tags that you want to attach to the IAM customer - managed policy. Each tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagPolicy - 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' - post: - description:Adds one or more tags to an IAM customer managed policy. If - a tag with the same key name already exists, then that tag is overwritten - with the new value.
A tag consists of a key name and an associated - value. By assigning tags to your resources, you can do the following:
-Administrative grouping and discovery - Attach tags to - resources to aid in organization and search. For example, you could search - for all resources with the key name Project and the value MyImportantProject. - Or search for all resources with the key name Cost Center and the value - 41200.
Access control - Include tags in - IAM user-based and resource-based policies. You can use tags to restrict access - to only an IAM customer managed policy that has a specified tag attached. - For examples of policies that show how to use tags to control access, see - Control - access using IAM tags 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. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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.
Adds one or more tags to an IAM role. The role can be a regular - role or a service-linked role. If a tag with the same key name already exists, - then that tag is overwritten with the new value.
A tag consists of - a key name and an associated value. By assigning tags to your resources, you - can do the following:
Administrative grouping and discovery - - Attach tags to resources to aid in organization and search. For example, - you could search for all resources with the key name Project and the - value MyImportantProject. Or search for all resources with the key - name Cost Center and the value 41200.
Access - control - Include tags in IAM user-based and resource-based policies. - You can use tags to restrict access to only an IAM role that has a specified - tag attached. You can also restrict access to only those resources that have - a certain tag attached. For examples of policies that show how to use tags - to control access, see Control - access using IAM tags in the IAM User Guide.
- Cost allocation - Use tags to help track which individuals and teams - are using which Amazon Web Services resources.
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. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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.
For more information about tagging, see Tagging - IAM identities in the IAM User Guide.
- operationId: GET_TagRole - parameters: - - description: 'The name of the IAM role to which you want to add tags.
-This parameter accepts (through its regex - pattern) a string of characters that consist of upper and lowercase - alphanumeric characters with no spaces. You can also include any of the - following characters: _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The list of tags that you want to attach to the IAM role. Each - tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagRole - 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' - post: - description:Adds one or more tags to an IAM role. The role can be a regular - role or a service-linked role. If a tag with the same key name already exists, - then that tag is overwritten with the new value.
A tag consists of - a key name and an associated value. By assigning tags to your resources, you - can do the following:
Administrative grouping and discovery - - Attach tags to resources to aid in organization and search. For example, - you could search for all resources with the key name Project and the - value MyImportantProject. Or search for all resources with the key - name Cost Center and the value 41200.
Access - control - Include tags in IAM user-based and resource-based policies. - You can use tags to restrict access to only an IAM role that has a specified - tag attached. You can also restrict access to only those resources that have - a certain tag attached. For examples of policies that show how to use tags - to control access, see Control - access using IAM tags in the IAM User Guide.
- Cost allocation - Use tags to help track which individuals and teams - are using which Amazon Web Services resources.
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. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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.
For more information about tagging, see Tagging - IAM identities in the IAM User Guide.
- operationId: POST_TagRole - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TagRoleRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagRole - /?Action=TagSAMLProvider&Version=2010-05-08: - get: - description:Adds one or more tags to a Security Assertion Markup Language - (SAML) identity provider. For more information about these providers, see - About - SAML 2.0-based federation . If a tag with the same key name already exists, - then that tag is overwritten with the new value.
A tag consists of - a key name and an associated value. By assigning tags to your resources, you - can do the following:
Administrative grouping and discovery - - Attach tags to resources to aid in organization and search. For example, - you could search for all resources with the key name Project and the - value MyImportantProject. Or search for all resources with the key - name Cost Center and the value 41200.
Access - control - Include tags in IAM user-based and resource-based policies. - You can use tags to restrict access to only a SAML identity provider that - has a specified tag attached. For examples of policies that show how to use - tags to control access, see Control - access using IAM tags 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. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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 ARN of the SAML identity provider in IAM to which you - want to add tags.
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: - _+=,.@-
' - in: query - name: SAMLProviderArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description: The list of tags that you want to attach to the SAML identity - provider in IAM. Each tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagSAMLProvider - 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' - post: - description:Adds one or more tags to a Security Assertion Markup Language - (SAML) identity provider. For more information about these providers, see - About - SAML 2.0-based federation . If a tag with the same key name already exists, - then that tag is overwritten with the new value.
A tag consists of - a key name and an associated value. By assigning tags to your resources, you - can do the following:
Administrative grouping and discovery - - Attach tags to resources to aid in organization and search. For example, - you could search for all resources with the key name Project and the - value MyImportantProject. Or search for all resources with the key - name Cost Center and the value 41200.
Access - control - Include tags in IAM user-based and resource-based policies. - You can use tags to restrict access to only a SAML identity provider that - has a specified tag attached. For examples of policies that show how to use - tags to control access, see Control - access using IAM tags 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. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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.
Adds one or more tags to an IAM server certificate. If a tag - with the same key name already exists, then that tag is overwritten with the - new value.
For certificates in a Region supported by Certificate - Manager (ACM), we recommend that you don't use IAM server certificates. Instead, - use ACM to provision, manage, and deploy your server certificates. For more - information about IAM server certificates, Working - with server certificates in the IAM User Guide.
A - tag consists of a key name and an associated value. By assigning tags to your - resources, you can do the following:
Administrative grouping - and discovery - Attach tags to resources to aid in organization and search. - For example, you could search for all resources with the key name Project - and the value MyImportantProject. Or search for all resources with - the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based - policies. You can use tags to restrict access to only a server certificate - that has a specified tag attached. For examples of policies that show how - to use tags to control access, see Control - access using IAM tags in the IAM User Guide.
- Cost allocation - Use tags to help track which individuals and teams - are using which Amazon Web Services resources.
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. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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 name of the IAM server certificate to which you want - to add tags.
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: - _+=,.@-
' - in: query - name: ServerCertificateName - required: true - schema: maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The list of tags that you want to attach to the IAM server certificate. - Each tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 + required: + - Value + - Key + OIDCProvider: + type: object + properties: + ClientIdList: type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagServerCertificate - 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' - post: - description:Adds one or more tags to an IAM server certificate. If a tag - with the same key name already exists, then that tag is overwritten with the - new value.
For certificates in a Region supported by Certificate - Manager (ACM), we recommend that you don't use IAM server certificates. Instead, - use ACM to provision, manage, and deploy your server certificates. For more - information about IAM server certificates, Working - with server certificates in the IAM User Guide.
A - tag consists of a key name and an associated value. By assigning tags to your - resources, you can do the following:
Administrative grouping - and discovery - Attach tags to resources to aid in organization and search. - For example, you could search for all resources with the key name Project - and the value MyImportantProject. Or search for all resources with - the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based - policies. You can use tags to restrict access to only a server certificate - that has a specified tag attached. For examples of policies that show how - to use tags to control access, see Control - access using IAM tags in the IAM User Guide.
- Cost allocation - Use tags to help track which individuals and teams - are using which Amazon Web Services resources.
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. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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.
Adds one or more tags to an IAM user. If a tag with the same - key name already exists, then that tag is overwritten with the new value.
-A tag consists of a key name and an associated value. By assigning tags - to your resources, you can do the following:
Administrative - grouping and discovery - Attach tags to resources to aid in organization - and search. For example, you could search for all resources with the key name - Project and the value MyImportantProject. Or search for all - resources with the key name Cost Center and the value 41200. -
Access control - Include tags in IAM user-based - and resource-based policies. You can use tags to restrict access to only an - IAM requesting user that has a specified tag attached. You can also restrict - access to only those resources that have a certain tag attached. For examples - of policies that show how to use tags to control access, see Control - access using IAM tags in the IAM User Guide.
- Cost allocation - Use tags to help track which individuals and teams - are using which Amazon Web Services resources.
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. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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.
For more information about tagging, see Tagging - IAM identities in the IAM User Guide.
- operationId: GET_TagUser - parameters: - - description: 'The name of the IAM user to which you want to add tags.
-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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The list of tags that you want to attach to the IAM user. Each - tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: + x-insertionOrder: false items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagUser - 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' - post: - description:Adds one or more tags to an IAM user. If a tag with the same - key name already exists, then that tag is overwritten with the new value.
-A tag consists of a key name and an associated value. By assigning tags - to your resources, you can do the following:
Administrative - grouping and discovery - Attach tags to resources to aid in organization - and search. For example, you could search for all resources with the key name - Project and the value MyImportantProject. Or search for all - resources with the key name Cost Center and the value 41200. -
Access control - Include tags in IAM user-based - and resource-based policies. You can use tags to restrict access to only an - IAM requesting user that has a specified tag attached. You can also restrict - access to only those resources that have a certain tag attached. For examples - of policies that show how to use tags to control access, see Control - access using IAM tags in the IAM User Guide.
- Cost allocation - Use tags to help track which individuals and teams - are using which Amazon Web Services resources.
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. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
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.
For more information about tagging, see Tagging - IAM identities in the IAM User Guide.
- operationId: POST_TagUser - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TagUserRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagUser - /?Action=UntagInstanceProfile&Version=2010-05-08: - get: - description: Removes the specified tags from the IAM instance profile. For more - information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagInstanceProfile - parameters: - - description: 'The name of the IAM instance profile from which you want - to remove tags.
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: - _+=,.@-
' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 + minLength: 1 + maxLength: 255 + type: string + Url: minLength: 1 - pattern: '[\w+=,.@-]+' + maxLength: 255 type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified instance profile. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 + ThumbprintList: type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagInstanceProfile - 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' - post: - description: Removes the specified tags from the IAM instance profile. For more - information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagInstanceProfileRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagInstanceProfile - /?Action=UntagMFADevice&Version=2010-05-08: - get: - description: Removes the specified tags from the IAM virtual multi-factor authentication - (MFA) device. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagMFADevice - parameters: - - description: 'The unique identifier for the IAM virtual MFA device from - which you want to remove tags. For virtual MFA devices, the serial number - is the same as the ARN.
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: - _+=,.@-
' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified instance profile. - in: query - name: TagKeys - required: true - schema: + x-insertionOrder: false items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagMFADevice - 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' - post: - description: Removes the specified tags from the IAM virtual multi-factor authentication - (MFA) device. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagMFADevice - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagMFADeviceRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagMFADevice - /?Action=UntagOpenIDConnectProvider&Version=2010-05-08: - get: - description: Removes the specified tags from the specified OpenID Connect (OIDC)-compatible - identity provider in IAM. For more information about OIDC providers, see About - web identity federation. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagOpenIDConnectProvider - parameters: - - description: 'The ARN of the OIDC provider in IAM from which you want to - remove tags.
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: - _+=,.@-
' - in: query - name: OpenIDConnectProviderArn - required: true - schema: - 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. -
- maxLength: 2048 + minLength: 40 + maxLength: 40 + pattern: '[0-9A-Fa-f]{40}' + type: string + maxItems: 5 + Arn: + description: Amazon Resource Name (ARN) of the OIDC provider minLength: 20 - type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified OIDC provider. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagOpenIDConnectProvider - 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' - post: - description: Removes the specified tags from the specified OpenID Connect (OIDC)-compatible - identity provider in IAM. For more information about OIDC providers, see About - web identity federation. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagOpenIDConnectProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagOpenIDConnectProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagOpenIDConnectProvider - /?Action=UntagPolicy&Version=2010-05-08: - get: - description: Removes the specified tags from the customer managed policy. For - more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagPolicy - parameters: - - description: 'The ARN of the IAM customer managed policy from which you - want to remove tags.
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: - _+=,.@-
' - in: query - name: PolicyArn - required: true - schema: - 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. -
maxLength: 2048 - minLength: 20 type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified policy. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 + Tags: type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagPolicy - 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' - post: - description: Removes the specified tags from the customer managed policy. For - more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagPolicy - /?Action=UntagRole&Version=2010-05-08: - get: - description: Removes the specified tags from the role. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagRole - parameters: - - description: 'The name of the IAM role from which you want to remove tags.
-This parameter accepts (through its regex - pattern) a string of characters that consist of upper and lowercase - alphanumeric characters with no spaces. You can also include any of the - following characters: _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified role. - in: query - name: TagKeys - required: true - schema: + uniqueItems: false + x-insertionOrder: false items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagRole - 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' - post: - description: Removes the specified tags from the role. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagRole - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagRoleRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagRole - /?Action=UntagSAMLProvider&Version=2010-05-08: - get: - description: Removes the specified tags from the specified Security Assertion - Markup Language (SAML) identity provider in IAM. For more information about - these providers, see About - web identity federation. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagSAMLProvider - parameters: - - description: 'The ARN of the SAML identity provider in IAM from which you - want to remove tags.
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: - _+=,.@-
' - in: query - name: SAMLProviderArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 + $ref: '#/components/schemas/Tag' + required: + - ThumbprintList + x-stackql-resource-name: oidc_provider + description: Resource Type definition for AWS::IAM::OIDCProvider + x-type-name: AWS::IAM::OIDCProvider + x-stackql-primary-identifier: + - Arn + x-create-only-properties: + - Url + x-read-only-properties: + - Arn + x-required-properties: + - ThumbprintList + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + x-required-permissions: + create: + - iam:CreateOpenIDConnectProvider + - iam:TagOpenIDConnectProvider + - iam:GetOpenIDConnectProvider + read: + - iam:GetOpenIDConnectProvider + update: + - iam:UpdateOpenIDConnectProviderThumbprint + - iam:RemoveClientIDFromOpenIDConnectProvider + - iam:AddClientIDToOpenIDConnectProvider + - iam:GetOpenIDConnectProvider + - iam:TagOpenIDConnectProvider + - iam:UntagOpenIDConnectProvider + - iam:ListOpenIDConnectProviderTags + delete: + - iam:DeleteOpenIDConnectProvider + list: + - iam:ListOpenIDConnectProvider + - iam:GetOpenIDConnectProvider + Role: + type: object + properties: + Arn: + description: '' type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified SAML identity provider. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagSAMLProvider - 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' - post: - description: Removes the specified tags from the specified Security Assertion - Markup Language (SAML) identity provider in IAM. For more information about - these providers, see About - web identity federation. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagSAMLProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagSAMLProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagSAMLProvider - /?Action=UntagServerCertificate&Version=2010-05-08: - get: - description:Removes the specified tags from the IAM server certificate. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
For certificates - in a Region supported by Certificate Manager (ACM), we recommend that you - don't use IAM server certificates. Instead, use ACM to provision, manage, - and deploy your server certificates. For more information about IAM server - certificates, Working - with server certificates in the IAM User Guide.
The name of the IAM server certificate from which you want - to remove tags.
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: - _+=,.@-
' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' + AssumeRolePolicyDocument: + description: >- + The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements + Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*. + type: object + Description: + description: A description of the role that you provide. type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified IAM server certificate. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 + ManagedPolicyArns: + description: |- + A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. + For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagServerCertificate - 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' - post: - description:Removes the specified tags from the IAM server certificate. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.
For certificates - in a Region supported by Certificate Manager (ACM), we recommend that you - don't use IAM server certificates. Instead, use ACM to provision, manage, - and deploy your server certificates. For more information about IAM server - certificates, Working - with server certificates in the IAM User Guide.
The name of the IAM user from which you want to remove tags.
-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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' + uniqueItems: true + x-insertionOrder: false + items: + type: string + MaxSessionDuration: + 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*. + type: integer + Path: + description: |- + The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) 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](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) 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. + default: / type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified user. - in: query - name: TagKeys - required: true - schema: + PermissionsBoundary: + 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*. + type: string + Policies: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM role. + When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). + A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. + For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. + If an external policy (such as ``AWS::IAM::Policy`` or + type: array + x-insertionOrder: false + uniqueItems: false items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 + $ref: '#/components/schemas/Policy' + RoleId: + description: '' + type: string + RoleName: + description: |- + A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1". + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use + type: string + Tags: + description: A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagUser - 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' - post: - description: Removes the specified tags from the user. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagUser - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagUserRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagUser - /?Action=UpdateAccessKey&Version=2010-05-08: - get: - description:Changes the status of the specified access key from Active to - Inactive, or vice versa. This operation can be used to disable a user's key - as part of a key rotation workflow.
If the UserName is
- not specified, the user name is determined implicitly based on the Amazon
- Web Services access key ID used to sign the request. This operation works
- for access keys under the Amazon Web Services account. Consequently, you can
- use this operation to manage Amazon Web Services account root user credentials
- even if the Amazon Web Services account has no associated users.
For - information about rotating keys, see Managing - keys and certificates in the IAM User Guide.
- operationId: GET_UpdateAccessKey - parameters: - - description: 'The name of the user whose key you want to update.
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: - _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - AssumeRolePolicyDocument + x-stackql-resource-name: role + description: |- + Creates a new role for your AWS-account. + For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::Role + x-stackql-primary-identifier: + - RoleName + x-create-only-properties: + - Path + - RoleName + x-read-only-properties: + - Arn + - RoleId + x-required-properties: + - AssumeRolePolicyDocument + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + x-required-permissions: + create: + - iam:CreateRole + - iam:PutRolePolicy + - iam:AttachRolePolicy + - iam:GetRolePolicy + - iam:TagRole + - iam:UntagRole + - iam:GetRole + read: + - iam:GetRole + - iam:ListAttachedRolePolicies + - iam:ListRolePolicies + - iam:GetRolePolicy + update: + - iam:UpdateRole + - iam:UpdateRoleDescription + - iam:UpdateAssumeRolePolicy + - iam:DetachRolePolicy + - iam:AttachRolePolicy + - iam:DeleteRolePermissionsBoundary + - iam:PutRolePermissionsBoundary + - iam:DeleteRolePolicy + - iam:PutRolePolicy + - iam:TagRole + - iam:UntagRole + delete: + - iam:DeleteRole + - iam:DetachRolePolicy + - iam:DeleteRolePolicy + - iam:GetRole + - iam:ListAttachedRolePolicies + - iam:ListRolePolicies + - iam:TagRole + - iam:UntagRole + list: + - iam:ListRoles + RolePolicy: + type: object + properties: + PolicyDocument: + description: |- + The policy document. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) 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``) + type: object + PolicyName: + description: |- + The name of the policy document. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- type: string - - description:The access key ID of the secret access key you want to update.
-This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.
- in: query - name: AccessKeyId - required: true - schema: + RoleName: + description: |- + The name of the role to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + type: string + required: + - PolicyName + - RoleName + x-stackql-resource-name: role_policy + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM role. + When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html). You can update a role's trust policy using [UpdateAssumeRolePolicy](https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html). For information about roles, see [roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) in the *IAM User Guide*. + A role can also have a managed policy attached to it. To attach a managed policy to a role, use [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. + For information about the maximum number of inline policies that you can embed with a role, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::RolePolicy + x-stackql-primary-identifier: + - PolicyName + - RoleName + x-create-only-properties: + - PolicyName + - RoleName + x-required-properties: + - PolicyName + - RoleName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - iam:PutRolePolicy + - iam:GetRolePolicy + read: + - iam:GetRolePolicy + update: + - iam:PutRolePolicy + - iam:GetRolePolicy + delete: + - iam:DeleteRolePolicy + - iam:GetRolePolicy + SAMLProvider: + type: object + properties: + Name: + minLength: 1 maxLength: 128 - minLength: 16 - pattern: '[\w]+' + pattern: '[\w._-]+' type: string - - description: ' The status you want to assign to the secret access key.Active
- means that the key can be used for programmatic calls to Amazon Web Services,
- while Inactive means that the key cannot be used.'
- in: query
- name: Status
- required: true
- schema:
- enum:
- - Active
- - Inactive
+ SamlMetadataDocument:
+ minLength: 1000
+ maxLength: 10000000
type: string
- responses:
- '200':
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/NoSuchEntityException'
- description: NoSuchEntityException
- '481':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/LimitExceededException'
- description: LimitExceededException
- '482':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ServiceFailureException'
- description: ServiceFailureException
- x-aws-operation-name: UpdateAccessKey
- 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'
- post:
- description: Changes the status of the specified access key from Active to - Inactive, or vice versa. This operation can be used to disable a user's key - as part of a key rotation workflow.
If the UserName is
- not specified, the user name is determined implicitly based on the Amazon
- Web Services access key ID used to sign the request. This operation works
- for access keys under the Amazon Web Services account. Consequently, you can
- use this operation to manage Amazon Web Services account root user credentials
- even if the Amazon Web Services account has no associated users.
For - information about rotating keys, see Managing - keys and certificates in the IAM User Guide.
- operationId: POST_UpdateAccessKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateAccessKeyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateAccessKey - /?Action=UpdateAccountPasswordPolicy&Version=2010-05-08: - get: - description:Updates the password policy settings for the Amazon Web Services - account.
This operation does not support partial updates. No - parameters are required, but if you do not specify a parameter, that parameter's - value reverts to its default value. See the Request Parameters section - for each parameter's default value. Also note that some parameters do not - allow the default parameter to be explicitly set. Instead, to invoke the default - value, do not include that parameter when you invoke the operation.
For more information about using a password policy, see Managing - an IAM password policy in the IAM User Guide.
- operationId: GET_UpdateAccountPasswordPolicy - parameters: - - description:The minimum number of characters allowed in an IAM user password.
-If you do not specify a value for this parameter, then the operation
- uses the default value of 6.
Specifies whether IAM user passwords must contain at least - one of the following non-alphanumeric characters:
! @ # $ % ^ & - * ( ) _ + - = [ ] { } | ''
If you do not specify a value for this
- parameter, then the operation uses the default value of false.
- The result is that passwords do not require at least one symbol character.
Specifies whether IAM user passwords must contain at least - one numeric character (0 to 9).
If you do not specify a value for
- this parameter, then the operation uses the default value of false.
- The result is that passwords do not require at least one numeric character.
Specifies whether IAM user passwords must contain at least - one uppercase character from the ISO basic Latin alphabet (A to Z).
-If you do not specify a value for this parameter, then the operation
- uses the default value of false. The result is that passwords
- do not require at least one uppercase character.
Specifies whether IAM user passwords must contain at least - one lowercase character from the ISO basic Latin alphabet (a to z).
-If you do not specify a value for this parameter, then the operation
- uses the default value of false. The result is that passwords
- do not require at least one lowercase character.
Allows all IAM users in your account to use the Amazon Web - Services Management Console to change their own passwords. For more information, - see Permitting - IAM users to change their own passwords in the IAM User Guide.
-If you do not specify a value for this parameter, then the operation
- uses the default value of false. The result is that IAM users
- in the account do not automatically have permissions to change their own
- password.
The number of days that an IAM user password is valid.
-If you do not specify a value for this parameter, then the operation
- uses the default value of 0. The result is that IAM user passwords
- never expire.
Specifies the number of previous passwords that IAM users - are prevented from reusing.
If you do not specify a value for this
- parameter, then the operation uses the default value of 0.
- The result is that IAM users are not prevented from reusing previous passwords.
Prevents IAM users who are accessing the account via the - Amazon Web Services Management Console from setting a new console password - after their password has expired. The IAM user cannot access the console - until an administrator resets the password.
If you do not specify
- a value for this parameter, then the operation uses the default value of
- false. The result is that IAM users can change their passwords
- after they expire and continue to sign in as the user.
In
- the Amazon Web Services Management Console, the custom password policy option
- Allow users to change their own password gives IAM users permissions
- to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy
- action. This option does not attach a permissions policy to each user, rather
- the permissions are applied at the account-level for all users by IAM. IAM
- users with iam:ChangePassword permission and active access
- keys can reset their own expired console password using the CLI or API.
Updates the password policy settings for the Amazon Web Services - account.
This operation does not support partial updates. No - parameters are required, but if you do not specify a parameter, that parameter's - value reverts to its default value. See the Request Parameters section - for each parameter's default value. Also note that some parameters do not - allow the default parameter to be explicitly set. Instead, to invoke the default - value, do not include that parameter when you invoke the operation.
For more information about using a password policy, see Managing - an IAM password policy in the IAM User Guide.
- operationId: POST_UpdateAccountPasswordPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateAccountPasswordPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateAccountPasswordPolicy - /?Action=UpdateAssumeRolePolicy&Version=2010-05-08: - get: - description: Updates the policy that grants an IAM entity permission to assume - a role. This is typically referred to as the "role trust policy". For more - information about roles, see Using - roles to delegate permissions and federate identities. - operationId: GET_UpdateAssumeRolePolicy - parameters: - - description: 'The name of the role to update with the new policy.
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: - _+=,.@-
' - in: query - name: RoleName - required: true - schema: - maxLength: 64 + Arn: + description: Amazon Resource Name (ARN) of the SAML provider minLength: 1 - pattern: '[\w+=,.@-]+' + maxLength: 1600 type: string - - description:The policy that grants an entity permission to assume the - role.
You must provide policies in JSON format in IAM. 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)
Updates the name and/or the path of the specified IAM group.
-You should understand the implications of changing a group's - path or name. For more information, see Renaming - users and groups in the IAM User Guide.
The person making the request (the principal), must have permission to
- change the role group with the old name and the new name. For example, to
- change the group named Managers to MGRs, the principal
- must have a policy that allows them to update both groups. If the principal
- has permission to update the Managers group, but not the MGRs
- group, then the update fails. For more information about permissions, see
- Access
- management.
Name of the IAM group to update. If you''re changing the - name of the group, this is the original name.
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: _+=,.@-
' - in: query - name: GroupName - required: true - schema: - maxLength: 128 + CertificateChain: minLength: 1 - pattern: '[\w+=,.@-]+' + maxLength: 2097152 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' type: string - - description:New path for the IAM group. Only include this if changing - the group's path.
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.
New name for the IAM group. Only include this if changing - the group's name.
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".
- in: query - name: NewGroupName - required: false - schema: maxLength: 128 - minLength: 1 pattern: '[\w+=,.@-]+' type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateGroup - 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' - post: - description:Updates the name and/or the path of the specified IAM group.
-You should understand the implications of changing a group's - path or name. For more information, see Renaming - users and groups in the IAM User Guide.
The person making the request (the principal), must have permission to
- change the role group with the old name and the new name. For example, to
- change the group named Managers to MGRs, the principal
- must have a policy that allows them to update both groups. If the principal
- has permission to update the Managers group, but not the MGRs
- group, then the update fails. For more information about permissions, see
- Access
- management.
Changes the password for the specified IAM user. You can use - the CLI, the Amazon Web Services API, or the Users page in the IAM - console to change the password for any IAM user. Use ChangePassword - to change your own password in the My Security Credentials page in - the Amazon Web Services Management Console.
For more information about - modifying passwords, see Managing - passwords in the IAM User Guide.
- operationId: GET_UpdateLoginProfile - parameters: - - description: 'The name of the user whose password you want to update.
-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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 64 + Path: minLength: 1 - pattern: '[\w+=,.@-]+' + maxLength: 512 + pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) type: string - - description:The new password for the specified IAM user.
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)
However, the format - can be further restricted by the account administrator by setting a password - policy on the Amazon Web Services account. For more information, see UpdateAccountPasswordPolicy.
- in: query - name: Password - required: false - schema: - format: password - maxLength: 128 + PrivateKey: minLength: 1 + maxLength: 16384 pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' type: string - - description: Allows this new password to be used only once by requiring the - specified IAM user to set a new password on next sign-in. - in: query - name: PasswordResetRequired - required: false - schema: - type: boolean - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PasswordPolicyViolationException' - description: PasswordPolicyViolationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateLoginProfile - 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' - post: - description:Changes the password for the specified IAM user. You can use - the CLI, the Amazon Web Services API, or the Users page in the IAM - console to change the password for any IAM user. Use ChangePassword - to change your own password in the My Security Credentials page in - the Amazon Web Services Management Console.
For more information about - modifying passwords, see Managing - passwords in the IAM User Guide.
- operationId: POST_UpdateLoginProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateLoginProfileRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PasswordPolicyViolationException' - description: PasswordPolicyViolationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateLoginProfile - /?Action=UpdateOpenIDConnectProviderThumbprint&Version=2010-05-08: - get: - description:Replaces the existing list of server certificate thumbprints - associated with an OpenID Connect (OIDC) provider resource object with a new - list of thumbprints.
The list that you pass with this operation completely - replaces the existing list of thumbprints. (The lists are not merged.)
-Typically, you need to update a thumbprint only when the identity provider - certificate changes, which occurs rarely. However, if the provider's certificate - does change, any attempt to assume an IAM role that specifies the OIDC - provider as a principal fails until the certificate thumbprint is updated.
-Amazon Web Services secures communication with some OIDC identity - providers (IdPs) through our library of trusted certificate authorities (CAs) - instead of using a certificate thumbprint to verify your IdP server certificate. - These OIDC IdPs include Google, and those that use an Amazon S3 bucket to - host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint - remains in your configuration, but is no longer used for validation.
Trust for the OIDC provider is derived from the provider certificate
- and is validated by the thumbprint. Therefore, it is best to limit access
- to the UpdateOpenIDConnectProviderThumbprint operation to highly
- privileged users.
The Amazon Resource Name (ARN) of the IAM OIDC provider resource - object for which you want to update the thumbprint. You can get a list of - OIDC provider ARNs by using the ListOpenIDConnectProviders operation.
-For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: OpenIDConnectProviderArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 - type: string - - description: 'A list of certificate thumbprints that are associated with the - specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider. ' - in: query - name: ThumbprintList - required: true - schema: - description: Contains a list of thumbprints of identity provider server - certificates. - items: - allOf: - - $ref: '#/components/schemas/thumbprintType' - - xml: - name: member - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateOpenIDConnectProviderThumbprint - 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' - post: - description:Replaces the existing list of server certificate thumbprints - associated with an OpenID Connect (OIDC) provider resource object with a new - list of thumbprints.
The list that you pass with this operation completely - replaces the existing list of thumbprints. (The lists are not merged.)
-Typically, you need to update a thumbprint only when the identity provider - certificate changes, which occurs rarely. However, if the provider's certificate - does change, any attempt to assume an IAM role that specifies the OIDC - provider as a principal fails until the certificate thumbprint is updated.
-Amazon Web Services secures communication with some OIDC identity - providers (IdPs) through our library of trusted certificate authorities (CAs) - instead of using a certificate thumbprint to verify your IdP server certificate. - These OIDC IdPs include Google, and those that use an Amazon S3 bucket to - host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint - remains in your configuration, but is no longer used for validation.
Trust for the OIDC provider is derived from the provider certificate
- and is validated by the thumbprint. Therefore, it is best to limit access
- to the UpdateOpenIDConnectProviderThumbprint operation to highly
- privileged users.
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 maximum 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.
Use UpdateRole instead.
Modifies only the description
- of a role. This operation performs the same function as the Description
- parameter in the UpdateRole operation.
Use UpdateRole instead.
Modifies only the description
- of a role. This operation performs the same function as the Description
- parameter in the UpdateRole operation.
Updates the metadata document for an existing SAML provider - resource object.
This operation requires Signature - Version 4.
The Amazon Resource Name (ARN) of the SAML provider to update.
-For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.
- in: query - name: SAMLProviderArn - required: true - schema: - 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. -
- maxLength: 2048 - minLength: 20 + AWSServiceName: + description: The service principal for the AWS service to which this role is attached. + type: string + required: [] + x-stackql-resource-name: service_linked_role + description: Resource Type definition for AWS::IAM::ServiceLinkedRole + x-type-name: AWS::IAM::ServiceLinkedRole + x-stackql-primary-identifier: + - RoleName + x-create-only-properties: + - CustomSuffix + - AWSServiceName + x-write-only-properties: + - CustomSuffix + - AWSServiceName + x-read-only-properties: + - RoleName + x-required-properties: [] + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - iam:CreateServiceLinkedRole + - iam:GetRole + read: + - iam:GetRole + update: + - iam:UpdateRole + - iam:GetRole + delete: + - iam:DeleteServiceLinkedRole + - iam:GetServiceLinkedRoleDeletionStatus + - iam:GetRole + LoginProfile: + description: Creates a password for the specified user, giving the user the ability to access AWS services through the console. For more information about managing passwords, see [Managing Passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*. + type: object + additionalProperties: false + properties: + PasswordResetRequired: + description: Specifies whether the user is required to set a new password on next sign-in. + type: boolean + Password: + description: The user's password. type: string - responses: - '200': - content: - text/xml: - schema: - properties: - UpdateSAMLProviderResult: - $ref: '#/components/schemas/UpdateSAMLProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateSAMLProvider - 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' - post: - description:Updates the metadata document for an existing SAML provider - resource object.
This operation requires Signature - Version 4.
Sets the status of an IAM user's SSH public key to active or - inactive. SSH public keys that are inactive cannot be used for authentication. - This operation can be used to disable a user's SSH public key as part of a - key rotation work flow.
The SSH public key affected by this operation - is used only for authenticating the associated IAM user to an CodeCommit repository. - For more information about using SSH keys to authenticate to an CodeCommit - repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.
- operationId: GET_UpdateSSHPublicKey - parameters: - - description: 'The name of the IAM user associated with the SSH public key.
-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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' + required: + - Password + User: + type: object + properties: + Path: + description: |- + The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) 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](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) 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. + type: string + ManagedPolicyArns: + description: |- + A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user. + For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + Policies: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user). + The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. + For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Policy' + UserName: + description: |- + The name of the user to create. Do not include the path in this value. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john". + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. type: string - - description:The unique identifier for the SSH public key.
This - parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.
- in: query - name: SSHPublicKeyId - required: true - schema: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' + Groups: + description: A list of group names to which you want to add the user. + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + Arn: + description: '' type: string - - description: The status to assign to the SSH public key.Active
- means that the key can be used for authentication with an CodeCommit repository.
- Inactive means that the key cannot be used.
- in: query
- name: Status
- required: true
- schema:
- enum:
- - Active
- - Inactive
+ LoginProfile:
+ description: |-
+ Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console.
+ You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console.
+ For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.
+ $ref: '#/components/schemas/LoginProfile'
+ Tags:
+ description: |-
+ A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) 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.
+ type: array
+ uniqueItems: false
+ x-insertionOrder: false
+ items:
+ $ref: '#/components/schemas/Tag'
+ PermissionsBoundary:
+ description: |-
+ The ARN of the managed policy that is used to set the permissions boundary for the user.
+ 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
+ For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.
+ type: string
+ x-stackql-resource-name: user
+ description: |-
+ Creates a new IAM user for your AWS-account.
+ For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
+ x-type-name: AWS::IAM::User
+ x-stackql-primary-identifier:
+ - UserName
+ x-create-only-properties:
+ - UserName
+ x-write-only-properties:
+ - LoginProfile/Password
+ x-read-only-properties:
+ - Arn
+ x-tagging:
+ taggable: true
+ tagOnCreate: true
+ tagUpdatable: true
+ cloudFormationSystemTags: false
+ tagProperty: /properties/Tags
+ x-required-permissions:
+ create:
+ - iam:CreateLoginProfile
+ - iam:AddUserToGroup
+ - iam:PutUserPolicy
+ - iam:AttachUserPolicy
+ - iam:CreateUser
+ - iam:GetUser
+ - iam:TagUser
+ read:
+ - iam:GetUserPolicy
+ - iam:ListGroupsForUser
+ - iam:ListAttachedUserPolicies
+ - iam:ListUserPolicies
+ - iam:GetUser
+ - iam:GetLoginProfile
+ update:
+ - iam:UpdateLoginProfile
+ - iam:UpdateUser
+ - iam:PutUserPermissionsBoundary
+ - iam:AttachUserPolicy
+ - iam:DeleteUserPolicy
+ - iam:DeleteUserPermissionsBoundary
+ - iam:TagUser
+ - iam:UntagUser
+ - iam:CreateLoginProfile
+ - iam:RemoveUserFromGroup
+ - iam:AddUserToGroup
+ - iam:PutUserPolicy
+ - iam:DetachUserPolicy
+ - iam:GetLoginProfile
+ - iam:DeleteLoginProfile
+ - iam:GetUser
+ - iam:ListUserTags
+ delete:
+ - iam:DeleteAccessKey
+ - iam:RemoveUserFromGroup
+ - iam:DeleteUserPolicy
+ - iam:DeleteUser
+ - iam:DetachUserPolicy
+ - iam:DeleteLoginProfile
+ - iam:ListAccessKeys
+ - iam:GetUserPolicy
+ - iam:ListGroupsForUser
+ - iam:ListAttachedUserPolicies
+ - iam:ListUserPolicies
+ - iam:GetUser
+ - iam:GetLoginProfile
+ list:
+ - iam:listUsers
+ UserPolicy:
+ type: object
+ properties:
+ PolicyDocument:
+ description: |-
+ The policy document.
+ You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.
+ The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) 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``)
+ type: object
+ PolicyName:
+ description: |-
+ The name of the policy document.
+ This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
type: string
- responses:
- '200':
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/NoSuchEntityException'
- description: NoSuchEntityException
- x-aws-operation-name: UpdateSSHPublicKey
- 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'
- post:
- description: Sets the status of an IAM user's SSH public key to active or - inactive. SSH public keys that are inactive cannot be used for authentication. - This operation can be used to disable a user's SSH public key as part of a - key rotation work flow.
The SSH public key affected by this operation - is used only for authenticating the associated IAM user to an CodeCommit repository. - For more information about using SSH keys to authenticate to an CodeCommit - repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.
- operationId: POST_UpdateSSHPublicKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateSSHPublicKeyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: UpdateSSHPublicKey - /?Action=UpdateServerCertificate&Version=2010-05-08: - get: - description:Updates the name and/or the path of the specified server certificate - stored in IAM.
For more information about working with server certificates, - see Working - with server certificates in the IAM User Guide. This topic also - includes a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.
You should understand the implications - of changing a server certificate's path or name. For more information, see - Renaming - a server certificate in the IAM User Guide.
The person making the request (the principal), must have permission to
- change the server certificate with the old name and the new name. For example,
- to change the certificate named ProductionCert to ProdCert,
- the principal must have a policy that allows them to update both certificates.
- If the principal has permission to update the ProductionCert
- group, but not the ProdCert certificate, then the update fails.
- For more information about permissions, see Access
- management in the IAM User Guide.
The name of the server certificate that you want to update.
-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: - _+=,.@-
' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 + UserName: + description: |- + The name of the user to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + type: string + required: + - PolicyName + - UserName + x-stackql-resource-name: user_policy + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM user. + An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use [AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. + For information about the maximum number of inline policies that you can embed in a user, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::UserPolicy + x-stackql-primary-identifier: + - PolicyName + - UserName + x-create-only-properties: + - PolicyName + - UserName + x-required-properties: + - PolicyName + - UserName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - iam:PutUserPolicy + - iam:GetUserPolicy + read: + - iam:GetUserPolicy + update: + - iam:PutUserPolicy + - iam:GetUserPolicy + delete: + - iam:DeleteUserPolicy + - iam:GetUserPolicy + VirtualMFADevice: + type: object + properties: + VirtualMfaDeviceName: minLength: 1 + maxLength: 226 pattern: '[\w+=,.@-]+' type: string - - description:The new path for the server certificate. Include this only - if you are updating the server certificate's path.
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 new name for the server certificate. Include this only - if you are updating the server certificate''s name. The name of the certificate - cannot contain any spaces.
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: _+=,.@-
' - in: query - name: NewServerCertificateName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateServerCertificate - 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' - post: - description:Updates the name and/or the path of the specified server certificate - stored in IAM.
For more information about working with server certificates, - see Working - with server certificates in the IAM User Guide. This topic also - includes a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.
You should understand the implications - of changing a server certificate's path or name. For more information, see - Renaming - a server certificate in the IAM User Guide.
The person making the request (the principal), must have permission to
- change the server certificate with the old name and the new name. For example,
- to change the certificate named ProductionCert to ProdCert,
- the principal must have a policy that allows them to update both certificates.
- If the principal has permission to update the ProductionCert
- group, but not the ProdCert certificate, then the update fails.
- For more information about permissions, see Access
- management in the IAM User Guide.
Active
- or Inactive. Service-specific credentials that are inactive cannot
- be used for authentication to the service. This operation can be used to disable
- a user's service-specific credential as part of a credential rotation work
- flow.
- operationId: GET_UpdateServiceSpecificCredential
- parameters:
- - description: 'The name of the IAM user associated with the service-specific - credential. If you do not specify this value, then the operation assumes - the user whose credentials are used to call the operation.
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: _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' + SerialNumber: + minLength: 9 + maxLength: 256 + pattern: '[\w+=/:,.@-]+' type: string - - description:The unique identifier of the service-specific credential.
-This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.
- in: query - name: ServiceSpecificCredentialId - required: true - schema: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' + Users: + type: array + uniqueItems: false + items: + type: string + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + required: + - Users + x-stackql-resource-name: virtualmfa_device + description: Resource Type definition for AWS::IAM::VirtualMFADevice + x-type-name: AWS::IAM::VirtualMFADevice + x-stackql-primary-identifier: + - SerialNumber + x-create-only-properties: + - VirtualMfaDeviceName + - Base32StringSeed + - Path + x-read-only-properties: + - SerialNumber + x-required-properties: + - Users + x-required-permissions: + create: + - iam:CreateVirtualMFADevice + - iam:EnableMFADevice + - iam:ListVirtualMFADevices + read: + - iam:ListVirtualMFADevices + update: + - iam:TagMFADevice + - iam:UntagMFADevice + delete: + - iam:DeleteVirtualMFADevice + - iam:DeactivateMFADevice + list: + - iam:ListVirtualMFADevices + region: + type: string + description: The AWS region (always `us-east-1` for IAM resources) + user_policies: + description: List of user policies by UserName (requires `aws` provider to be installed) + type: object + additionalProperties: false + properties: + UserName: type: string - - description: The status to be assigned to the service-specific credential. - in: query - name: Status - required: true - schema: - enum: - - Active - - Inactive + description: The IAM user name + member: type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: UpdateServiceSpecificCredential - 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' - post: - description: Sets the status of a service-specific credential toActive
- or Inactive. Service-specific credentials that are inactive cannot
- be used for authentication to the service. This operation can be used to disable
- a user's service-specific credential as part of a credential rotation work
- flow.
- operationId: POST_UpdateServiceSpecificCredential
- parameters: []
- requestBody:
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/UpdateServiceSpecificCredentialRequest'
- responses:
- '200':
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/NoSuchEntityException'
- description: NoSuchEntityException
- x-aws-operation-name: UpdateServiceSpecificCredential
- /?Action=UpdateSigningCertificate&Version=2010-05-08:
- get:
- description: Changes the status of the specified user signing certificate - from active to disabled, or vice versa. This operation can be used to disable - an IAM user's signing certificate as part of a certificate rotation work flow.
-If the UserName field is not specified, the user name is determined
- implicitly based on the Amazon Web Services access key ID used to sign the
- request. This operation works for access keys under the Amazon Web Services
- account. Consequently, you can use this operation to manage Amazon Web Services
- account root user credentials even if the Amazon Web Services account has
- no associated users.
The name of the IAM user the signing certificate belongs - to.
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: - _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' + description: The user policy name + region: + $ref: '#/components/schemas/region' + x-example-where-clause: WHERE UserName = 'The ID of the signing certificate you want to update.
-This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.
- in: query - name: CertificateId - required: true - schema: - maxLength: 128 - minLength: 24 - pattern: '[\w]+' + description: The IAM group name + PolicyName: type: string - - description: ' The status you want to assign to the certificate.Active
- means that the certificate can be used for programmatic calls to Amazon
- Web Services Inactive means that the certificate cannot be
- used.'
- in: query
- name: Status
- required: true
- schema:
- enum:
- - Active
- - Inactive
+ description: The group policy name
+ PolicyDocument:
type: string
- responses:
- '200':
- description: Success
- '480':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/NoSuchEntityException'
- description: NoSuchEntityException
- '481':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/LimitExceededException'
- description: LimitExceededException
- '482':
- content:
- text/xml:
- schema:
- $ref: '#/components/schemas/ServiceFailureException'
- description: ServiceFailureException
- x-aws-operation-name: UpdateSigningCertificate
- 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'
- post:
- description: Changes the status of the specified user signing certificate - from active to disabled, or vice versa. This operation can be used to disable - an IAM user's signing certificate as part of a certificate rotation work flow.
-If the UserName field is not specified, the user name is determined
- implicitly based on the Amazon Web Services access key ID used to sign the
- request. This operation works for access keys under the Amazon Web Services
- account. Consequently, you can use this operation to manage Amazon Web Services
- account root user credentials even if the Amazon Web Services account has
- no associated users.
Updates the name and/or the path of the specified IAM user.
-You should understand the implications of changing an IAM - user's path or name. For more information, see Renaming - an IAM user and Renaming - an IAM group in the IAM User Guide.
- To change a user name, the requester must have appropriate permissions on - both the source object and the target object. For example, to change Bob to - Robert, the entity making the request must have permission on Bob and Robert, - or must have permission on all (*). For more information about permissions, - see Permissions - and policies.
Name of the user to update. If you''re changing the name - of the user, this is the original user name.
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: _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' + description: The group policy document + region: + $ref: '#/components/schemas/region' + x-example-where-clause: WHERE GroupName = 'New path for the IAM user. Include this parameter only if - you're changing the user's path.
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.
New name for the user. Include this parameter only if you're - changing the user's name.
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".
- in: query - name: NewUserName - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' + description: The role policy name + PolicyDocument: type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateUser - 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' - post: - description:Updates the name and/or the path of the specified IAM user.
-You should understand the implications of changing an IAM - user's path or name. For more information, see Renaming - an IAM user and Renaming - an IAM group in the IAM User Guide.
- To change a user name, the requester must have appropriate permissions on - both the source object and the target object. For example, to change Bob to - Robert, the entity making the request must have permission on Bob and Robert, - or must have permission on all (*). For more information about permissions, - see Permissions - and policies.
Uploads an SSH public key and associates it with the specified - IAM user.
The SSH public key uploaded by this operation can be used - only for authenticating the associated IAM user to an CodeCommit repository. - For more information about using SSH keys to authenticate to an CodeCommit - repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.
- operationId: GET_UploadSSHPublicKey - parameters: - - description: 'The name of the IAM user to associate the SSH public key - with.
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: - _+=,.@-
' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' + description: The role policy document + region: + $ref: '#/components/schemas/region' + x-example-where-clause: WHERE RoleName = 'The SSH public key. The public key must be encoded in ssh-rsa - format or PEM format. The minimum bit-length of the public key is 2048 bits. - For example, you can generate a 2048-bit key, and the resulting PEM file - is 1679 bytes long.
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)
Uploads an SSH public key and associates it with the specified - IAM user.
The SSH public key uploaded by this operation can be used - only for authenticating the associated IAM user to an CodeCommit repository. - For more information about using SSH keys to authenticate to an CodeCommit - repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.
- operationId: POST_UploadSSHPublicKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UploadSSHPublicKeyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - UploadSSHPublicKeyResult: - $ref: '#/components/schemas/UploadSSHPublicKeyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidPublicKeyException' - description: InvalidPublicKeyException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/DuplicateSSHPublicKeyException' - description: DuplicateSSHPublicKeyException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnrecognizedPublicKeyEncodingException' - description: UnrecognizedPublicKeyEncodingException - x-aws-operation-name: UploadSSHPublicKey - /?Action=UploadServerCertificate&Version=2010-05-08: - get: - description:Uploads a server certificate entity for the Amazon Web Services - account. The server certificate entity includes a public key certificate, - a private key, and an optional certificate chain, which should all be PEM-encoded.
-We recommend that you use Certificate - Manager to provision, manage, and deploy your server certificates. With - ACM you can request a certificate, deploy it to Amazon Web Services resources, - and let ACM handle certificate renewals for you. Certificates provided by - ACM are free. For more information about using ACM, see the Certificate - Manager User Guide.
For more information about working with server - certificates, see Working - with server certificates in the IAM User Guide. This topic includes - a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.
For information about the number of server - certificates you can upload, see IAM - and STS quotas in the IAM User Guide.
Because the
- body of the public key certificate, private key, and the certificate chain
- can be large, you should use POST rather than GET when calling UploadServerCertificate.
- For information about setting up signatures and authorization through the
- API, see Signing
- Amazon Web Services API requests in the Amazon Web Services General
- Reference. For general information about using the Query API with IAM,
- see Calling
- the API by making HTTP query requests in the IAM User Guide.
The path for the server certificate. 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.
If you are uploading
- a server certificate specifically for use with Amazon CloudFront distributions,
- you must specify a path using the path parameter. The path
- must begin with /cloudfront and must include a trailing slash
- (for example, /cloudfront/test/).
The name for the server certificate. Do not include the path - in this value. The name of the certificate cannot contain any spaces.
-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: - _+=,.@-
' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' + description: The creation date for the policy + DefaultVersionId: type: string - - description:The contents of the public key certificate in PEM-encoded - format.
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)
The contents of the private key in PEM-encoded format.
-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)
The contents of the certificate chain. This is typically a - concatenation of the PEM-encoded public key certificates of the chain.
-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)
A list of tags that you want to attach to the new IAM server - certificate resource. 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.
Uploads a server certificate entity for the Amazon Web Services - account. The server certificate entity includes a public key certificate, - a private key, and an optional certificate chain, which should all be PEM-encoded.
-We recommend that you use Certificate - Manager to provision, manage, and deploy your server certificates. With - ACM you can request a certificate, deploy it to Amazon Web Services resources, - and let ACM handle certificate renewals for you. Certificates provided by - ACM are free. For more information about using ACM, see the Certificate - Manager User Guide.
For more information about working with server - certificates, see Working - with server certificates in the IAM User Guide. This topic includes - a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.
For information about the number of server - certificates you can upload, see IAM - and STS quotas in the IAM User Guide.
Because the
- body of the public key certificate, private key, and the certificate chain
- can be large, you should use POST rather than GET when calling UploadServerCertificate.
- For information about setting up signatures and authorization through the
- API, see Signing
- Amazon Web Services API requests in the Amazon Web Services General
- Reference. For general information about using the Query API with IAM,
- see Calling
- the API by making HTTP query requests in the IAM User Guide.
Uploads an X.509 signing certificate and associates it with
- the specified IAM user. Some Amazon Web Services services require you to use
- certificates to validate requests that are signed with a corresponding private
- key. When you upload the certificate, its default status is Active.
For information about when you would use an X.509 signing certificate, - see Managing - server certificates in IAM in the IAM User Guide.
If the
- UserName is not specified, the IAM user name is determined implicitly
- based on the Amazon Web Services access key ID used to sign the request. This
- operation works for access keys under the Amazon Web Services account. Consequently,
- you can use this operation to manage Amazon Web Services account root user
- credentials even if the Amazon Web Services account has no associated users.
Because the body of an X.509 certificate can be large, you should
- use POST rather than GET when calling UploadSigningCertificate.
- For information about setting up signatures and authorization through the
- API, see Signing
- Amazon Web Services API requests in the Amazon Web Services General
- Reference. For general information about using the Query API with IAM,
- see Making
- query requests in the IAM User Guide.
The name of the user the signing certificate is for.
-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: - _+=,.@-
' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:The contents of the signing certificate.
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)
Uploads an X.509 signing certificate and associates it with
- the specified IAM user. Some Amazon Web Services services require you to use
- certificates to validate requests that are signed with a corresponding private
- key. When you upload the certificate, its default status is Active.
For information about when you would use an X.509 signing certificate, - see Managing - server certificates in IAM in the IAM User Guide.
If the
- UserName is not specified, the IAM user name is determined implicitly
- based on the Amazon Web Services access key ID used to sign the request. This
- operation works for access keys under the Amazon Web Services account. Consequently,
- you can use this operation to manage Amazon Web Services account root user
- credentials even if the Amazon Web Services account has no associated users.
Because the body of an X.509 certificate can be large, you should
- use POST rather than GET when calling UploadSigningCertificate.
- For information about setting up signatures and authorization through the
- API, see Signing
- Amazon Web Services API requests in the Amazon Web Services General
- Reference. For general information about using the Query API with IAM,
- see Making
- query requests in the IAM User Guide.
An object that contains details about when a principal in the + reported Organizations entity last attempted to access an Amazon Web Services + service. A principal can be an IAM user, an IAM role, or the Amazon Web Services + account root user within the reported Organizations entity.
This data + type is a response element in the GetOrganizationsAccessReport operation.
+ properties: + EntityPath: + allOf: + - $ref: '#/components/schemas/organizationsEntityPathType' + - description:The path of the Organizations entity (root, organizational + unit, or account) from which an authenticated principal last attempted + to access the service. Amazon Web Services does not report unauthenticated + requests.
This field is null if no principals (IAM users, IAM + roles, or root users) in the reported Organizations entity attempted + to access the service within the reporting + period.
+ LastAuthenticatedTime: + allOf: + - $ref: '#/components/schemas/dateType' + - description: "The date and time, in\_ISO 8601 date-time format, when an authenticated principal most\ + \ recently attempted to access the service. Amazon Web Services does\ + \ not report unauthenticated requests.
This field is null if\ + \ no principals in the reported Organizations entity attempted to access\ + \ the service within the reporting period.
" + Region: + allOf: + - $ref: '#/components/schemas/stringType' + - description:The Region where the last service access attempt occurred.
+This field is null if no principals in the reported Organizations + entity attempted to access the service within the reporting + period.
+ ServiceName: + allOf: + - $ref: '#/components/schemas/serviceNameType' + - description: The name of the service in which access was attempted. + ServiceNamespace: + allOf: + - $ref: '#/components/schemas/serviceNamespaceType' + - description: "The namespace of the service in which access was attempted.
\ + \To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services\
+ \ in the Service Authorization Reference. Choose the name of\
+ \ the service to view details for that service. In the first paragraph,\
+ \ find the service prefix. For example, (service prefix: a4b).\
+ \ For more information about service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\
+ \ General Reference.
Contains information about an Amazon Web Services access key.
+This data type is used as a response element in the CreateAccessKey + and ListAccessKeys operations.
The SecretAccessKey
+ value is returned only in response to CreateAccessKey. You can get
+ a secret access key only when you first create an access key; you cannot recover
+ the secret access key later. If you lose a secret access key, you must create
+ a new access key.
Active means
+ that the key is valid for API calls, while Inactive means
+ it is not. '
+ UserName:
+ allOf:
+ - $ref: '#/components/schemas/userNameType'
+ - description: The name of the IAM user that the access key is associated
+ with.
+ required:
+ - UserName
+ - AccessKeyId
+ - Status
+ - SecretAccessKey
+ type: object
+ AccessKeyLastUsed:
+ description: Contains information about the last time an Amazon Web Services + access key was used since IAM began tracking this information on April 22, + 2015.
This data type is used as a response element in the GetAccessKeyLastUsed + operation.
+ properties: + LastUsedDate: + allOf: + - $ref: '#/components/schemas/dateType' + - description:The date and time, in ISO + 8601 date-time format, when the access key was most recently used. + This field is null in the following situations:
The + user does not have an access key.
An access key exists + but has not been used since IAM began tracking this information.
+There is no sign-in data associated with the user.
+The Amazon Web Services Region where this access key was + most recently used. The value for this field is "N/A" in the following + situations:
The user does not have an access key.
+An access key exists but has not been used since IAM began + tracking this information.
There is no sign-in data + associated with the user.
For more information about + Amazon Web Services Regions, see Regions + and endpoints in the Amazon Web Services General Reference.
+ ServiceName: + allOf: + - $ref: '#/components/schemas/stringType' + - description:The name of the Amazon Web Services service with which + this access key was most recently used. The value of this field is "N/A" + in the following situations:
The user does not have + an access key.
An access key exists but has not been + used since IAM started tracking this information.
There + is no sign-in data associated with the user.
Contains information about an Amazon Web Services access key, + without its secret key.
This data type is used as a response element + in the ListAccessKeys operation.
+ properties: + AccessKeyId: + allOf: + - $ref: '#/components/schemas/accessKeyIdType' + - description: The ID for this access key. + CreateDate: + allOf: + - $ref: '#/components/schemas/dateType' + - description: The date when the access key was created. + Status: + allOf: + - $ref: '#/components/schemas/statusType' + - description: The status of the access key.Active means that
+ the key is valid for API calls; Inactive means it is not.
+ UserName:
+ allOf:
+ - $ref: '#/components/schemas/userNameType'
+ - description: The name of the IAM user that the key is associated with.
+ type: object
+ ActionNameListType:
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ActionNameType'
+ - xml:
+ name: member
+ type: array
+ ActionNameType:
+ maxLength: 128
+ minLength: 3
+ type: string
+ AddClientIDToOpenIDConnectProviderRequest:
+ properties:
+ ClientID:
+ allOf:
+ - $ref: '#/components/schemas/clientIDType'
+ - description: The client ID (also known as audience) to add to the IAM
+ OpenID Connect provider resource.
+ OpenIDConnectProviderArn:
+ allOf:
+ - $ref: '#/components/schemas/arnType'
+ - description: The Amazon Resource Name (ARN) of the IAM OpenID Connect
+ (OIDC) provider resource to add the client ID to. You can get a list
+ of OIDC provider ARNs by using the ListOpenIDConnectProviders
+ operation.
+ required:
+ - OpenIDConnectProviderArn
+ - ClientID
+ title: AddClientIDToOpenIDConnectProviderRequest
+ type: object
+ AddRoleToInstanceProfileRequest:
+ properties:
+ InstanceProfileName:
+ allOf:
+ - $ref: '#/components/schemas/instanceProfileNameType'
+ - description: 'The name of the instance profile to update.
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: _+=,.@-
' + RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: 'The name of the role to add.
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: _+=,.@-
' + required: + - InstanceProfileName + - RoleName + title: AddRoleToInstanceProfileRequest + type: object + AddUserToGroupRequest: + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: 'The name of the group to update.
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: _+=,.@-
' + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: 'The name of the user to add.
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: _+=,.@-
' + required: + - GroupName + - UserName + title: AddUserToGroupRequest + type: object + ArnListType: + items: + allOf: + - $ref: '#/components/schemas/arnType' + - xml: + name: member + type: array + AttachGroupPolicyRequest: + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: 'The name (friendly name, not ARN) of the group to attach + the policy to.
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: _+=,.@-
' + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:The Amazon Resource Name (ARN) of the IAM policy you want + to attach.
For more information about ARNs, see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ required: + - GroupName + - PolicyArn + title: AttachGroupPolicyRequest + type: object + AttachRolePolicyRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:The Amazon Resource Name (ARN) of the IAM policy you want + to attach.
For more information about ARNs, see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: 'The name (friendly name, not ARN) of the role to attach + the policy to.
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: _+=,.@-
' + required: + - RoleName + - PolicyArn + title: AttachRolePolicyRequest + type: object + AttachUserPolicyRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:The Amazon Resource Name (ARN) of the IAM policy you want + to attach.
For more information about ARNs, see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ UserName: + allOf: + - $ref: '#/components/schemas/userNameType' + - description: 'The name (friendly name, not ARN) of the IAM user to + attach the policy to.
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: _+=,.@-
' + required: + - UserName + - PolicyArn + title: AttachUserPolicyRequest + type: object + AttachedPermissionsBoundary: + 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.
+ properties: + PermissionsBoundaryArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description: ' The ARN of the policy used to set the permissions boundary + for the user or role.' + 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.'
+ type: object
+ AttachedPolicy:
+ description: Contains information about an attached policy.
An attached + policy is a managed policy that has been attached to a user, group, or role. + This data type is used as a response element in the ListAttachedGroupPolicies, + ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails + operations.
For more information about managed policies, refer to + Managed + policies and inline policies in the IAM User Guide.
+ properties: + PolicyArn: + $ref: '#/components/schemas/arnType' + PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: The friendly name of the attached policy. + type: object + BootstrapDatum: + format: password + type: string + ChangePasswordRequest: + properties: + NewPassword: + allOf: + - $ref: '#/components/schemas/passwordType' + - description:The new password. The new password must conform to the + Amazon Web Services account's password policy, if one exists.
The
+ regex pattern that is
+ used to validate this parameter is a string of characters. That string
+ can include almost any printable ASCII character from the space (\u0020)
+ through the end of the ASCII character range (\u00FF).
+ You can also include the tab (\u0009), line feed (\u000A),
+ and carriage return (\u000D) characters. Any of these characters
+ are valid in a password. However, many tools, such as the Amazon Web
+ Services Management Console, might restrict the ability to type certain
+ characters because they have special meaning within that tool.
Contains information about a condition context key. It includes
+ the name of the key and specifies the value (or values, if the context key
+ supports multiple values) to use in the simulation. This information is used
+ when evaluating the Condition elements of the input policies.
This data type is used as an input parameter to SimulateCustomPolicy + and SimulatePrincipalPolicy.
+ properties: + ContextKeyName: + allOf: + - $ref: '#/components/schemas/ContextKeyNameType' + - description: The full name of a condition context key, including the service + prefix. For example,aws:SourceIp or s3:VersionId.
+ ContextKeyType:
+ allOf:
+ - $ref: '#/components/schemas/ContextKeyTypeEnum'
+ - description: The data type of the value (or values) specified in the ContextKeyValues
+ parameter.
+ ContextKeyValues:
+ allOf:
+ - $ref: '#/components/schemas/ContextKeyValueListType'
+ - description: The value (or values, if the condition context key supports
+ multiple values) to provide to the simulation when the key is referenced
+ by a Condition element in an input policy.
+ type: object
+ ContextEntryListType:
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ContextEntry'
+ - xml:
+ name: member
+ type: array
+ ContextKeyNameType:
+ maxLength: 256
+ minLength: 5
+ type: string
+ ContextKeyNamesResultListType:
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ContextKeyNameType'
+ - xml:
+ name: member
+ type: array
+ ContextKeyTypeEnum:
+ enum:
+ - string
+ - stringList
+ - numeric
+ - numericList
+ - boolean
+ - booleanList
+ - ip
+ - ipList
+ - binary
+ - binaryList
+ - date
+ - dateList
+ type: string
+ ContextKeyValueListType:
+ items:
+ allOf:
+ - $ref: '#/components/schemas/ContextKeyValueType'
+ - xml:
+ name: member
+ type: array
+ ContextKeyValueType:
+ type: string
+ CreateAccessKeyRequest:
+ properties:
+ UserName:
+ allOf:
+ - $ref: '#/components/schemas/existingUserNameType'
+ - description: 'The name of the IAM user that the new key will belong + to.
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: _+=,.@-
' + title: CreateAccessKeyRequest + type: object + CreateAccessKeyResponse: + description: 'Contains the response to a successful CreateAccessKey request. ' + example: + AccessKey: + AccessKeyId: AKIAIOSFODNN7EXAMPLE + CreateDate: '2015-03-09T18:39:23.411Z' + SecretAccessKey: wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY + Status: Active + UserName: Bob + properties: + AccessKey: + allOf: + - $ref: '#/components/schemas/AccessKey' + - description: A structure with details about the access key. + required: + - AccessKey + type: object + CreateAccountAliasRequest: + properties: + AccountAlias: + allOf: + - $ref: '#/components/schemas/accountAliasType' + - description:The account alias to create.
This parameter allows + (through its regex pattern) + a string of characters consisting of lowercase letters, digits, and + dashes. You cannot start or finish with a dash, nor can you have two + dashes in a row.
+ required: + - AccountAlias + title: CreateAccountAliasRequest + type: object + CreateGroupRequest: + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: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".
+ 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 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.
+The new password for the user.
The regex
+ pattern that is used to validate this parameter is a string of characters.
+ That string can include almost any printable ASCII character from the
+ space (\u0020) through the end of the ASCII character range
+ (\u00FF). You can also include the tab (\u0009),
+ line feed (\u000A), and carriage return (\u000D)
+ characters. Any of these characters are valid in a password. However,
+ many tools, such as the Amazon Web Services Management Console, might
+ restrict the ability to type certain characters because they have special
+ meaning within that tool.
The name of the IAM user to create a password for. The + user must already exist.
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: + _+=,.@-
' + required: + - UserName + - Password + title: CreateLoginProfileRequest + type: object + CreateLoginProfileResponse: + description: 'Contains the response to a successful CreateLoginProfile + request. ' + example: + LoginProfile: + CreateDate: '2015-03-10T20:55:40.274Z' + PasswordResetRequired: true + UserName: Bob + properties: + LoginProfile: + allOf: + - $ref: '#/components/schemas/LoginProfile' + - description: A structure containing the user name and password create + date. + required: + - LoginProfile + type: object + CreateOpenIDConnectProviderRequest: + properties: + ClientIDList: + allOf: + - $ref: '#/components/schemas/clientIDListType' + - description:Provides a list of client IDs, also known as audiences.
+ When a mobile or web app registers with an OpenID Connect provider,
+ they establish a value that identifies the application. This is the
+ value that's sent as the client_id parameter on OAuth requests.
You can register multiple client IDs with the same provider. For + example, you might have multiple applications that use the same OIDC + provider. You cannot register more than 100 client IDs with a single + IAM OIDC provider.
There is no defined format for a client ID.
+ The CreateOpenIDConnectProviderRequest operation accepts
+ client IDs up to 255 characters long.
A list of tags that you want to attach to the new IAM + OpenID Connect (OIDC) provider. 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.
+A list of server certificate thumbprints for the OpenID + Connect (OIDC) identity provider's server certificates. Typically this + list includes only one entry. However, IAM lets you have up to five + thumbprints for an OIDC provider. This lets you maintain multiple thumbprints + if the identity provider is rotating certificates.
The server + certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 + certificate used by the domain where the OpenID Connect provider makes + its keys available. It is always a 40-character string.
You must
+ provide at least one thumbprint when creating an IAM OIDC provider.
+ For example, assume that the OIDC provider is server.example.com
+ and the provider stores its keys at https://keys.server.example.com/openid-connect.
+ In that case, the thumbprint string would be the hex-encoded SHA-1 hash
+ value of the certificate used by https://keys.server.example.com.
+
For more information about obtaining the OIDC provider thumbprint, + see Obtaining + the thumbprint for an OpenID Connect provider in the IAM User + Guide.
+ Url: + allOf: + - $ref: '#/components/schemas/OpenIDConnectProviderUrlType' + - description:The URL of the identity provider. The URL must begin with
+ https:// and should correspond to the iss
+ claim in the provider's OpenID Connect ID tokens. Per the OIDC standard,
+ path components are allowed but query parameters are not. Typically
+ the URL consists of only a hostname, like https://server.example.org
+ or https://example.com. The URL should not contain a port
+ number.
You cannot register the same provider multiple times + in a single Amazon Web Services account. If you try to submit a URL + that has already been used for an OpenID Connect provider in the Amazon + Web Services account, you will get an error.
+ required: + - Url + - ThumbprintList + title: CreateOpenIDConnectProviderRequest + type: object + CreateOpenIDConnectProviderResponse: + description: 'Contains the response to a successful CreateOpenIDConnectProvider + request. ' + example: + OpenIDConnectProviderArn: arn:aws:iam::123456789012:oidc-provider/server.example.com + properties: + OpenIDConnectProviderArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description: 'The Amazon Resource Name (ARN) of the new IAM OpenID Connect + provider that is created. For more information, see OpenIDConnectProviderListEntry. ' + Tags: + allOf: + - $ref: '#/components/schemas/tagListType' + - description: A list of tags that are attached to the new IAM OIDC provider. + The returned list of tags is sorted by tag key. For more information + about tagging, see Tagging + IAM resources in the IAM User Guide. + type: object + CreatePolicyRequest: + properties: + Description: + allOf: + - $ref: '#/components/schemas/policyDescriptionType' + - description:A friendly description of the policy.
Typically + used to store information about the permissions defined in the policy. + For example, "Grants access to production DynamoDB tables."
The + policy description is immutable. After a value is assigned, it cannot + be changed.
+ Path: + allOf: + - $ref: '#/components/schemas/policyPathType' + - description:The path for the policy.
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.
You + cannot use an asterisk (*) in the path name.
The JSON policy document that you want to use as the content + for the new policy.
You must provide policies in JSON format + in IAM. 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 maximum length of the policy document that you can pass in this + operation, including whitespace, is listed below. To view the maximum + character counts of a managed policy with no whitespaces, see IAM + and STS character quotas.
To learn more about JSON policy + grammar, see Grammar + of the IAM JSON policy language in the IAM User Guide.
+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)
The friendly name of the policy.
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".
+ Tags: + allOf: + - $ref: '#/components/schemas/tagListType' + - description:A list of tags that you want to attach to the new IAM + customer managed policy. 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.
+The Amazon Resource Name (ARN) of the IAM policy to which + you want to add a new version.
For more information about ARNs, + see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ PolicyDocument: + allOf: + - $ref: '#/components/schemas/policyDocumentType' + - description:The JSON policy document that you want to use as the content + for this new version of the policy.
You must provide policies + in JSON format in IAM. 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 maximum length of the policy document that you can pass + in this operation, including whitespace, is listed below. To view the + maximum character counts of a managed policy with no whitespaces, see + IAM + and STS character quotas.
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)
Specifies whether to set this version as the policy's + default version.
When this parameter is true, the
+ new policy version becomes the operative version. That is, it becomes
+ the version that is in effect for the IAM users, groups, and roles that
+ the policy is attached to.
For more information about managed + policy versions, see Versioning + for managed policies in the IAM User Guide.
+ required: + - PolicyArn + - PolicyDocument + title: CreatePolicyVersionRequest + type: object + CreatePolicyVersionResponse: + description: 'Contains the response to a successful CreatePolicyVersion + request. ' + properties: + PolicyVersion: + allOf: + - $ref: '#/components/schemas/PolicyVersion' + - description: A structure containing details about the new policy version. + type: object + CreateRoleRequest: + properties: + 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 maximum of one hour is applied. This setting can + have a value from 1 hour to 12 hours.
Anyone who assumes the
+ role from the 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 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".
+ 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.
+The name of the provider 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: _+=,.@-
' + SAMLMetadataDocument: + allOf: + - $ref: '#/components/schemas/SAMLMetadataDocumentType' + - description:An XML document generated by an identity provider (IdP) + that supports SAML 2.0. The document includes the issuer's name, expiration + information, and keys that can be used to validate the SAML authentication + response (assertions) that are received from the IdP. You must generate + the metadata document using the identity management software that is + used as your organization's IdP.
For more information, see About + SAML 2.0-based federation in the IAM User Guide
+ Tags: + allOf: + - $ref: '#/components/schemas/tagListType' + - description:A list of tags that you want to attach to the new IAM + SAML provider. 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.
+The service principal for the Amazon Web Services service
+ to which this role is attached. You use a string similar to a URL but
+ without the http:// in front. For example: elasticbeanstalk.amazonaws.com.
+
Service principals are unique and case-sensitive. To find the + exact service principal for your service-linked role, see Amazon + Web Services services that work with IAM in the IAM User Guide. + Look for the services that have Yes in the Service-Linked + Role column. Choose the Yes link to view the service-linked + role documentation for that service.
' + CustomSuffix: + allOf: + - $ref: '#/components/schemas/customSuffixType' + - description:A string that you provide, which is combined with
+ the service-provided prefix to form the complete role name. If you make
+ multiple requests for the same service, then you must supply a different
+ CustomSuffix for each request. Otherwise the request fails
+ with a duplicate role name error. For example, you could add -1
+ or -debug to the suffix.
Some services do not support
+ the CustomSuffix parameter. If you provide an optional
+ suffix and the operation fails, try the operation again without the
+ suffix.
The name of the IAM user that is to be associated with + the credentials. The new service-specific credentials have the same + permissions as the associated user except that they can be used only + to access the specified service.
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: + _+=,.@-
' + required: + - UserName + - ServiceName + title: CreateServiceSpecificCredentialRequest + type: object + CreateServiceSpecificCredentialResponse: + properties: + ServiceSpecificCredential: + allOf: + - $ref: '#/components/schemas/ServiceSpecificCredential' + - description:A structure that contains information about the newly + created service-specific credential.
This is the + only time that the password for this credential set is available. It + cannot be recovered later. Instead, you must reset the password with + ResetServiceSpecificCredential.
The path for the user name. 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 new user. + 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.
+The name of the user 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".
+ required: + - UserName + title: CreateUserRequest + type: object + CreateUserResponse: + description: 'Contains the response to a successful CreateUser request. ' + example: + User: + Arn: arn:aws:iam::123456789012:user/Bob + CreateDate: '2013-06-08T03:20:41.270Z' + Path: / + UserId: AKIAIOSFODNN7EXAMPLE + UserName: Bob + properties: + User: + allOf: + - $ref: '#/components/schemas/User' + - description: A structure with details about the new IAM user. + type: object + CreateVirtualMFADeviceRequest: + properties: + Path: + allOf: + - $ref: '#/components/schemas/pathType' + - description:The path for the virtual MFA device. 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 new IAM + virtual MFA device. 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.
+The name of the virtual MFA device. Use with path to + uniquely identify a virtual MFA device.
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: _+=,.@-
' + required: + - VirtualMFADeviceName + title: CreateVirtualMFADeviceRequest + type: object + CreateVirtualMFADeviceResponse: + description: 'Contains the response to a successful CreateVirtualMFADevice + request. ' + properties: + VirtualMFADevice: + allOf: + - $ref: '#/components/schemas/VirtualMFADevice' + - description: A structure containing details about the new virtual MFA + device. + required: + - VirtualMFADevice + type: object + CredentialReportExpiredException: {} + CredentialReportNotPresentException: {} + CredentialReportNotReadyException: {} + DeactivateMFADeviceRequest: + properties: + SerialNumber: + allOf: + - $ref: '#/components/schemas/serialNumberType' + - description: 'The serial number that uniquely identifies the MFA device. + For virtual MFA devices, the serial number is the device ARN.
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: =,.@:/-
' + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: 'The name of the user whose MFA device you want to deactivate.
+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: _+=,.@-
' + required: + - UserName + - SerialNumber + title: DeactivateMFADeviceRequest + type: object + DeleteAccessKeyRequest: + properties: + AccessKeyId: + allOf: + - $ref: '#/components/schemas/accessKeyIdType' + - description:The access key ID for the access key ID and secret access + key you want to delete.
This parameter allows (through its regex pattern) a string of + characters that can consist of any upper or lowercased letter or digit.
+ UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: 'The name of the user whose access key pair you want to + delete.
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: _+=,.@-
' + required: + - AccessKeyId + title: DeleteAccessKeyRequest + type: object + DeleteAccountAliasRequest: + properties: + AccountAlias: + allOf: + - $ref: '#/components/schemas/accountAliasType' + - description:The name of the account alias to delete.
This parameter + allows (through its regex + pattern) a string of characters consisting of lowercase letters, + digits, and dashes. You cannot start or finish with a dash, nor can + you have two dashes in a row.
+ required: + - AccountAlias + title: DeleteAccountAliasRequest + type: object + DeleteConflictException: {} + DeleteGroupPolicyRequest: + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: 'The name (friendly name, not ARN) identifying the group + that the policy is embedded in.
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: + _+=,.@-
' + PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: 'The name identifying the policy document to delete.
+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: _+=,.@-
' + required: + - GroupName + - PolicyName + title: DeleteGroupPolicyRequest + type: object + DeleteGroupRequest: + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: 'The name of the IAM group to delete.
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: _+=,.@-
' + required: + - GroupName + title: DeleteGroupRequest + type: object + DeleteInstanceProfileRequest: + properties: + InstanceProfileName: + allOf: + - $ref: '#/components/schemas/instanceProfileNameType' + - description: 'The name of the instance profile to delete.
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: _+=,.@-
' + required: + - InstanceProfileName + title: DeleteInstanceProfileRequest + type: object + DeleteLoginProfileRequest: + properties: + UserName: + allOf: + - $ref: '#/components/schemas/userNameType' + - description: 'The name of the user whose password you want to delete.
+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: _+=,.@-
' + required: + - UserName + title: DeleteLoginProfileRequest + type: object + DeleteOpenIDConnectProviderRequest: + properties: + OpenIDConnectProviderArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description: The Amazon Resource Name (ARN) of the IAM OpenID Connect + provider resource object to delete. You can get a list of OpenID Connect + provider resource ARNs by using the ListOpenIDConnectProviders + operation. + required: + - OpenIDConnectProviderArn + title: DeleteOpenIDConnectProviderRequest + type: object + DeletePolicyRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:The Amazon Resource Name (ARN) of the IAM policy you want + to delete.
For more information about ARNs, see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ required: + - PolicyArn + title: DeletePolicyRequest + type: object + DeletePolicyVersionRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:The Amazon Resource Name (ARN) of the IAM policy from + which you want to delete a version.
For more information about + ARNs, see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ VersionId: + allOf: + - $ref: '#/components/schemas/policyVersionIdType' + - description:The policy version to delete.
This parameter allows + (through its regex pattern) + a string of characters that consists of the lowercase letter 'v' followed + by one or two digits, and optionally followed by a period '.' and a + string of letters and digits.
For more information about managed + policy versions, see Versioning + for managed policies in the IAM User Guide.
+ required: + - PolicyArn + - VersionId + title: DeletePolicyVersionRequest + type: object + DeleteRolePermissionsBoundaryRequest: + properties: + RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: The name (friendly name, not ARN) of the IAM role from which + you want to remove the permissions boundary. + required: + - RoleName + title: DeleteRolePermissionsBoundaryRequest + type: object + DeleteRolePolicyRequest: + properties: + PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: 'The name of the inline policy to delete from the specified + IAM role.
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: _+=,.@-
' + RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: 'The name (friendly name, not ARN) identifying the role + that the policy is embedded in.
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: + _+=,.@-
' + required: + - RoleName + - PolicyName + title: DeleteRolePolicyRequest + type: object + DeleteRoleRequest: + properties: + RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: 'The name of the role to delete.
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: _+=,.@-
' + required: + - RoleName + title: DeleteRoleRequest + type: object + DeleteSAMLProviderRequest: + properties: + SAMLProviderArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description: The Amazon Resource Name (ARN) of the SAML provider to delete. + required: + - SAMLProviderArn + title: DeleteSAMLProviderRequest + type: object + DeleteSSHPublicKeyRequest: + properties: + SSHPublicKeyId: + allOf: + - $ref: '#/components/schemas/publicKeyIdType' + - description:The unique identifier for the SSH public key.
This + parameter allows (through its regex + pattern) a string of characters that can consist of any upper or + lowercased letter or digit.
+ UserName: + allOf: + - $ref: '#/components/schemas/userNameType' + - description: 'The name of the IAM user associated with the SSH public + key.
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: _+=,.@-
' + required: + - UserName + - SSHPublicKeyId + title: DeleteSSHPublicKeyRequest + type: object + DeleteServerCertificateRequest: + properties: + ServerCertificateName: + allOf: + - $ref: '#/components/schemas/serverCertificateNameType' + - description: 'The name of the server certificate you want to delete.
+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: _+=,.@-
' + required: + - ServerCertificateName + title: DeleteServerCertificateRequest + type: object + DeleteServiceLinkedRoleRequest: + properties: + RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: The name of the service-linked role to be deleted. + required: + - RoleName + title: DeleteServiceLinkedRoleRequest + type: object + DeleteServiceLinkedRoleResponse: + properties: + DeletionTaskId: + allOf: + - $ref: '#/components/schemas/DeletionTaskIdType' + - description: The deletion task identifier that you can use to check the + status of the deletion. This identifier is returned in the formattask/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
+ required:
+ - DeletionTaskId
+ type: object
+ DeleteServiceSpecificCredentialRequest:
+ properties:
+ ServiceSpecificCredentialId:
+ allOf:
+ - $ref: '#/components/schemas/serviceSpecificCredentialId'
+ - description: The unique identifier of the service-specific credential. + You can get this value by calling ListServiceSpecificCredentials.
+This parameter allows (through its regex + pattern) a string of characters that can consist of any upper or + lowercased letter or digit.
+ UserName: + allOf: + - $ref: '#/components/schemas/userNameType' + - description: 'The name of the IAM user associated with the service-specific + credential. If this value is not specified, then the operation assumes + the user whose credentials are used to call the operation.
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: _+=,.@-
' + required: + - ServiceSpecificCredentialId + title: DeleteServiceSpecificCredentialRequest + type: object + DeleteSigningCertificateRequest: + properties: + CertificateId: + allOf: + - $ref: '#/components/schemas/certificateIdType' + - description:The ID of the signing certificate to delete.
The + format of this parameter, as described by its regex + pattern, is a string of characters that can be upper- or lower-cased + letters or digits.
+ UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: 'The name of the user the signing certificate belongs + to.
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: _+=,.@-
' + required: + - CertificateId + title: DeleteSigningCertificateRequest + type: object + DeleteUserPermissionsBoundaryRequest: + properties: + UserName: + allOf: + - $ref: '#/components/schemas/userNameType' + - description: The name (friendly name, not ARN) of the IAM user from which + you want to remove the permissions boundary. + required: + - UserName + title: DeleteUserPermissionsBoundaryRequest + type: object + DeleteUserPolicyRequest: + properties: + PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: 'The name identifying the policy document to delete.
+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: _+=,.@-
' + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: 'The name (friendly name, not ARN) identifying the user + that the policy is embedded in.
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: + _+=,.@-
' + required: + - UserName + - PolicyName + title: DeleteUserPolicyRequest + type: object + DeleteUserRequest: + properties: + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: 'The name of the user to delete.
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: _+=,.@-
' + required: + - UserName + title: DeleteUserRequest + type: object + DeleteVirtualMFADeviceRequest: + properties: + SerialNumber: + allOf: + - $ref: '#/components/schemas/serialNumberType' + - description: 'The serial number that uniquely identifies the MFA device. + For virtual MFA devices, the serial number is the same as the ARN.
+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: =,.@:/-
' + required: + - SerialNumber + title: DeleteVirtualMFADeviceRequest + type: object + DeletionTaskFailureReasonType: + description:The reason that the service-linked role deletion failed.
+This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus + operation.
+ properties: + Reason: + allOf: + - $ref: '#/components/schemas/ReasonType' + - description: A short description of the reason that the service-linked + role deletion failed. + RoleUsageList: + allOf: + - $ref: '#/components/schemas/RoleUsageListType' + - description: A list of objects that contains details about the service-linked + role deletion failure, if that information is returned by the service. + If the service-linked role has active sessions or if any resources that + were used by the role have not been deleted from the linked service, + the role can't be deleted. This parameter includes a list of the resources + that are associated with the role and the Region in which the resources + are being used. + type: object + DeletionTaskIdType: + maxLength: 1000 + minLength: 1 + type: string + DeletionTaskStatusType: + enum: + - SUCCEEDED + - IN_PROGRESS + - FAILED + - NOT_STARTED + type: string + DetachGroupPolicyRequest: + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: 'The name (friendly name, not ARN) of the IAM group to + detach the policy from.
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: + _+=,.@-
' + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:The Amazon Resource Name (ARN) of the IAM policy you want + to detach.
For more information about ARNs, see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ required: + - GroupName + - PolicyArn + title: DetachGroupPolicyRequest + type: object + DetachRolePolicyRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:The Amazon Resource Name (ARN) of the IAM policy you want + to detach.
For more information about ARNs, see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: 'The name (friendly name, not ARN) of the IAM role to + detach the policy from.
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: + _+=,.@-
' + required: + - RoleName + - PolicyArn + title: DetachRolePolicyRequest + type: object + DetachUserPolicyRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:The Amazon Resource Name (ARN) of the IAM policy you want + to detach.
For more information about ARNs, see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ UserName: + allOf: + - $ref: '#/components/schemas/userNameType' + - description: 'The name (friendly name, not ARN) of the IAM user to + detach the policy from.
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: + _+=,.@-
' + required: + - UserName + - PolicyArn + title: DetachUserPolicyRequest + type: object + DuplicateCertificateException: {} + DuplicateSSHPublicKeyException: {} + EnableMFADeviceRequest: + properties: + AuthenticationCode1: + allOf: + - $ref: '#/components/schemas/authenticationCodeType' + - description:An authentication code emitted by the device.
The + format for this parameter is a string of six digits.
Submit your request immediately after generating the authentication + codes. If you generate the codes and then wait too long to submit the + request, the MFA device successfully associates with the user but the + MFA device becomes out of sync. This happens because time-based one-time + passwords (TOTP) expire after a short period of time. If this happens, + you can resync + the device.
A subsequent authentication code emitted by the device.
+The format for this parameter is a string of six digits.
Submit your request immediately after generating the authentication + codes. If you generate the codes and then wait too long to submit the + request, the MFA device successfully associates with the user but the + MFA device becomes out of sync. This happens because time-based one-time + passwords (TOTP) expire after a short period of time. If this happens, + you can resync + the device.
The serial number that uniquely identifies the MFA device. + For virtual MFA devices, the serial number is the device ARN.
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: =,.@:/-
' + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: 'The name of the IAM user for whom you want to enable + the MFA device.
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: _+=,.@-
' + required: + - UserName + - SerialNumber + - AuthenticationCode1 + - AuthenticationCode2 + title: EnableMFADeviceRequest + type: object + EntityAlreadyExistsException: {} + EntityDetails: + description:An object that contains details about when the IAM entities + (users or roles) were last used in an attempt to access the specified Amazon + Web Services service.
This data type is a response element in the GetServiceLastAccessedDetailsWithEntities + operation.
+ properties: + EntityInfo: + allOf: + - $ref: '#/components/schemas/EntityInfo' + - description: "The\_EntityInfo object that contains details\
+ \ about the entity (user or role)."
+ LastAuthenticated:
+ allOf:
+ - $ref: '#/components/schemas/dateType'
+ - description: "The date and time, in\_ISO 8601 date-time format, when the authenticated entity last attempted\ + \ to access Amazon Web Services. Amazon Web Services does not report\ + \ unauthenticated requests.
This field is null if no IAM entities\ + \ attempted to access the service within the reporting period.
" + required: + - EntityInfo + type: object + EntityInfo: + description:Contains details about the specified entity (user or role).
+This data type is an element of the EntityDetails object.
+ properties: + Arn: + $ref: '#/components/schemas/arnType' + Id: + allOf: + - $ref: '#/components/schemas/idType' + - description: The identifier of the entity (user or role). + Name: + allOf: + - $ref: '#/components/schemas/userNameType' + - description: The name of the entity (user or role). + Path: + allOf: + - $ref: '#/components/schemas/pathType' + - description: 'The path to the entity (user or role). For more information + about paths, see IAM + identifiers in the IAM User Guide. ' + Type: + allOf: + - $ref: '#/components/schemas/policyOwnerEntityType' + - description: The type of entity (user or role). + required: + - Arn + - Name + - Type + - Id + type: object + EntityTemporarilyUnmodifiableException: {} + EntityType: + enum: + - User + - Role + - Group + - LocalManagedPolicy + - AWSManagedPolicy + type: string + ErrorDetails: + description:Contains information about the reason that the operation failed.
+This data type is used as a response element in the GetOrganizationsAccessReport, + GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities + operations.
+ properties: + Code: + allOf: + - $ref: '#/components/schemas/stringType' + - description: The error code associated with the operation failure. + Message: + allOf: + - $ref: '#/components/schemas/stringType' + - description: Detailed information about the reason that the operation + failed. + required: + - Message + - Code + type: object + EvalDecisionDetailsType: + additionalProperties: + $ref: '#/components/schemas/PolicyEvaluationDecisionType' + type: object + EvalDecisionSourceType: + maxLength: 256 + minLength: 3 + type: string + EvaluationResult: + description:Contains the results of a simulation.
This data type
+ is used by the return parameter of SimulateCustomPolicy
+ and SimulatePrincipalPolicy .
Additional details about the results of the cross-account + evaluation decision. This parameter is populated for only cross-account + simulations. It contains a brief summary of how each policy type contributes + to the final evaluation decision.
If the simulation evaluates
+ policies within the same account and includes a resource ARN, then the
+ parameter is present but the response is empty. If the simulation evaluates
+ policies within the same account and specifies all resources (*),
+ then the parameter is not returned.
When you make a cross-account
+ request, Amazon Web Services evaluates the request in the trusting account
+ and the trusted account. The request is allowed only if both evaluations
+ return true. For more information about how policies are
+ evaluated, see Evaluating
+ policies within a single account.
If an Organizations SCP + included in the evaluation denies access, the simulation ends. In this + case, policy evaluation does not proceed any further and this parameter + is not returned.
+ EvalResourceName: + allOf: + - $ref: '#/components/schemas/ResourceNameType' + - description: The ARN of the resource that the indicated API operation + was tested on. + MatchedStatements: + allOf: + - $ref: '#/components/schemas/StatementListType' + - description: A list of the statements in the input policies that determine + the result for this scenario. Remember that even if multiple statements + allow the operation on the resource, if only one statement denies that + operation, then the explicit deny overrides any allow. In addition, + the deny statement is the only entry included in the result. + MissingContextValues: + allOf: + - $ref: '#/components/schemas/ContextKeyNamesResultListType' + - description: A list of context keys that are required by the included + input policies but that were not provided by one of the input parameters. + This list is used when the resource in a simulation is "*", either explicitly, + or when theResourceArns parameter blank. If you include
+ a list of resources, then any missing context values are instead included
+ under the ResourceSpecificResults section. To discover
+ the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy
+ or GetContextKeysForPrincipalPolicy.
+ OrganizationsDecisionDetail:
+ allOf:
+ - $ref: '#/components/schemas/OrganizationsDecisionDetail'
+ - description: A structure that details how Organizations and its service
+ control policies affect the results of the simulation. Only applies
+ if the simulated user's account is part of an organization.
+ PermissionsBoundaryDecisionDetail:
+ allOf:
+ - $ref: '#/components/schemas/PermissionsBoundaryDecisionDetail'
+ - description: Contains information about the effect that a permissions
+ boundary has on a policy simulation when the boundary is applied to
+ an IAM entity.
+ ResourceSpecificResults:
+ allOf:
+ - $ref: '#/components/schemas/ResourceSpecificResultListType'
+ - description: The individual results of the simulation of the API operation
+ specified in EvalActionName on each resource.
+ required:
+ - EvalActionName
+ - EvalDecision
+ type: object
+ EvaluationResultsListType:
+ items:
+ allOf:
+ - $ref: '#/components/schemas/EvaluationResult'
+ - xml:
+ name: member
+ type: array
+ GenerateCredentialReportResponse:
+ description: 'Contains the response to a successful GenerateCredentialReport
+ request. '
+ properties:
+ Description:
+ allOf:
+ - $ref: '#/components/schemas/ReportStateDescriptionType'
+ - description: Information about the credential report.
+ State:
+ allOf:
+ - $ref: '#/components/schemas/ReportStateType'
+ - description: Information about the state of the credential report.
+ type: object
+ GenerateOrganizationsAccessReportRequest:
+ properties:
+ EntityPath:
+ allOf:
+ - $ref: '#/components/schemas/organizationsEntityPathType'
+ - description: The path of the Organizations entity (root, OU, or account).
+ You can build an entity path using the known structure of your organization.
+ For example, assume that your account ID is 123456789012
+ and its parent OU ID is ou-rge0-awsabcde. The organization
+ root ID is r-f6g7h8i9j0example and your organization ID
+ is o-a1b2c3d4e5. Your entity path is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.
+ OrganizationsPolicyId:
+ allOf:
+ - $ref: '#/components/schemas/organizationsPolicyIdType'
+ - description: The identifier of the Organizations service control policy + (SCP). This parameter is optional.
This ID is used to generate + information about when an account principal that is limited by the SCP + attempted to access an Amazon Web Services service.
+ required: + - EntityPath + title: GenerateOrganizationsAccessReportRequest + type: object + GenerateOrganizationsAccessReportResponse: + example: + JobId: examplea-1234-b567-cde8-90fg123abcd4 + properties: + JobId: + allOf: + - $ref: '#/components/schemas/jobIDType' + - description: The job identifier that you can use in the GetOrganizationsAccessReport + operation. + type: object + GenerateServiceLastAccessedDetailsRequest: + properties: + Arn: + allOf: + - $ref: '#/components/schemas/arnType' + - description: The ARN of the IAM resource (user, group, role, or managed + policy) used to generate information about when the resource was last + used in an attempt to access an Amazon Web Services service. + Granularity: + allOf: + - $ref: '#/components/schemas/AccessAdvisorUsageGranularityType' + - description: The level of detail that you want to generate. You can specify + whether you want to generate information about the last attempt to access + services or actions. If you specify service-level granularity, this + operation generates only service data. If you specify action-level granularity, + it generates service and action data. If you don't include this optional + parameter, the operation generates service data. + required: + - Arn + title: GenerateServiceLastAccessedDetailsRequest + type: object + GenerateServiceLastAccessedDetailsResponse: + example: + JobId: examplef-1305-c245-eba4-71fe298bcda7 + properties: + JobId: + allOf: + - $ref: '#/components/schemas/jobIDType' + - description: TheJobId that you can use in the GetServiceLastAccessedDetails
+ or GetServiceLastAccessedDetailsWithEntities operations. The
+ JobId returned by GenerateServiceLastAccessedDetail
+ must be used by the same role within a session, or by the same user
+ when used to call GetServiceLastAccessedDetail.
+ type: object
+ GetAccessKeyLastUsedRequest:
+ properties:
+ AccessKeyId:
+ allOf:
+ - $ref: '#/components/schemas/accessKeyIdType'
+ - description: The identifier of an access key.
This parameter + allows (through its regex + pattern) a string of characters that can consist of any upper or + lowercased letter or digit.
+ required: + - AccessKeyId + title: GetAccessKeyLastUsedRequest + type: object + GetAccessKeyLastUsedResponse: + description: Contains the response to a successful GetAccessKeyLastUsed + request. It is also returned as a member of the AccessKeyMetaData structure + returned by the ListAccessKeys action. + properties: + AccessKeyLastUsed: + allOf: + - $ref: '#/components/schemas/AccessKeyLastUsed' + - description: Contains information about the last time the access key was + used. + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description:The name of the IAM user that owns this access key.
+ + type: object + GetAccountAuthorizationDetailsRequest: + properties: + Filter: + allOf: + - $ref: '#/components/schemas/entityListType' + - description:A list of entity types used to filter the results. Only
+ the entities that match the types you specify are included in the output.
+ Use the value LocalManagedPolicy to include customer managed
+ policies.
The format for this parameter is a comma-separated + (if more than one) list of strings. Each string value in the list must + be one of the valid values listed below.
+ Marker: + allOf: + - $ref: '#/components/schemas/markerType' + - description: Use this parameter only when paginating results and only + after you receive a response indicating that the results are truncated. + Set it to the value of theMarker element in the response
+ that you received to indicate where the next call should start.
+ MaxItems:
+ allOf:
+ - $ref: '#/components/schemas/maxItemsType'
+ - description: Use this only when paginating results to indicate the
+ maximum number of items you want in the response. If additional items
+ exist beyond the maximum you specify, the IsTruncated response
+ element is true.
If you do not include this parameter,
+ the number of items defaults to 100. Note that IAM might return fewer
+ results, even when there are more results available. In that case, the
+ IsTruncated response element returns true,
+ and Marker contains a value to include in the subsequent
+ call that tells the service where to continue from.
Marker request parameter to retrieve
+ more items. Note that IAM might return fewer than the MaxItems
+ number of results even when there are more results available. We recommend
+ that you check IsTruncated after every call to ensure that
+ you receive all your results.
+ Marker:
+ allOf:
+ - $ref: '#/components/schemas/responseMarkerType'
+ - description: When IsTruncated is true, this
+ element is present and contains the value to use for the Marker
+ parameter in a subsequent pagination request.
+ Policies:
+ allOf:
+ - $ref: '#/components/schemas/ManagedPolicyDetailListType'
+ - description: A list containing information about managed policies.
+ RoleDetailList:
+ allOf:
+ - $ref: '#/components/schemas/roleDetailListType'
+ - description: A list containing information about IAM roles.
+ UserDetailList:
+ allOf:
+ - $ref: '#/components/schemas/userDetailListType'
+ - description: A list containing information about IAM users.
+ type: object
+ GetAccountPasswordPolicyResponse:
+ description: 'Contains the response to a successful GetAccountPasswordPolicy
+ request. '
+ example:
+ PasswordPolicy:
+ AllowUsersToChangePassword: false
+ ExpirePasswords: false
+ HardExpiry: false
+ MaxPasswordAge: 90
+ MinimumPasswordLength: 8
+ PasswordReusePrevention: 12
+ RequireLowercaseCharacters: false
+ RequireNumbers: true
+ RequireSymbols: true
+ RequireUppercaseCharacters: false
+ properties:
+ PasswordPolicy:
+ allOf:
+ - $ref: '#/components/schemas/PasswordPolicy'
+ - description: A structure that contains details about the account's password
+ policy.
+ required:
+ - PasswordPolicy
+ type: object
+ GetAccountSummaryResponse:
+ description: 'Contains the response to a successful GetAccountSummary
+ request. '
+ example:
+ SummaryMap:
+ AccessKeysPerUserQuota: 2
+ AccountAccessKeysPresent: 1
+ AccountMFAEnabled: 0
+ AccountSigningCertificatesPresent: 0
+ AttachedPoliciesPerGroupQuota: 10
+ AttachedPoliciesPerRoleQuota: 10
+ AttachedPoliciesPerUserQuota: 10
+ GlobalEndpointTokenVersion: 2
+ GroupPolicySizeQuota: 5120
+ Groups: 15
+ GroupsPerUserQuota: 10
+ GroupsQuota: 100
+ MFADevices: 6
+ MFADevicesInUse: 3
+ Policies: 8
+ PoliciesQuota: 1000
+ PolicySizeQuota: 5120
+ PolicyVersionsInUse: 22
+ PolicyVersionsInUseQuota: 10000
+ ServerCertificates: 1
+ ServerCertificatesQuota: 20
+ SigningCertificatesPerUserQuota: 2
+ UserPolicySizeQuota: 2048
+ Users: 27
+ UsersQuota: 5000
+ VersionsPerPolicyQuota: 5
+ properties:
+ SummaryMap:
+ allOf:
+ - $ref: '#/components/schemas/summaryMapType'
+ - description: "A set of key\u2013value pairs containing information about\
+ \ IAM entity usage and IAM quotas."
+ type: object
+ GetContextKeysForCustomPolicyRequest:
+ properties:
+ PolicyInputList:
+ allOf:
+ - $ref: '#/components/schemas/SimulationPolicyListType'
+ - description: A list of policies for which you want the list of context + keys referenced in those policies. Each document is specified as a string + containing the complete, valid JSON text of an IAM policy.
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)
An optional list of additional policies for which you + want the list of context keys that are referenced.
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)
The ARN of a user, group, or role whose policies contain + the context keys that you want listed. If you specify a user, the list + includes context keys that are found in all policies that are attached + to the user. The list also includes all groups that the user is a member + of. If you pick a group or a role, then it includes only those context + keys that are found in policies attached to that entity. Note that all + parameters are shown in unencoded form here for clarity, but must be + URL encoded to be included as a part of a real HTML request.
For + more information about ARNs, see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ required: + - PolicySourceArn + title: GetContextKeysForPrincipalPolicyRequest + type: object + GetCredentialReportResponse: + description: 'Contains the response to a successful GetCredentialReport + request. ' + properties: + Content: + allOf: + - $ref: '#/components/schemas/ReportContentType' + - description: Contains the credential report. The report is Base64-encoded. + GeneratedTime: + allOf: + - $ref: '#/components/schemas/dateType' + - description: ' The date and time when the credential report was created, + in ISO 8601 date-time format.' + ReportFormat: + allOf: + - $ref: '#/components/schemas/ReportFormatType' + - description: The format (MIME type) of the credential report. + type: object + GetGroupPolicyRequest: + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: 'The name of the group the policy is associated with.
+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: _+=,.@-
' + PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: 'The name of the policy document to get.
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: _+=,.@-
' + required: + - GroupName + - PolicyName + title: GetGroupPolicyRequest + type: object + GetGroupPolicyResponse: + description: 'Contains the response to a successful GetGroupPolicy request. ' + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: The group the policy is associated with. + PolicyDocument: + allOf: + - $ref: '#/components/schemas/policyDocumentType' + - description:The policy document.
IAM stores policies in JSON + format. However, resources that were created using CloudFormation templates + can be formatted in YAML. CloudFormation always converts a YAML policy + to JSON format before submitting it to IAM.
+ PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: The name of the policy. + required: + - GroupName + - PolicyName + - PolicyDocument + type: object + GetGroupRequest: + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: 'The name of the group.
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: + _+=,.@-
' + Marker: + allOf: + - $ref: '#/components/schemas/markerType' + - description: Use this parameter only when paginating results and only + after you receive a response indicating that the results are truncated. + Set it to the value of theMarker element in the response
+ that you received to indicate where the next call should start.
+ MaxItems:
+ allOf:
+ - $ref: '#/components/schemas/maxItemsType'
+ - description: Use this only when paginating results to indicate the
+ maximum number of items you want in the response. If additional items
+ exist beyond the maximum you specify, the IsTruncated response
+ element is true.
If you do not include this parameter,
+ the number of items defaults to 100. Note that IAM might return fewer
+ results, even when there are more results available. In that case, the
+ IsTruncated response element returns true,
+ and Marker contains a value to include in the subsequent
+ call that tells the service where to continue from.
Marker request parameter to retrieve
+ more items. Note that IAM might return fewer than the MaxItems
+ number of results even when there are more results available. We recommend
+ that you check IsTruncated after every call to ensure that
+ you receive all your results.
+ Marker:
+ allOf:
+ - $ref: '#/components/schemas/responseMarkerType'
+ - description: When IsTruncated is true, this
+ element is present and contains the value to use for the Marker
+ parameter in a subsequent pagination request.
+ Users:
+ allOf:
+ - $ref: '#/components/schemas/userListType'
+ - description: A list of users in the group.
+ required:
+ - Group
+ - Users
+ type: object
+ GetInstanceProfileRequest:
+ properties:
+ InstanceProfileName:
+ allOf:
+ - $ref: '#/components/schemas/instanceProfileNameType'
+ - description: 'The name of the instance profile to get information about.
+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: _+=,.@-
' + required: + - InstanceProfileName + title: GetInstanceProfileRequest + type: object + GetInstanceProfileResponse: + description: 'Contains the response to a successful GetInstanceProfile + request. ' + example: + InstanceProfile: + Arn: arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile + CreateDate: '2013-06-12T23:52:02Z' + InstanceProfileId: AID2MAB8DPLSRHEXAMPLE + InstanceProfileName: ExampleInstanceProfile + Path: / + Roles: + - Arn: arn:aws:iam::336924118301:role/Test-Role + AssumeRolePolicyDocument:The name of the user whose login profile you want to + retrieve.
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: _+=,.@-
' + required: + - UserName + title: GetLoginProfileRequest + type: object + GetLoginProfileResponse: + description: 'Contains the response to a successful GetLoginProfile request. ' + example: + LoginProfile: + CreateDate: '2012-09-21T23:03:39Z' + UserName: Anika + properties: + LoginProfile: + allOf: + - $ref: '#/components/schemas/LoginProfile' + - description: A structure containing the user name and the profile creation + date for the user. + required: + - LoginProfile + type: object + GetOpenIDConnectProviderRequest: + properties: + OpenIDConnectProviderArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:The Amazon Resource Name (ARN) of the OIDC provider resource + object in IAM to get information for. You can get a list of OIDC provider + resource ARNs by using the ListOpenIDConnectProviders operation.
+For more information about ARNs, see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ required: + - OpenIDConnectProviderArn + title: GetOpenIDConnectProviderRequest + type: object + GetOpenIDConnectProviderResponse: + description: 'Contains the response to a successful GetOpenIDConnectProvider + request. ' + properties: + ClientIDList: + allOf: + - $ref: '#/components/schemas/clientIDListType' + - description: A list of client IDs (also known as audiences) that are associated + with the specified IAM OIDC provider resource object. For more information, + see CreateOpenIDConnectProvider. + CreateDate: + allOf: + - $ref: '#/components/schemas/dateType' + - description: The date and time when the IAM OIDC provider resource object + was created in the Amazon Web Services account. + Tags: + allOf: + - $ref: '#/components/schemas/tagListType' + - description: A list of tags that are attached to the specified IAM OIDC + provider. The returned list of tags is sorted by tag key. For more information + about tagging, see Tagging + IAM resources in the IAM User Guide. + ThumbprintList: + allOf: + - $ref: '#/components/schemas/thumbprintListType' + - description: 'A list of certificate thumbprints that are associated with + the specified IAM OIDC provider resource object. For more information, + see CreateOpenIDConnectProvider. ' + Url: + allOf: + - $ref: '#/components/schemas/OpenIDConnectProviderUrlType' + - description: The URL that the IAM OIDC provider resource object is associated + with. For more information, see CreateOpenIDConnectProvider. + type: object + GetOrganizationsAccessReportRequest: + properties: + JobId: + allOf: + - $ref: '#/components/schemas/jobIDType' + - description: The identifier of the request generated by the GenerateOrganizationsAccessReport + operation. + Marker: + allOf: + - $ref: '#/components/schemas/markerType' + - description: Use this parameter only when paginating results and only + after you receive a response indicating that the results are truncated. + Set it to the value of theMarker element in the response
+ that you received to indicate where the next call should start.
+ MaxItems:
+ allOf:
+ - $ref: '#/components/schemas/maxItemsType'
+ - description: Use this only when paginating results to indicate the
+ maximum number of items you want in the response. If additional items
+ exist beyond the maximum you specify, the IsTruncated response
+ element is true.
If you do not include this parameter,
+ the number of items defaults to 100. Note that IAM might return fewer
+ results, even when there are more results available. In that case, the
+ IsTruncated response element returns true,
+ and Marker contains a value to include in the subsequent
+ call that tells the service where to continue from.
Marker request parameter to retrieve
+ more items. Note that IAM might return fewer than the MaxItems
+ number of results even when there are more results available. We recommend
+ that you check IsTruncated after every call to ensure that
+ you receive all your results.
+ JobCompletionDate:
+ allOf:
+ - $ref: '#/components/schemas/dateType'
+ - description: "The date and time, in\_ISO 8601 date-time format, when the generated report job was completed\ + \ or failed.
This field is null if the job is still in progress,\
+ \ as indicated by a job status value of IN_PROGRESS.
IsTruncated is true, this
+ element is present and contains the value to use for the Marker
+ parameter in a subsequent pagination request.
+ NumberOfServicesAccessible:
+ allOf:
+ - $ref: '#/components/schemas/integerType'
+ - description: The number of services that the applicable SCPs allow account
+ principals to access.
+ NumberOfServicesNotAccessed:
+ allOf:
+ - $ref: '#/components/schemas/integerType'
+ - description: The number of services that account principals are allowed
+ but did not attempt to access.
+ required:
+ - JobStatus
+ - JobCreationDate
+ type: object
+ GetPolicyRequest:
+ properties:
+ PolicyArn:
+ allOf:
+ - $ref: '#/components/schemas/arnType'
+ - description: The Amazon Resource Name (ARN) of the managed policy that + you want information about.
For more information about ARNs, + see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ required: + - PolicyArn + title: GetPolicyRequest + type: object + GetPolicyResponse: + description: 'Contains the response to a successful GetPolicy request. ' + properties: + Policy: + allOf: + - $ref: '#/components/schemas/Policy' + - description: A structure containing details about the policy. + type: object + GetPolicyVersionRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:The Amazon Resource Name (ARN) of the managed policy that + you want information about.
For more information about ARNs, + see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ VersionId: + allOf: + - $ref: '#/components/schemas/policyVersionIdType' + - description:Identifies the policy version to retrieve.
This + parameter allows (through its regex + pattern) a string of characters that consists of the lowercase letter + 'v' followed by one or two digits, and optionally followed by a period + '.' and a string of letters and digits.
+ required: + - PolicyArn + - VersionId + title: GetPolicyVersionRequest + type: object + GetPolicyVersionResponse: + description: 'Contains the response to a successful GetPolicyVersion + request. ' + properties: + PolicyVersion: + allOf: + - $ref: '#/components/schemas/PolicyVersion' + - description: A structure containing details about the policy version. + type: object + GetRolePolicyRequest: + properties: + PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: 'The name of the policy document to get.
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: _+=,.@-
' + RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: 'The name of the role associated with the policy.
+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: _+=,.@-
' + required: + - RoleName + - PolicyName + title: GetRolePolicyRequest + type: object + GetRolePolicyResponse: + description: 'Contains the response to a successful GetRolePolicy request. ' + properties: + PolicyDocument: + allOf: + - $ref: '#/components/schemas/policyDocumentType' + - description:The policy document.
IAM stores policies in JSON + format. However, resources that were created using CloudFormation templates + can be formatted in YAML. CloudFormation always converts a YAML policy + to JSON format before submitting it to IAM.
+ PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: The name of the policy. + RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: The role the policy is associated with. + required: + - RoleName + - PolicyName + - PolicyDocument + type: object + GetRoleRequest: + properties: + RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: 'The name of the IAM role to get information about.
+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: _+=,.@-
' + required: + - RoleName + title: GetRoleRequest + type: object + GetRoleResponse: + description: 'Contains the response to a successful GetRole request. ' + example: + Role: + Arn: arn:aws:iam::123456789012:role/Test-Role + AssumeRolePolicyDocument:The Amazon Resource Name (ARN) of the SAML provider resource + object in IAM to get information about.
For more information + about ARNs, see Amazon + Resource Names (ARNs) in the Amazon Web Services General Reference.
+ required: + - SAMLProviderArn + title: GetSAMLProviderRequest + type: object + GetSAMLProviderResponse: + description: 'Contains the response to a successful GetSAMLProvider request. ' + properties: + CreateDate: + allOf: + - $ref: '#/components/schemas/dateType' + - description: The date and time when the SAML provider was created. + SAMLMetadataDocument: + allOf: + - $ref: '#/components/schemas/SAMLMetadataDocumentType' + - description: The XML metadata document that includes information about + an identity provider. + Tags: + allOf: + - $ref: '#/components/schemas/tagListType' + - description: A list of tags that are attached to the specified IAM SAML + provider. The returned list of tags is sorted by tag key. For more information + about tagging, see Tagging + IAM resources in the IAM User Guide. + ValidUntil: + allOf: + - $ref: '#/components/schemas/dateType' + - description: The expiration date and time for the SAML provider. + type: object + GetSSHPublicKeyRequest: + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/encodingType' + - description: Specifies the public key encoding format to use in the response. + To retrieve the public key in ssh-rsa format, useSSH.
+ To retrieve the public key in PEM format, use PEM.
+ SSHPublicKeyId:
+ allOf:
+ - $ref: '#/components/schemas/publicKeyIdType'
+ - description: The unique identifier for the SSH public key.
This + parameter allows (through its regex + pattern) a string of characters that can consist of any upper or + lowercased letter or digit.
+ UserName: + allOf: + - $ref: '#/components/schemas/userNameType' + - description: 'The name of the IAM user associated with the SSH public + key.
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: _+=,.@-
' + required: + - UserName + - SSHPublicKeyId + - Encoding + title: GetSSHPublicKeyRequest + type: object + GetSSHPublicKeyResponse: + description: Contains the response to a successful GetSSHPublicKey request. + properties: + SSHPublicKey: + allOf: + - $ref: '#/components/schemas/SSHPublicKey' + - description: A structure containing details about the SSH public key. + type: object + GetServerCertificateRequest: + properties: + ServerCertificateName: + allOf: + - $ref: '#/components/schemas/serverCertificateNameType' + - description: 'The name of the server certificate you want to retrieve + information about.
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: _+=,.@-
' + required: + - ServerCertificateName + title: GetServerCertificateRequest + type: object + GetServerCertificateResponse: + description: 'Contains the response to a successful GetServerCertificate + request. ' + properties: + ServerCertificate: + allOf: + - $ref: '#/components/schemas/ServerCertificate' + - description: A structure containing details about the server certificate. + required: + - ServerCertificate + type: object + GetServiceLastAccessedDetailsRequest: + properties: + JobId: + allOf: + - $ref: '#/components/schemas/jobIDType' + - description: The ID of the request generated by the GenerateServiceLastAccessedDetails + operation. TheJobId returned by GenerateServiceLastAccessedDetail
+ must be used by the same role within a session, or by the same user
+ when used to call GetServiceLastAccessedDetail.
+ Marker:
+ allOf:
+ - $ref: '#/components/schemas/markerType'
+ - description: Use this parameter only when paginating results and only
+ after you receive a response indicating that the results are truncated.
+ Set it to the value of the Marker element in the response
+ that you received to indicate where the next call should start.
+ MaxItems:
+ allOf:
+ - $ref: '#/components/schemas/maxItemsType'
+ - description: Use this only when paginating results to indicate the
+ maximum number of items you want in the response. If additional items
+ exist beyond the maximum you specify, the IsTruncated response
+ element is true.
If you do not include this parameter,
+ the number of items defaults to 100. Note that IAM might return fewer
+ results, even when there are more results available. In that case, the
+ IsTruncated response element returns true,
+ and Marker contains a value to include in the subsequent
+ call that tells the service where to continue from.
Marker request parameter to retrieve
+ more items. Note that IAM might return fewer than the MaxItems
+ number of results even when there are more results available. We recommend
+ that you check IsTruncated after every call to ensure that
+ you receive all your results.
+ JobCompletionDate:
+ allOf:
+ - $ref: '#/components/schemas/dateType'
+ - description: "The date and time, in\_ISO 8601 date-time format, when the generated report job was completed\ + \ or failed.
This field is null if the job is still in progress,\
+ \ as indicated by a job status value of IN_PROGRESS.
IsTruncated is true, this
+ element is present and contains the value to use for the Marker
+ parameter in a subsequent pagination request.
+ ServicesLastAccessed:
+ allOf:
+ - $ref: '#/components/schemas/ServicesLastAccessed'
+ - description: " A\_ServiceLastAccessed object that contains\
+ \ details about the most recent attempt to access the service."
+ required:
+ - JobStatus
+ - JobCreationDate
+ - ServicesLastAccessed
+ - JobCompletionDate
+ type: object
+ GetServiceLastAccessedDetailsWithEntitiesRequest:
+ properties:
+ JobId:
+ allOf:
+ - $ref: '#/components/schemas/jobIDType'
+ - description: The ID of the request generated by the GenerateServiceLastAccessedDetails
+ operation.
+ Marker:
+ allOf:
+ - $ref: '#/components/schemas/markerType'
+ - description: Use this parameter only when paginating results and only
+ after you receive a response indicating that the results are truncated.
+ Set it to the value of the Marker element in the response
+ that you received to indicate where the next call should start.
+ MaxItems:
+ allOf:
+ - $ref: '#/components/schemas/maxItemsType'
+ - description: Use this only when paginating results to indicate the
+ maximum number of items you want in the response. If additional items
+ exist beyond the maximum you specify, the IsTruncated response
+ element is true.
If you do not include this parameter,
+ the number of items defaults to 100. Note that IAM might return fewer
+ results, even when there are more results available. In that case, the
+ IsTruncated response element returns true,
+ and Marker contains a value to include in the subsequent
+ call that tells the service where to continue from.
The service namespace for an Amazon Web Services service.\ + \ Provide the service namespace to learn when the IAM entity last attempted\ + \ to access the specified service.
To learn the service namespace\
+ \ for a service, see Actions, resources, and condition keys for Amazon Web Services services\
+ \ in the IAM User Guide. Choose the name of the service to view\
+ \ details for that service. In the first paragraph, find the service\
+ \ prefix. For example, (service prefix: a4b). For more\
+ \ information about service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\
+ \ General Reference.
EntityDetailsList object that contains\
+ \ details about when an IAM entity (user or role) used group or policy\
+ \ permissions in an attempt to access the specified Amazon Web Services\
+ \ service."
+ Error:
+ allOf:
+ - $ref: '#/components/schemas/ErrorDetails'
+ - description: An object that contains details about the reason the operation
+ failed.
+ IsTruncated:
+ allOf:
+ - $ref: '#/components/schemas/booleanType'
+ - description: A flag that indicates whether there are more items to return.
+ If your results were truncated, you can make a subsequent pagination
+ request using the Marker request parameter to retrieve
+ more items. Note that IAM might return fewer than the MaxItems
+ number of results even when there are more results available. We recommend
+ that you check IsTruncated after every call to ensure that
+ you receive all your results.
+ JobCompletionDate:
+ allOf:
+ - $ref: '#/components/schemas/dateType'
+ - description: "The date and time, in\_ISO 8601 date-time format, when the generated report job was completed\ + \ or failed.
This field is null if the job is still in progress,\
+ \ as indicated by a job status value of IN_PROGRESS.
IsTruncated is true, this
+ element is present and contains the value to use for the Marker
+ parameter in a subsequent pagination request.
+ required:
+ - JobStatus
+ - JobCreationDate
+ - JobCompletionDate
+ - EntityDetailsList
+ type: object
+ GetServiceLinkedRoleDeletionStatusRequest:
+ properties:
+ DeletionTaskId:
+ allOf:
+ - $ref: '#/components/schemas/DeletionTaskIdType'
+ - description: The deletion task identifier. This identifier is returned
+ by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
+ required:
+ - DeletionTaskId
+ title: GetServiceLinkedRoleDeletionStatusRequest
+ type: object
+ GetServiceLinkedRoleDeletionStatusResponse:
+ properties:
+ Reason:
+ allOf:
+ - $ref: '#/components/schemas/DeletionTaskFailureReasonType'
+ - description: An object that contains details about the reason the deletion
+ failed.
+ Status:
+ allOf:
+ - $ref: '#/components/schemas/DeletionTaskStatusType'
+ - description: The status of the deletion.
+ required:
+ - Status
+ type: object
+ GetUserPolicyRequest:
+ properties:
+ PolicyName:
+ allOf:
+ - $ref: '#/components/schemas/policyNameType'
+ - description: 'The name of the policy document to get.
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: _+=,.@-
' + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: 'The name of the user who the policy is associated with.
+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: _+=,.@-
' + required: + - UserName + - PolicyName + title: GetUserPolicyRequest + type: object + GetUserPolicyResponse: + description: 'Contains the response to a successful GetUserPolicy request. ' + properties: + PolicyDocument: + allOf: + - $ref: '#/components/schemas/policyDocumentType' + - description:The policy document.
IAM stores policies in JSON + format. However, resources that were created using CloudFormation templates + can be formatted in YAML. CloudFormation always converts a YAML policy + to JSON format before submitting it to IAM.
+ PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: The name of the policy. + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: The user the policy is associated with. + required: + - UserName + - PolicyName + - PolicyDocument + type: object + GetUserRequest: + properties: + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: 'The name of the user to get information about.
This + parameter is optional. If it is not included, it defaults to the user + making the request. 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: _+=,.@-
' + title: GetUserRequest + type: object + GetUserResponse: + description: 'Contains the response to a successful GetUser request. ' + example: + User: + Arn: arn:aws:iam::123456789012:user/Bob + CreateDate: '2012-09-21T23:03:13Z' + Path: / + UserId: AKIAIOSFODNN7EXAMPLE + UserName: Bob + properties: + User: + allOf: + - $ref: '#/components/schemas/User' + - description:A structure containing details about the IAM user.
+Due to a service issue, password last used data does + not include password use from May 3, 2018 22:50 PDT to May 23, 2018 + 14:08 PDT. This affects last + sign-in dates shown in the IAM console and password last used dates + in the IAM + credential report, and returned by this operation. If users signed + in during the affected time, the password last used date that is returned + is the date the user last signed in before May 3, 2018. For users that + signed in after May 23, 2018 14:08 PDT, the returned password last used + date is accurate.
You can use password last used information + to identify unused credentials for deletion. For example, you might + delete users who did not sign in to Amazon Web Services in the last + 90 days. In cases like this, we recommend that you adjust your evaluation + window to include dates after May 23, 2018. Alternatively, if your users + use access keys to access Amazon Web Services programmatically you can + refer to access key last used information because it is accurate for + all dates.
Contains information about an IAM group entity.
This + data type is used as a response element in the following operations: