diff --git a/old-outscale.yaml b/old-outscale.yaml
index a2d4030..6836ff6 100644
--- a/old-outscale.yaml
+++ b/old-outscale.yaml
@@ -167,6 +167,37 @@ components:
description: The ZIP code of the city.
type: string
type: object
+ AddUserToUserGroupRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ UserGroupName:
+ description: The name of the group you want to add a user to.
+ type: string
+ UserGroupPath:
+ description: The path to the group. If not specified, it is set to a slash
+ (`/`).
+ type: string
+ UserName:
+ description: The name of the user you want to add to the group.
+ type: string
+ UserPath:
+ description: The path to the user. If not specified, it is set to a slash
+ (`/`).
+ type: string
+ required:
+ - UserGroupName
+ - UserName
+ type: object
+ AddUserToUserGroupResponse:
+ additionalProperties: false
+ properties:
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ type: object
ApiAccessPolicy:
additionalProperties: false
description: Information about the API access policy.
@@ -187,7 +218,7 @@ components:
description: Information about the API access rule.
properties:
ApiAccessRuleId:
- description: " The ID of the API access rule."
+ description: The ID of the API access rule.
type: string
CaIds:
description: One or more IDs of Client Certificate Authorities (CAs) used
@@ -224,13 +255,13 @@ components:
type: object
BackendVmHealth:
additionalProperties: false
- description: Information about the health of a back-end VM.
+ description: Information about the health of a backend VM.
properties:
Description:
- description: The description of the state of the back-end VM.
+ description: The description of the state of the backend VM.
type: string
State:
- description: The state of the back-end VM (`InService` \| `OutOfService`
+ description: The state of the backend VM (`InService` \| `OutOfService`
\| `Unknown`).
type: string
StateReason:
@@ -239,7 +270,7 @@ components:
Specifically, whether the cause is Elastic Load Balancing or the VM (`ELB` \| `Instance` \| `N/A`).
type: string
VmId:
- description: The ID of the back-end VM.
+ description: The ID of the backend VM.
type: string
type: object
BlockDeviceMappingCreated:
@@ -318,8 +349,8 @@ components:
false, the volume is not deleted when terminating the VM.
type: boolean
LinkDate:
- description: The date and time of attachment of the volume to the VM, in
- ISO 8601 date-time format.
+ description: The date and time (UTC) of attachment of the volume to the
+ VM, in ISO 8601 date-time format.
format: date
type: string
State:
@@ -439,7 +470,7 @@ components:
"$ref": "#/components/schemas/CatalogEntry"
type: array
FromDate:
- description: The beginning of the time period, in ISO 8601 date-time format.
+ description: The beginning of the time period (UTC).
format: date-time
type: string
State:
@@ -449,7 +480,7 @@ components:
- OBSOLETE
type: string
ToDate:
- description: The end of the time period, in ISO 8601 date-time format.
+ description: The end of the time period (UTC).
format: date-time
type: string
type: object
@@ -517,7 +548,7 @@ components:
description: The category of the resource (for example, `network`).
type: string
FromDate:
- description: The beginning of the time period, in ISO 8601 date-time format.
+ description: The beginning of the time period (UTC).
format: datetime
type: string
Operation:
@@ -544,7 +575,7 @@ components:
description: A description of the consumed resource.
type: string
ToDate:
- description: The end of the time period, in ISO 8601 date-time format.
+ description: The end of the time period (UTC).
format: datetime
type: string
Type:
@@ -667,7 +698,7 @@ components:
additionalProperties: false
properties:
CaIds:
- description: " One or more IDs of Client Certificate Authorities (CAs)."
+ description: One or more IDs of Client Certificate Authorities (CAs).
items:
type: string
type: array
@@ -685,7 +716,7 @@ components:
perform the action.
type: boolean
IpRanges:
- description: One or more IP addresses or CIDR blocks (for example, `192.0.2.0/16`).
+ description: One or more IPs or CIDR blocks (for example, `192.0.2.0/16`).
items:
type: string
type: array
@@ -1243,6 +1274,9 @@ components:
CreateNatServiceRequest:
additionalProperties: false
properties:
+ ClientToken:
+ description: A unique identifier which enables you to manage the idempotency.
+ type: string
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
@@ -1429,6 +1463,7 @@ components:
PolicyOrn:
description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
type: string
SetAsDefault:
description: If set to true, the new policy version is set as the default
@@ -1652,13 +1687,13 @@ components:
properties:
Body:
description: 'The PEM-encoded X509 certificate.
With OSC CLI, use the
- following syntax to make sure your CA file is correctly parsed: `--CaPem="$(cat
- FILENAME)"`.'
+ following syntax to make sure your certificate file is correctly parsed:
+ `--Body="$(cat FILENAME)"`.'
type: string
Chain:
description: 'The PEM-encoded intermediate certification authorities.
With OSC CLI, use the following syntax to make sure your CA file is
- correctly parsed: `--CaPem="$(cat FILENAME)"`.'
+ />With OSC CLI, use the following syntax to make sure your certificate
+ chain file is correctly parsed: `--Chain="$(cat FILENAME)"`.'
type: string
DryRun:
description: If true, checks whether you have the required permissions to
@@ -1675,8 +1710,8 @@ components:
type: string
PrivateKey:
description: 'The PEM-encoded private key matching the certificate.
With
- OSC CLI, use the following syntax to make sure your CA file is correctly
- parsed: `--CaPem="$(cat FILENAME)"`.'
+ OSC CLI, use the following syntax to make sure your key file is correctly
+ parsed: `--PrivateKey="$(cat FILENAME)"`.'
type: string
required:
- Body
@@ -1816,6 +1851,31 @@ components:
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
+ CreateUserGroupRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ Path:
+ description: The path to the group. If not specified, it is set to a slash
+ (`/`).
+ type: string
+ UserGroupName:
+ description: The name of the group.
+ type: string
+ required:
+ - UserGroupName
+ type: object
+ CreateUserGroupResponse:
+ additionalProperties: false
+ properties:
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ UserGroup:
+ "$ref": "#/components/schemas/UserGroup"
+ type: object
CreateUserRequest:
additionalProperties: false
properties:
@@ -1825,14 +1885,14 @@ components:
type: boolean
Path:
description: The path to the EIM user you want to create (by default, `/`).
- This path name must begin and end with a slash (/), and contain between
- 1 and 512 alphanumeric characters and/or slashes (/), or underscores (_).
+ This path name must begin and end with a slash (`/`), and contain between
+ 1 and 512 alphanumeric characters and/or slashes (`/`), or underscores
+ (_).
type: string
UserName:
- description: The name of the EIM user you want to create. This user name
- must contain between 1 and 64 alphanumeric characters and/or pluses (+),
- equals (=), commas (,), periods (.), at signs (@), dashes (-), or underscores
- (_).
+ description: The name of the EIM user. This user name must contain between
+ 1 and 64 alphanumeric characters and/or pluses (+), equals (=), commas
+ (,), periods (.), at signs (@), dashes (-), or underscores (_).
type: string
required:
- UserName
@@ -1938,7 +1998,7 @@ components:
type: string
CpuPerformance:
default: high
- description: 'The performance of the VMs (`medium` \| `high` \| `highest`). '
+ description: The performance of the VMs (`medium` \| `high` \| `highest`).
enum:
- medium
- high
@@ -2115,9 +2175,9 @@ components:
ratio of 300 IOPS per gibibyte.
type: integer
Size:
- description: 'The size of the volume, in gibibytes (GiB). The maximum allowed
+ description: The size of the volume, in gibibytes (GiB). The maximum allowed
size for a volume is 14901 GiB. This parameter is required if the volume
- is not created from a snapshot (`SnapshotId` unspecified). '
+ is not created from a snapshot (`SnapshotId` unspecified).
type: integer
SnapshotId:
description: The ID of the snapshot from which you want to create the volume.
@@ -2711,6 +2771,7 @@ components:
PolicyOrn:
description: The OUTSCALE Resource Name (ORN) of the policy you want to
delete. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
type: string
required:
- PolicyOrn
@@ -2727,6 +2788,7 @@ components:
PolicyOrn:
description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
type: string
VersionId:
description: The ID of the version of the policy you want to delete.
@@ -2967,6 +3029,60 @@ components:
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
+ DeleteUserGroupPolicyRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ PolicyName:
+ description: The name of the policy document you want to delete.
+ type: string
+ UserGroupName:
+ description: The name of the group.
+ type: string
+ UserGroupPath:
+ description: The path to the group. If not specified, it is set to a slash
+ (`/`).
+ type: string
+ required:
+ - UserGroupName
+ - PolicyName
+ type: object
+ DeleteUserGroupPolicyResponse:
+ additionalProperties: false
+ properties:
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ type: object
+ DeleteUserGroupRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ Force:
+ description: If true, forces the deletion of the user group even if it is
+ not empty.
+ type: boolean
+ Path:
+ description: The path to the group. If not specified, it is set to a slash
+ (`/`).
+ type: string
+ UserGroupName:
+ description: The name of the group you want to delete.
+ type: string
+ required:
+ - UserGroupName
+ type: object
+ DeleteUserGroupResponse:
+ additionalProperties: false
+ properties:
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ type: object
DeleteUserRequest:
additionalProperties: false
properties:
@@ -3032,7 +3148,7 @@ components:
perform the action.
type: boolean
VmTemplateId:
- description: 'The ID of the VM template you want to delete. '
+ description: The ID of the VM template you want to delete.
type: string
required:
- VmTemplateId
@@ -3136,7 +3252,7 @@ components:
additionalProperties: false
properties:
BackendVmIds:
- description: One or more IDs of back-end VMs.
+ description: One or more IDs of backend VMs.
items:
type: string
type: array
@@ -3324,13 +3440,15 @@ components:
description: Information about the errors.
properties:
Code:
- description: The code of the error.
+ description: The code of the error (for example, `4078`). You can search
+ for this returned code in the [errors page](api-errors.html) to find more
+ details about the error.
type: string
Details:
- description: The details of the error.
+ description: A description providing more details about the error.
type: string
Type:
- description: The type of the error.
+ description: The type of the error (for example, `InvalidParameterValue`).
type: string
type: object
FiltersAccessKeys:
@@ -3373,7 +3491,7 @@ components:
type: string
type: array
IpRanges:
- description: One or more IP addresses or CIDR blocks (for example, `192.0.2.0/16`).
+ description: One or more IPs or CIDR blocks (for example, `192.0.2.0/16`).
items:
type: string
type: array
@@ -3886,6 +4004,11 @@ components:
additionalProperties: false
description: One or more filters.
properties:
+ ClientTokens:
+ description: The idempotency tokens provided when creating the NAT services.
+ items:
+ type: string
+ type: array
NatServiceIds:
description: The IDs of the NAT services.
items:
@@ -4141,6 +4264,11 @@ components:
items:
type: string
type: array
+ LinkPublicIpPublicDnsNames:
+ description: The public DNS names associated with the public IPs.
+ items:
+ type: string
+ type: array
LinkPublicIpPublicIpIds:
description: The allocation IDs returned when the public IPs were allocated
to their accounts.
@@ -4612,7 +4740,8 @@ components:
type: string
type: array
States:
- description: The states of the snapshots (`in-queue` \| `completed` \| `error`).
+ description: The states of the snapshots (`in-queue` \| `pending` \| `completed`
+ \| `error` \| `deleting`).
items:
type: string
type: array
@@ -4755,6 +4884,20 @@ components:
type: string
type: array
type: object
+ FiltersUserGroup:
+ additionalProperties: false
+ description: One or more filters.
+ properties:
+ PathPrefix:
+ description: The path prefix of the groups. If not specified, it is set
+ to a slash (`/`).
+ type: string
+ UserGroupIds:
+ description: The IDs of the user groups.
+ items:
+ type: string
+ type: array
+ type: object
FiltersVirtualGateway:
additionalProperties: false
description: One or more filters.
@@ -4847,7 +4990,6 @@ components:
CreationDates:
description: The dates when the VMs were launched.
items:
- format: date
type: string
type: array
ImageIds:
@@ -4904,7 +5046,8 @@ components:
type: integer
type: array
NicLinkNicLinkNicDates:
- description: The dates and time when the NICs were attached to the VMs.
+ description: The dates and times (UTC) when the NICs were attached to the
+ VMs.
items:
format: date
type: string
@@ -5204,7 +5347,6 @@ components:
type: object
FiltersVmTemplate:
additionalProperties: false
- description: One or more filters.
properties:
CpuCores:
description: The number of vCores.
@@ -5333,13 +5475,13 @@ components:
type: string
type: array
MaintenanceEventsNotAfter:
- description: The latest time the event can end.
+ description: The latest date and time (UTC) the event can end.
items:
format: date
type: string
type: array
MaintenanceEventsNotBefore:
- description: The earliest time the event can start.
+ description: The earliest date and time (UTC) the event can start.
items:
format: date
type: string
@@ -5621,8 +5763,7 @@ components:
"$ref": "#/components/schemas/BlockDeviceMappingImage"
type: array
CreationDate:
- description: The date and time of creation of the OMI, in ISO 8601 date-time
- format.
+ description: The date and time (UTC) of creation of the OMI.
format: date
type: string
Description:
@@ -5692,6 +5833,18 @@ components:
description: The ID of the OMI export task.
type: string
type: object
+ InlinePolicy:
+ additionalProperties: false
+ description: Information about an inline policy.
+ properties:
+ Body:
+ description: The policy document, corresponding to a JSON string that contains
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
+ type: string
+ Name:
+ description: The name of the policy.
+ type: string
+ type: object
InternetService:
additionalProperties: false
description: Information about the Internet service.
@@ -5800,21 +5953,21 @@ components:
additionalProperties: false
properties:
BackendIps:
- description: " One or more public IPs of back-end VMs."
+ description: One or more public IPs of backend VMs.
items:
type: string
type: array
BackendVmIds:
- description: " One or more IDs of back-end VMs."
+ description: One or more IDs of backend VMs.
items:
type: string
type: array
DryRun:
- description: " If true, checks whether you have the required permissions
- to perform the action."
+ description: If true, checks whether you have the required permissions to
+ perform the action.
type: boolean
LoadBalancerName:
- description: " The name of the load balancer. "
+ description: The name of the load balancer.
type: string
required:
- LoadBalancerName
@@ -5825,6 +5978,30 @@ components:
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
+ LinkManagedPolicyToUserGroupRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ PolicyOrn:
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
+ see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ type: string
+ UserGroupName:
+ description: The name of the group you want to link the policy to.
+ type: string
+ required:
+ - PolicyOrn
+ - UserGroupName
+ type: object
+ LinkManagedPolicyToUserGroupResponse:
+ additionalProperties: false
+ properties:
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ type: object
LinkNic:
additionalProperties: false
description: Information about the NIC attachment.
@@ -5923,6 +6100,7 @@ components:
PolicyOrn:
description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
type: string
UserName:
description: The name of the user you want to link the policy to (between
@@ -6059,19 +6237,22 @@ components:
description: One or more associations between the route table and the Subnets.
properties:
LinkRouteTableId:
- description: The ID of the association between the route table and the Subnet.
+ description: The ID of the association between the route table and the Net
+ or Subnet.
type: string
Main:
description: If true, the route table is the main one.
type: boolean
NetId:
- description: The ID of the Net.
+ description: The ID of the Net, if the route table is not explicitly linked
+ to a Subnet.
type: string
RouteTableId:
description: The ID of the route table.
type: string
SubnetId:
- description: The ID of the Subnet.
+ description: The ID of the Subnet, if the route table is explicitly linked
+ to a Subnet.
type: string
type: object
LinkRouteTableRequest:
@@ -6157,18 +6338,19 @@ components:
type: object
LinkedPolicy:
additionalProperties: false
- description: Information about the attached policy.
+ description: Information about the linked policy.
properties:
CreationDate:
- description: The date and time of creation of the attached policy.
+ description: The date and time (UTC) of creation of the linked policy.
format: date-time
type: string
LastModificationDate:
- description: The date and time at which the attached policy was last modified.
+ description: The date and time (UTC) at which the linked policy was last
+ modified.
format: date-time
type: string
Orn:
- description: The Outscale Resource Name (ORN) of the policy. For more information,
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
type: string
PolicyId:
@@ -6205,11 +6387,11 @@ components:
description: Information about the listener.
properties:
BackendPort:
- description: The port on which the back-end VM is listening (between `1`
+ description: The port on which the backend VM is listening (between `1`
and `65535`, both included).
type: integer
BackendProtocol:
- description: The protocol for routing traffic to back-end VMs (`HTTP` \|
+ description: The protocol for routing traffic to backend VMs (`HTTP` \|
`HTTPS` \| `TCP` \| `SSL`).
type: string
LoadBalancerPort:
@@ -6236,11 +6418,11 @@ components:
description: Information about the listener to create.
properties:
BackendPort:
- description: The port on which the back-end VM is listening (between `1`
+ description: The port on which the backend VM is listening (between `1`
and `65535`, both included).
type: integer
BackendProtocol:
- description: The protocol for routing traffic to back-end VMs (`HTTP` \|
+ description: The protocol for routing traffic to backend VMs (`HTTP` \|
`HTTPS` \| `TCP` \| `SSL`).
type: string
LoadBalancerPort:
@@ -6305,9 +6487,9 @@ components:
description: The type of action for the rule (always `forward`).
type: string
HostNamePattern:
- description: 'A host-name pattern for the rule, with a maximum length of
+ description: A host-name pattern for the rule, with a maximum length of
128 characters. This host-name pattern supports maximum three wildcards,
- and must not contain any special characters except [-.?]. '
+ and must not contain any special characters except [-.?].
type: string
ListenerRuleName:
description: A human-readable name for the listener rule.
@@ -6338,12 +6520,12 @@ components:
"$ref": "#/components/schemas/ApplicationStickyCookiePolicy"
type: array
BackendIps:
- description: One or more public IPs of back-end VMs.
+ description: One or more public IPs of backend VMs.
items:
type: string
type: array
BackendVmIds:
- description: One or more IDs of back-end VMs for the load balancer.
+ description: One or more IDs of backend VMs for the load balancer.
items:
type: string
type: array
@@ -6484,8 +6666,7 @@ components:
description: The name of the logged call.
type: string
QueryDate:
- description: The date and time of the logged call, in ISO 8601 date-time
- format.
+ description: The date and time (UTC) of the logged call.
format: date
type: string
QueryHeaderRaw:
@@ -6529,11 +6710,11 @@ components:
description: The description of the event.
type: string
NotAfter:
- description: The latest scheduled end time for the event.
+ description: The latest scheduled end date and time (UTC) for the event.
format: date
type: string
NotBefore:
- description: The earliest scheduled start time for the event.
+ description: The earliest scheduled start date and time (UTC) for the event.
format: date
type: string
type: object
@@ -6541,6 +6722,9 @@ components:
additionalProperties: false
description: Information about the NAT service.
properties:
+ ClientToken:
+ description: The idempotency token provided when creating the NAT service.
+ type: string
NatServiceId:
description: The ID of the NAT service.
type: string
@@ -6628,7 +6812,7 @@ components:
AccepterNet:
"$ref": "#/components/schemas/AccepterNet"
ExpirationDate:
- description: The date and time at which the Net peerings expire.
+ description: The date and time (UTC) at which the Net peerings expire.
format: date-time
nullable: true
type: string
@@ -6925,8 +7109,8 @@ components:
type: object
Phase1Options:
additionalProperties: false
- description: 'Information about Phase 1 of the Internet Key Exchange (IKE) negotiation.
- When Phase 1 finishes successfully, peers proceed to Phase 2 negotiations. '
+ description: Information about Phase 1 of the Internet Key Exchange (IKE) negotiation.
+ When Phase 1 finishes successfully, peers proceed to Phase 2 negotiations.
properties:
DpdTimeoutAction:
description: The action to carry out after a Dead Peer Detection (DPD) timeout
@@ -6974,7 +7158,7 @@ components:
type: object
Phase2Options:
additionalProperties: false
- description: 'Information about Phase 2 of the Internet Key Exchange (IKE) negotiation. '
+ description: Information about Phase 2 of the Internet Key Exchange (IKE) negotiation.
properties:
Phase2DhGroupNumbers:
description: The Diffie-Hellman (DH) group numbers allowed for the VPN tunnel
@@ -7004,16 +7188,6 @@ components:
any character except line breaks and double quotes (").
type: string
type: object
- Phase2OptionsToUpdate:
- additionalProperties: false
- description: 'Information about Phase 2 of the Internet Key Exchange (IKE) negotiation. '
- properties:
- PreSharedKey:
- description: The pre-shared key to establish the initial authentication
- between the client gateway and the virtual gateway. This key can contain
- any character except line breaks and double quotes (").
- type: string
- type: object
Placement:
additionalProperties: false
description: Information about the placement of the VM.
@@ -7032,7 +7206,7 @@ components:
description: Information about the policy.
properties:
CreationDate:
- description: The date and time of creation of the policy.
+ description: The date and time (UTC) of creation of the policy.
format: date-time
type: string
Description:
@@ -7043,7 +7217,7 @@ components:
EIM user.
type: boolean
LastModificationDate:
- description: The date and time at which the policy was last modified.
+ description: The date and time (UTC) at which the policy was last modified.
format: date-time
type: string
Orn:
@@ -7071,10 +7245,11 @@ components:
description: Information about the policy version.
properties:
Body:
- description: The policy document as a json string.
+ description: The policy document, corresponding to a JSON string that contains
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
type: string
CreationDate:
- description: The date and time of creation of the version.
+ description: The date and time (UTC) of creation of the version.
format: date-time
type: string
DefaultVersion:
@@ -7185,6 +7360,38 @@ components:
service.
type: string
type: object
+ PutUserGroupPolicyRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ PolicyDocument:
+ description: The policy document, corresponding to a JSON string that contains
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
+ type: string
+ PolicyName:
+ description: The name of the policy.
+ type: string
+ UserGroupName:
+ description: The name of the group.
+ type: string
+ UserGroupPath:
+ description: The path to the group. If not specified, it is set to a slash
+ (`/`).
+ type: string
+ required:
+ - PolicyName
+ - PolicyDocument
+ - UserGroupName
+ type: object
+ PutUserGroupPolicyResponse:
+ additionalProperties: false
+ properties:
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ type: object
Quota:
additionalProperties: false
description: Information about the quota.
@@ -7408,7 +7615,6 @@ components:
type: object
ReadCatalogsRequest:
additionalProperties: false
- description: ReadCatalogsRequest
properties:
DryRun:
description: If true, checks whether you have the required permissions to
@@ -7419,7 +7625,6 @@ components:
type: object
ReadCatalogsResponse:
additionalProperties: false
- description: ReadCatalogsResponse
properties:
Catalogs:
description: Information about one or more catalogs.
@@ -7438,6 +7643,15 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersClientGateway"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadClientGatewaysResponse:
additionalProperties: false
@@ -7447,6 +7661,11 @@ components:
items:
"$ref": "#/components/schemas/ClientGateway"
type: array
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
@@ -7487,6 +7706,7 @@ components:
description: The beginning of the time period, in ISO 8601 date format (for
example, `2020-06-14`). The date-time format is also accepted, but only
with a time set to midnight (for example, `2020-06-14T00:00:00.000Z`).
+ This value is included in the time period.
format: datetime
type: string
Overall:
@@ -7500,12 +7720,14 @@ components:
ShowPrice:
description: If true, the response also includes the unit price of the consumed
resource (`UnitPrice`) and the total price of the consumed resource during
- the specified time period (`Price`), in the currency of the Region's catalog.
+ the specified time period (`Price`), in the currency of your account.
type: boolean
ToDate:
description: The end of the time period, in ISO 8601 date format (for example,
`2020-06-30`). The date-time format is also accepted, but only with a
- time set to midnight (for example, `2020-06-30T00:00:00.000Z`).
+ time set to midnight (for example, `2020-06-30T00:00:00.000Z`). This value
+ is excluded from the time period, and must be set to a later date than
+ `FromDate`.
format: datetime
type: string
required:
@@ -7521,6 +7743,11 @@ components:
items:
"$ref": "#/components/schemas/ConsumptionEntry"
type: array
+ Currency:
+ description: The currency of your account for the `UnitPrice` and `Price`
+ parameters, in the ISO-4217 format (for example, `EUR`).
+ nullable: true
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
@@ -7533,6 +7760,15 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersDedicatedGroup"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadDedicatedGroupsResponse:
additionalProperties: false
@@ -7542,6 +7778,11 @@ components:
items:
"$ref": "#/components/schemas/DedicatedGroup"
type: array
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
@@ -7589,6 +7830,15 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersDirectLinkInterface"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadDirectLinkInterfacesResponse:
additionalProperties: false
@@ -7598,6 +7848,11 @@ components:
items:
"$ref": "#/components/schemas/DirectLinkInterfaces"
type: array
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
@@ -7610,6 +7865,15 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersDirectLink"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadDirectLinksResponse:
additionalProperties: false
@@ -7619,6 +7883,11 @@ components:
items:
"$ref": "#/components/schemas/DirectLink"
type: array
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
@@ -7672,6 +7941,15 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersExportTask"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadImageExportTasksResponse:
additionalProperties: false
@@ -7681,6 +7959,11 @@ components:
items:
"$ref": "#/components/schemas/ImageExportTask"
type: array
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
@@ -7728,6 +8011,15 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersInternetService"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadInternetServicesResponse:
additionalProperties: false
@@ -7737,6 +8029,11 @@ components:
items:
"$ref": "#/components/schemas/InternetService"
type: array
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
@@ -7749,7 +8046,16 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersKeypair"
- type: object
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
+ type: object
ReadKeypairsResponse:
additionalProperties: false
properties:
@@ -7758,14 +8064,21 @@ components:
items:
"$ref": "#/components/schemas/Keypair"
type: array
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
+ type: object
ReadLinkedPoliciesFilters:
additionalProperties: false
description: One or more filters.
properties:
PathPrefix:
- description: The path prefix of the policies, set to a slash (`/`) by default.
+ description: The path prefix of the policies. If not specified, it is set
+ to a slash (`/`).
type: string
type: object
ReadLinkedPoliciesRequest:
@@ -7782,11 +8095,13 @@ components:
type: integer
ResultsPerPage:
description: The maximum number of items that can be returned in a single
- response (by default, 100).
+ response (by default, `100`).
type: integer
UserName:
description: The name of the user the policies are linked to.
type: string
+ required:
+ - UserName
type: object
ReadLinkedPoliciesResponse:
additionalProperties: false
@@ -7885,6 +8200,15 @@ components:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadLocationsResponse:
additionalProperties: false
@@ -7894,6 +8218,55 @@ components:
items:
"$ref": "#/components/schemas/Location"
type: array
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ type: object
+ ReadManagedPoliciesLinkedToUserGroupRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ Filters:
+ "$ref": "#/components/schemas/FiltersUserGroup"
+ FirstItem:
+ description: The item starting the list of policies requested.
+ type: integer
+ ResultsPerPage:
+ description: The maximum number of items that can be returned in a single
+ response (by default, `100`).
+ type: integer
+ UserGroupName:
+ description: The name of the group.
+ type: string
+ required:
+ - UserGroupName
+ type: object
+ ReadManagedPoliciesLinkedToUserGroupResponse:
+ additionalProperties: false
+ properties:
+ HasMoreItems:
+ description: If true, there are more items to return using the `FirstItem`
+ parameter in a new request.
+ type: boolean
+ MaxResultsLimit:
+ description: Indicates maximum results defined for the operation.
+ type: integer
+ MaxResultsTruncated:
+ description: If true, indicates whether requested page size is more than
+ allowed.
+ type: boolean
+ Policies:
+ description: A list of policies.
+ items:
+ "$ref": "#/components/schemas/LinkedPolicy"
+ type: array
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
@@ -7941,10 +8314,24 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersService"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadNetAccessPointServicesResponse:
additionalProperties: false
properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
Services:
@@ -8032,6 +8419,15 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersNet"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadNetsResponse:
additionalProperties: false
@@ -8041,6 +8437,11 @@ components:
items:
"$ref": "#/components/schemas/Net"
type: array
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
@@ -8073,8 +8474,8 @@ components:
description: If set to true, lists only the policies attached to a user.
type: boolean
PathPrefix:
- description: The path prefix you can use to filter the results, set to a
- slash (`/`) by default.
+ description: The path prefix you can use to filter the results. If not specified,
+ it is set to a slash (`/`).
type: string
Scope:
description: The scope to filter policies (`OWS` \| `LOCAL`).
@@ -8097,7 +8498,7 @@ components:
type: integer
ResultsPerPage:
description: The maximum number of items that can be returned in a single
- response (by default, 100).
+ response (by default, `100`).
type: integer
type: object
ReadPoliciesResponse:
@@ -8128,6 +8529,7 @@ components:
PolicyOrn:
description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
type: string
required:
- PolicyOrn
@@ -8146,6 +8548,7 @@ components:
PolicyOrn:
description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
type: string
VersionId:
description: The ID of the policy version.
@@ -8171,10 +8574,11 @@ components:
PolicyOrn:
description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
type: string
ResultsPerPage:
description: The maximum number of items that can be returned in a single
- response (by default, 100).
+ response (by default, `100`).
type: integer
required:
- PolicyOrn
@@ -8206,10 +8610,24 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersProductType"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadProductTypesResponse:
additionalProperties: false
properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ProductTypes:
description: Information about one or more product types.
items:
@@ -8241,10 +8659,24 @@ components:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadPublicIpRangesResponse:
additionalProperties: false
properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
PublicIps:
description: The list of public IPv4 addresses used in the Region, in CIDR
notation.
@@ -8298,10 +8730,24 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersQuota"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadQuotasResponse:
additionalProperties: false
properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
QuotaTypes:
description: Information about one or more quotas.
items:
@@ -8394,10 +8840,24 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersSecurityGroup"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadSecurityGroupsResponse:
additionalProperties: false
properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
SecurityGroups:
@@ -8436,10 +8896,24 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersExportTask"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadSnapshotExportTasksResponse:
additionalProperties: false
properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
SnapshotExportTasks:
@@ -8457,10 +8931,24 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersSnapshot"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadSnapshotsResponse:
additionalProperties: false
properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
Snapshots:
@@ -8478,10 +8966,24 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersSubnet"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadSubnetsResponse:
additionalProperties: false
properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
Subnets:
@@ -8499,10 +9001,24 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersSubregion"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadSubregionsResponse:
additionalProperties: false
properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
Subregions:
@@ -8520,10 +9036,24 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersTag"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadTagsResponse:
additionalProperties: false
properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
Tags:
@@ -8532,6 +9062,177 @@ components:
"$ref": "#/components/schemas/Tag"
type: array
type: object
+ ReadUserGroupPoliciesRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ FirstItem:
+ description: The item starting the list of policies requested.
+ type: integer
+ ResultsPerPage:
+ description: The maximum number of items that can be returned in a single
+ response (by default, `100`).
+ type: integer
+ UserGroupName:
+ description: The name of the group.
+ type: string
+ UserGroupPath:
+ description: The path to the group. If not specified, it is set to a slash
+ (`/`).
+ type: string
+ required:
+ - UserGroupName
+ type: object
+ ReadUserGroupPoliciesResponse:
+ additionalProperties: false
+ properties:
+ HasMoreItems:
+ description: If true, there are more items to return using the `FirstItem`
+ parameter in a new request.
+ type: boolean
+ MaxResultsLimit:
+ description: Indicates maximum results defined for the operation.
+ type: integer
+ MaxResultsTruncated:
+ description: If true, indicates whether requested page size is more than
+ allowed.
+ type: boolean
+ Policies:
+ description: A list of policies.
+ items:
+ "$ref": "#/components/schemas/InlinePolicy"
+ type: array
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ type: object
+ ReadUserGroupPolicyRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ PolicyName:
+ description: The name of the policy.
+ type: string
+ UserGroupName:
+ description: The name of the group.
+ type: string
+ UserGroupPath:
+ description: The path to the group. If not specified, it is set to a slash
+ (`/`).
+ type: string
+ required:
+ - PolicyName
+ - UserGroupName
+ type: object
+ ReadUserGroupPolicyResponse:
+ additionalProperties: false
+ properties:
+ Policy:
+ "$ref": "#/components/schemas/InlinePolicy"
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ type: object
+ ReadUserGroupRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ Path:
+ description: The path to the group. If not specified, it is set to a slash
+ (`/`).
+ type: string
+ UserGroupName:
+ description: The name of the group.
+ type: string
+ required:
+ - UserGroupName
+ type: object
+ ReadUserGroupResponse:
+ additionalProperties: false
+ properties:
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ UserGroup:
+ "$ref": "#/components/schemas/UserGroup"
+ Users:
+ description: A list of EIM users.
+ items:
+ "$ref": "#/components/schemas/User"
+ type: array
+ type: object
+ ReadUserGroupsPerUserRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ UserName:
+ description: The name of the user.
+ type: string
+ UserPath:
+ description: The path to the user (by default, `/`).
+ type: string
+ required:
+ - UserName
+ type: object
+ ReadUserGroupsPerUserResponse:
+ additionalProperties: false
+ properties:
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ UserGroups:
+ description: A list of user groups.
+ items:
+ "$ref": "#/components/schemas/UserGroup"
+ type: array
+ type: object
+ ReadUserGroupsRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ Filters:
+ "$ref": "#/components/schemas/FiltersUserGroup"
+ FirstItem:
+ description: The item starting the list of groups requested.
+ type: integer
+ ResultsPerPage:
+ description: The maximum number of items that can be returned in a single
+ response (by default, `100`).
+ type: integer
+ type: object
+ ReadUserGroupsResponse:
+ additionalProperties: false
+ properties:
+ HasMoreItems:
+ description: If true, there are more items to return using the `FirstItem`
+ parameter in a new request.
+ type: boolean
+ MaxResultsLimit:
+ description: Indicates maximum results defined for the operation.
+ type: integer
+ MaxResultsTruncated:
+ description: If true, indicates whether requested page size is more than
+ allowed.
+ type: boolean
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ UserGroups:
+ description: A list of user groups.
+ items:
+ "$ref": "#/components/schemas/UserGroup"
+ type: array
+ type: object
ReadUsersRequest:
additionalProperties: false
properties:
@@ -8602,7 +9303,6 @@ components:
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
VmGroups:
- description: Information about one or more VM groups.
items:
"$ref": "#/components/schemas/VmGroup"
type: array
@@ -8637,10 +9337,24 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersVmType"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadVmTypesResponse:
additionalProperties: false
properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
VmTypes:
@@ -8653,7 +9367,7 @@ components:
additionalProperties: false
properties:
BackendVmIds:
- description: One or more IDs of back-end VMs.
+ description: One or more IDs of backend VMs.
items:
type: string
type: array
@@ -8671,7 +9385,7 @@ components:
additionalProperties: false
properties:
BackendVmHealth:
- description: Information about the health of one or more back-end VMs.
+ description: Information about the health of one or more backend VMs.
items:
"$ref": "#/components/schemas/BackendVmHealth"
type: array
@@ -8727,10 +9441,24 @@ components:
type: boolean
Filters:
"$ref": "#/components/schemas/FiltersVmsState"
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between
+ `1`and `1000`, both included). By default, `100`.
+ type: integer
type: object
ReadVmsStateResponse:
additionalProperties: false
properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers
+ to a specific page.
+ format: byte
+ type: string
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
VmStates:
@@ -8846,8 +9574,8 @@ components:
properties:
BackendVmIds:
description: |-
- One or more IDs of back-end VMs.
- Specifying the same ID several times has no effect as each back-end VM has equal weight.
+ One or more IDs of backend VMs.
+ Specifying the same ID several times has no effect as each backend VM has equal weight.
items:
type: string
type: array
@@ -8887,6 +9615,36 @@ components:
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
+ RemoveUserFromUserGroupRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ UserGroupName:
+ description: The name of the group you want to remove the user from.
+ type: string
+ UserGroupPath:
+ description: The path to the group. If not specified, it is set to a slash
+ (`/`).
+ type: string
+ UserName:
+ description: The name of the user you want to remove from the group.
+ type: string
+ UserPath:
+ description: The path to the user (by default, `/`).
+ type: string
+ required:
+ - UserGroupName
+ - UserName
+ type: object
+ RemoveUserFromUserGroupResponse:
+ additionalProperties: false
+ properties:
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ type: object
ResourceLoadBalancerTag:
additionalProperties: false
description: Information about the tag.
@@ -8948,7 +9706,7 @@ components:
description: The ID of the NIC.
type: string
State:
- description: 'The state of a route in the route table (always `active`). '
+ description: The state of a route in the route table (always `active`).
type: string
VmAccountId:
description: The account ID of the owner of the VM.
@@ -9172,8 +9930,8 @@ components:
description: The name of the server certificate.
type: string
Orn:
- description: The Outscale Resource Name (ORN) of the server certificate.
- For more information, see [Resource Identifiers > Outscale Resource Names
+ description: The OUTSCALE Resource Name (ORN) of the server certificate.
+ For more information, see [Resource Identifiers > OUTSCALE Resource Names
(ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns).
type: string
Path:
@@ -9206,6 +9964,7 @@ components:
PolicyOrn:
description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
type: string
VersionId:
description: The ID of the version.
@@ -9231,7 +9990,7 @@ components:
description: The account ID of the owner of the snapshot.
type: string
CreationDate:
- description: The date and time of creation of the snapshot.
+ description: The date and time (UTC) of creation of the snapshot.
format: datetime
type: string
Description:
@@ -9246,7 +10005,8 @@ components:
description: The ID of the snapshot.
type: string
State:
- description: The state of the snapshot (`in-queue` \| `completed` \| `error`).
+ description: The state of the snapshot (`in-queue` \| `pending` \| `completed`
+ \| `error` \| `deleting`)).
type: string
Tags:
description: One or more tags associated with the snapshot.
@@ -9497,21 +10257,21 @@ components:
additionalProperties: false
properties:
BackendIps:
- description: " One or more public IPs of back-end VMs."
+ description: One or more public IPs of backend VMs.
items:
type: string
type: array
BackendVmIds:
- description: " One or more IDs of back-end VMs."
+ description: One or more IDs of backend VMs.
items:
type: string
type: array
DryRun:
- description: " If true, checks whether you have the required permissions
- to perform the action."
+ description: If true, checks whether you have the required permissions to
+ perform the action.
type: boolean
LoadBalancerName:
- description: " The name of the load balancer."
+ description: The name of the load balancer.
type: string
required:
- LoadBalancerName
@@ -9522,6 +10282,30 @@ components:
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
+ UnlinkManagedPolicyFromUserGroupRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ PolicyOrn:
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
+ see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ type: string
+ UserGroupName:
+ description: The name of the group you want to unlink the policy from.
+ type: string
+ required:
+ - PolicyOrn
+ - UserGroupName
+ type: object
+ UnlinkManagedPolicyFromUserGroupResponse:
+ additionalProperties: false
+ properties:
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ type: object
UnlinkNicRequest:
additionalProperties: false
properties:
@@ -9551,6 +10335,7 @@ components:
PolicyOrn:
description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
type: string
UserName:
description: The name of the user you want to detach the policy from.
@@ -9838,7 +10623,7 @@ components:
perform the action.
type: boolean
IpRanges:
- description: One or more IP addresses or CIDR blocks (for example, `192.0.2.0/16`).
+ description: One or more IPs or CIDR blocks (for example, `192.0.2.0/16`).
items:
type: string
type: array
@@ -9957,6 +10742,9 @@ components:
UpdateImageRequest:
additionalProperties: false
properties:
+ Description:
+ description: A new description for the image.
+ type: string
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
@@ -9968,7 +10756,6 @@ components:
"$ref": "#/components/schemas/PermissionsOnResourceCreation"
required:
- ImageId
- - PermissionsToLaunch
type: object
UpdateImageResponse:
additionalProperties: false
@@ -10055,8 +10842,8 @@ components:
type: string
type: array
ServerCertificateId:
- description: The Outscale Resource Name (ORN) of the server certificate.
- For more information, see [Resource Identifiers > Outscale Resource Names
+ description: The OUTSCALE Resource Name (ORN) of the server certificate.
+ For more information, see [Resource Identifiers > OUTSCALE Resource Names
(ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns).
If this parameter is specified, you must also specify the `LoadBalancerPort`
parameter.
@@ -10339,6 +11126,43 @@ components:
Subnet:
"$ref": "#/components/schemas/Subnet"
type: object
+ UpdateUserGroupRequest:
+ additionalProperties: false
+ properties:
+ DryRun:
+ description: If true, checks whether you have the required permissions to
+ perform the action.
+ type: boolean
+ NewPath:
+ description: A new path for the group. If not specified, it is set to a
+ slash (`/`).
+ type: string
+ NewUserGroupName:
+ description: A new name for the user group.
+ type: string
+ Path:
+ description: The path to the group. If not specified, it is set to a slash
+ (`/`).
+ type: string
+ UserGroupName:
+ description: The name of the group you want to update.
+ type: string
+ required:
+ - UserGroupName
+ type: object
+ UpdateUserGroupResponse:
+ additionalProperties: false
+ properties:
+ ResponseContext:
+ "$ref": "#/components/schemas/ResponseContext"
+ UserGroup:
+ "$ref": "#/components/schemas/UserGroup"
+ Users:
+ description: A list of EIM users.
+ items:
+ "$ref": "#/components/schemas/User"
+ type: array
+ type: object
UpdateUserRequest:
additionalProperties: false
properties:
@@ -10559,7 +11383,7 @@ components:
description: The ID of the VPN connection you want to modify.
type: string
VpnOptions:
- "$ref": "#/components/schemas/VpnOptionsToUpdate"
+ "$ref": "#/components/schemas/VpnOptions"
required:
- VpnConnectionId
type: object
@@ -10575,16 +11399,52 @@ components:
additionalProperties: false
description: Information about the EIM user.
properties:
+ CreationDate:
+ description: The date and time (UTC) of creation of the EIM user.
+ format: date-time
+ type: string
+ LastModificationDate:
+ description: The date and time (UTC) of the last modification of the EIM
+ user.
+ format: date-time
+ type: string
Path:
description: The path to the EIM user.
type: string
UserId:
- description: " The ID of the EIM user."
+ description: The ID of the EIM user.
type: string
UserName:
description: The name of the EIM user.
type: string
type: object
+ UserGroup:
+ additionalProperties: false
+ description: Information about the user group.
+ properties:
+ CreationDate:
+ description: The date and time (UTC) of creation of the user group.
+ format: date-time
+ type: string
+ LastModificationDate:
+ description: The date and time (UTC) of the last modification of the user
+ group.
+ format: date-time
+ type: string
+ Name:
+ description: The name of the user group.
+ type: string
+ Orn:
+ description: The Outscale Resource Name (ORN) of the user group. For more
+ information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ type: string
+ Path:
+ description: The path to the user group.
+ type: string
+ UserGroupId:
+ description: The ID of the user group.
+ type: string
+ type: object
VgwTelemetry:
additionalProperties: false
description: Information about the current state of a VPN tunnel.
@@ -10653,7 +11513,7 @@ components:
description: The idempotency token provided when launching the VM.
type: string
CreationDate:
- description: The date and time of creation of the VM.
+ description: The date and time (UTC) of creation of the VM.
format: datetime
type: string
DeletionProtection:
@@ -10766,7 +11626,7 @@ components:
description: Information about the VM group.
properties:
CreationDate:
- description: The date and time of creation of the VM group.
+ description: The date and time (UTC) of creation of the VM group.
format: datetime
type: string
Description:
@@ -10789,8 +11649,6 @@ components:
type: string
type: array
State:
- description: The state of the VM group (`pending` \| `available` \| `scaling
- up` \| `scaling down` \| `deleting` \| `deleted`).
enum:
- available
- deleted
@@ -10803,7 +11661,7 @@ components:
description: The ID of the Subnet for the VM group.
type: string
Tags:
- description: One or more tags associated with the VM group.
+ description: One or more tags associated with the VM.
items:
"$ref": "#/components/schemas/ResourceTag"
type: array
@@ -10863,7 +11721,6 @@ components:
type: object
VmTemplate:
additionalProperties: false
- description: Information about the VM template.
properties:
CpuCores:
description: The number of vCores.
@@ -10879,7 +11736,7 @@ components:
- highest
type: string
CreationDate:
- description: The date and time of creation of the VM template.
+ description: The date and time (UTC) of creation of the VM template.
format: date-time
type: string
Description:
@@ -10956,7 +11813,7 @@ components:
description: Information about the volume.
properties:
CreationDate:
- description: The date and time of creation of the volume.
+ description: The date and time (UTC) of creation of the volume.
format: datetime
type: string
Iops:
@@ -11059,17 +11916,6 @@ components:
CIDR block from the 169.254.254.0/24 range.
type: string
type: object
- VpnOptionsToUpdate:
- additionalProperties: false
- description: Information about the VPN options.
- properties:
- Phase2Options:
- "$ref": "#/components/schemas/Phase2OptionsToUpdate"
- TunnelInsideIpRange:
- description: The range of inside IPs for the tunnel. This must be a /30
- CIDR block from the 169.254.254.0/24 range.
- type: string
- type: object
With:
additionalProperties: false
description: The information to display in each returned log.
@@ -11178,9 +12024,8 @@ info:
To protect against overloads, the number of identical requests allowed in a given
time period is limited.
\nBrute force: To protect against brute force attacks,
the number of failed authentication attempts in a given time period is limited.
\nYou can learn more about errors returned by the API in the dedicated
- [errors page](api/errors).
\nNote that the OUTSCALE Cloud is compatible
- with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html)
+ />
\nNote that the OUTSCALE Cloud is compatible with Amazon Web Services
+ (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html)
between AWS and the OUTSCALE API.
\nYou can also manage your resources using
the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.
\nAn OpenAPI description of the OUTSCALE API is also available in this
@@ -11197,29 +12042,37 @@ info:
more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html).\n\nSee
the code samples in each section of this documentation for specific examples in
different programming languages.
\nFor more information about access keys,
- see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html).\n###
- Login/Password\nFor certain API actions, you can also use basic authentication
- with the login (email address) and password of your TINA account.
\nThis
- is useful only in special circumstances, for example if you do not know your access
- key/secret key and want to retrieve them programmatically.
\nIn most cases,
- however, you can use the Cockpit web interface to retrieve them.
\n\n> For
- example, if you use OSC CLI:\n> 1. You need to create an **~/.osc/config.json**
- file to specify the Region of your account, but you leave the access key value
- and secret key value empty (`""`).\n> 2. You then specify the `--profile`,
- `--authentication-method`, `--login`, and `--password` options when executing
- OSC CLI commands.\n\nSee the code samples in each section of this documentation
- for specific examples in different programming languages.\n### No Authentication\nA
- few API actions do not require any authentication. They are indicated as such
- in this documentation.
\n### Other Security Mechanisms\nIn parallel with
- the authentication schemes, you can add other security mechanisms to your OUTSCALE
- account, for example to restrict API requests by IP or other criteria.
\nFor
- more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html)."
+ see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html).\n\n>
+ If you try to sign requests with an invalid access key four times in a row, further
+ authentication attempts will be prevented for 1 minute. This lockout time increases
+ 1 minute every four failed attempts, for up to 10 minutes.\n\n### Login/Password\nFor
+ certain API actions, you can also use basic authentication with the login (email
+ address) and password of your TINA account.
\nThis is useful only in special
+ circumstances, for example if you do not know your access key/secret key and want
+ to retrieve them programmatically.
\nIn most cases, however, you can use
+ the Cockpit web interface to retrieve them.
\n\n> For example, if you use
+ OSC CLI:\n> 1. You need to create an **~/.osc/config.json** file to specify the
+ Region of your account, but you leave the access key value and secret key value
+ empty (`""`).\n> 2. You then specify the `--profile`, `--authentication-method`,
+ `--login`, and `--password` options when executing OSC CLI commands.\n\nSee the
+ code samples in each section of this documentation for specific examples in different
+ programming languages.\n\n> If you try to sign requests with an invalid password
+ four times in a row, further authentication attempts will be prevented for 1 minute.
+ This lockout time increases 1 minute every four failed attempts, for up to 10
+ minutes.\n\n### No Authentication\nA few API actions do not require any authentication.
+ They are indicated as such in this documentation.
\n### Other Security Mechanisms\nIn
+ parallel with the authentication schemes, you can add other security mechanisms
+ to your OUTSCALE account, for example to restrict API requests by IP or other
+ criteria.
\nFor more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html).
\n# Error Codes Reference\nYou can learn more about errors returned by the API
+ in the dedicated [errors page](api-errors.html)."
license:
name: BSD 3 Clause
url: https://opensource.org/licenses/BSD-3-Clause
termsOfService: https://en.outscale.com/terms-of-service/
title: 3DS OUTSCALE API
- version: 1.28.7
+ version: 1.29.3
+ x-osc-api-type: external
openapi: 3.0.0
paths:
"/AcceptNetPeering":
@@ -11293,6 +12146,36 @@ paths:
description: The HTTP 500 response (Internal Server Error).
tags:
- NetPeering
+ "/AddUserToUserGroup":
+ description: Adds a user to a specified group.
+ post:
+ operationId: AddUserToUserGroup
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/AddUserToUserGroupRequest"
+ examples:
+ ex1:
+ value:
+ UserGroupName: example-usergroup
+ UserGroupPath: "/example/"
+ UserName: example-user
+ UserPath: "/example/"
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/AddUserToUserGroupResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ description: The HTTP 200 response (OK).
+ tags:
+ - UserGroup
"/CheckAuthentication":
description: Validates the authenticity of the account.
post:
@@ -12005,7 +12888,7 @@ paths:
- Image
"/CreateImageExportTask":
description: |-
- Exports an Outscale machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
+ Exports an OUTSCALE machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
This action enables you to copy an OMI between accounts in different Regions. To copy an OMI in the same Region, you can also use the [CreateImage](#createimage) method.
The copy of the OMI belongs to you and is independent from the source OMI.
@@ -12519,7 +13402,7 @@ paths:
description: |-
Creates a stickiness policy with sticky session lifetimes defined by the browser lifetime.
The created policy can be used with HTTP or HTTPS listeners only.
- If this policy is implemented by a load balancer, this load balancer uses this cookie in all incoming requests to direct them to the specified back-end server virtual machine (VM). If this cookie is not present, the load balancer sends the request to any other server according to its load-balancing algorithm.
+ If this policy is implemented by a load balancer, this load balancer uses this cookie in all incoming requests to direct them to the specified backend server virtual machine (VM). If this cookie is not present, the load balancer sends the request to any other server according to its load-balancing algorithm.
You can also create a stickiness policy with sticky session lifetimes following the lifetime of an application-generated cookie.
Unlike the other type of stickiness policy, the lifetime of the special Load Balancer Unit (LBU) cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer inserts a new stickiness cookie only when the application response includes a new application cookie.
@@ -13510,7 +14393,7 @@ paths:
description: |-
Creates a server certificate and its matching private key.
These elements can be used with other services (for example, to configure SSL termination on load balancers).
- You can also specify the chain of intermediate certification authorities if your certificate is not directly signed by a root one. You can specify multiple intermediate certification authorities in the `CertificateChain` parameter. To do so, concatenate all certificates in the correct order (the first certificate must be the authority of your certificate, the second must the the authority of the first one, and so on).
+ You can also specify the chain of intermediate certification authorities if your certificate is not directly signed by a root one. You can specify multiple intermediate certification authorities in the `CertificateChain` parameter. To do so, concatenate all certificates in the correct order (the first certificate must be the authority of your certificate, the second must be the authority of the first one, and so on).
The private key must be a RSA key in PKCS1 form. To check this, open the PEM file and ensure its header reads as follows: BEGIN RSA PRIVATE KEY.
[IMPORTANT]
This private key must not be protected by a password or a passphrase.
@@ -13557,6 +14440,9 @@ paths:
* **Copying a snapshot**: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
* **Importing from a bucket**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to the bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
+ **[NOTE]**
+ In case of excessive use of the snapshot creation feature on the same volume over a short period of time, 3DS OUTSCALE reserves the right to temporarily block the feature.
+
For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html).
post:
operationId: CreateSnapshot
@@ -13884,6 +14770,43 @@ paths:
description: The HTTP 200 response (OK).
tags:
- User
+ "/CreateUserGroup":
+ description: |-
+ Creates a group to which you can add users.
+ You can also add an inline policy or link a managed policy to the group, which is applied to all its users.
+ post:
+ operationId: CreateUserGroup
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/CreateUserGroupRequest"
+ examples:
+ ex1:
+ value:
+ Path: "/example/"
+ UserGroupName: example-usergroup
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/CreateUserGroupResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ UserGroup:
+ CreationDate: '2010-10-01T12:34:56.789Z'
+ LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00
+ Name: example-usergroup
+ Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example
+ Path: "/example/"
+ UserGroupId: ug-12345678
+ description: The HTTP 200 response (OK).
+ tags:
+ - UserGroup
"/CreateVirtualGateway":
description: |-
Creates a virtual gateway.
@@ -14033,18 +14956,19 @@ paths:
examples:
ex1:
value:
- VmTemplateName: vmtemplate-example
- CpuPerformance: high
- CreationDate: 2010-10-01 12:34:56.789000000 +00:00
- CpuCores: 2
- Tags:
- - Key: key1
- Value: value1
- Description: Log collector template
- ImageId: ami-12345678
- CpuGeneration: v4
- VmTemplateId: vmtemplate-98765432109876543210987654321012
- Ram: 2
+ VmTemplate:
+ VmTemplateName: vmtemplate-example
+ CpuPerformance: high
+ CreationDate: 2010-10-01 12:34:56.789000000 +00:00
+ CpuCores: 2
+ Tags:
+ - Key: key1
+ Value: value1
+ Description: Log collector template
+ ImageId: ami-12345678
+ CpuGeneration: v4
+ VmTemplateId: vmtemplate-98765432109876543210987654321012
+ Ram: 2
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
description: The HTTP 200 response (OK).
@@ -16032,7 +16956,7 @@ paths:
- Tag
"/DeleteUser":
description: Deletes a specified EIM user. The EIM user must not belong to any
- group, nor have any key or attached policy.
+ group, nor have any key or linked policy.
post:
operationId: DeleteUser
requestBody:
@@ -16058,6 +16982,69 @@ paths:
description: The HTTP 200 response (OK).
tags:
- User
+ "/DeleteUserGroup":
+ description: |-
+ Deletes a specified user group.
+
+ **[WARNING]**
+ The user group must be empty of any user and must not have any linked policy. Otherwise, you need to force the deletion.
+ If you force the deletion, all inline policies will be deleted with the user group.
+ post:
+ operationId: DeleteUserGroup
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/DeleteUserGroupRequest"
+ examples:
+ ex1:
+ value:
+ Force: false
+ Path: "/example/"
+ UserGroupName: example-usergroup
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/DeleteUserGroupResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ description: The HTTP 200 response (OK).
+ tags:
+ - UserGroup
+ "/DeleteUserGroupPolicy":
+ description: Deletes a specified inline policy from a specific group.
+ post:
+ operationId: DeleteUserGroupPolicy
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest"
+ examples:
+ ex1:
+ value:
+ PolicyName: example-usergroup-policy
+ UserGroupName: example-usergroup
+ UserGroupPath: "/example/"
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ description: The HTTP 200 response (OK).
+ tags:
+ - Policy
"/DeleteVirtualGateway":
description: |-
Deletes a specified virtual gateway.
@@ -16358,7 +17345,10 @@ paths:
"/LinkFlexibleGpu":
description: |-
Attaches one of your allocated flexible GPUs (fGPUs) to one of your virtual machines (VMs).
- The fGPU is in the `attaching` state until the VM is stopped, after which it becomes `attached`.
+ The fGPU is in the `attaching` state until the VM is stopped, after which it becomes `attached`.
+
+ **[NOTE]**
+ You can attach fGPUs only to VMs with the `highest` (1) performance flag. For more information see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html) and [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html).
post:
operationId: LinkFlexibleGpu
requestBody:
@@ -16436,7 +17426,7 @@ paths:
"/LinkLoadBalancerBackendMachines":
description: |-
Attaches one or more virtual machines (VMs) to a specified load balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` parameter.
- The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a back-end VM.
+ The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM.
post:
operationId: LinkLoadBalancerBackendMachines
requestBody:
@@ -16479,6 +17469,35 @@ paths:
description: The HTTP 200 response (OK).
tags:
- LoadBalancer
+ "/LinkManagedPolicyToUserGroup":
+ description: Links a managed policy to a specific group. This policy applies to
+ all the users contained in this group.
+ post:
+ operationId: LinkManagedPolicyToUserGroup
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest"
+ examples:
+ ex1:
+ value:
+ PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy
+ UserGroupName: example-usergroup
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ description: The HTTP 200 response (OK).
+ tags:
+ - Policy
"/LinkNic":
description: |-
Attaches a network interface card (NIC) to a virtual machine (VM).
@@ -16812,10 +17831,43 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
- description: The HTTP 500 response (Internal Server Error).
+ "$ref": "#/components/schemas/ErrorResponse"
+ description: The HTTP 500 response (Internal Server Error).
+ tags:
+ - Volume
+ "/PutUserGroupPolicy":
+ description: |-
+ Creates or updates an inline policy included in a specified group.
+ The policy is automatically applied to all the users of the group after its creation.
+ post:
+ operationId: PutUserGroupPolicy
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/PutUserGroupPolicyRequest"
+ examples:
+ ex1:
+ value:
+ PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": ["*"],
+ "Resource": ["*"]} ]}'
+ PolicyName: example-usergroup-policy
+ UserGroupName: example-usergroup
+ UserGroupPath: "/example/"
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/PutUserGroupPolicyResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ description: The HTTP 200 response (OK).
tags:
- - Volume
+ - Policy
"/ReadAccessKeys":
description: Lists the access key IDs of either your root account or an EIM user.
post:
@@ -17047,7 +18099,7 @@ paths:
**[IMPORTANT]**
Past logs are accessible for up to 32 days.
By default, the retrieved interval is 48 hours. If neither of the `QueryDateBefore` nor `QueryDateAfter` parameters are specified, logs from the past 48 hours are retrieved. If you only specify one of two, logs are retrieved from a 2-day interval based on the date you provided. To retrieve logs beyond a 2-day interval, specify both parameters.
- For more information, see [About OUTSCALE Monitoring Services (OMS)](https://docs.outscale.com/en/userguide/About-OUTSCALE-Monitoring-Services-OMS.html).
+ For more information, see [About OMS](https://docs.outscale.com/en/userguide/About-OMS.html).
post:
operationId: ReadApiLogs
requestBody:
@@ -17338,18 +18390,21 @@ paths:
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
ConsumptionEntries:
- - FromDate: 2023-06-01 00:00:00.000000000 +00:00
+ - UnitPrice: 0.044
+ Type: BoxUsage:tinav4.c1r1p2
+ Operation: RunInstances-OD
SubregionName: eu-west-2a
- Value: 720.0
- Title: Instance - On demand - tinav4.c2r4 high performance -
+ Value: 1392
+ Title: Instance - On demand - tinav4.c1r1 high performance -
par heure
Category: compute
ToDate: 2023-06-30 00:00:00.000000000 +00:00
Service: TinaOS-FCU
AccountId: '123456789012'
PayingAccountId: '123456789012'
- Operation: RunInstances-OD
- Type: BoxUsage:tinav4.c2r4p2
+ FromDate: 2023-06-01 00:00:00.000000000 +00:00
+ Price: 61.248
+ Currency: EUR
description: The HTTP 200 response (OK).
tags:
- Account
@@ -18136,6 +19191,48 @@ paths:
security: []
tags:
- Location
+ "/ReadManagedPoliciesLinkedToUserGroup":
+ description: Lists the managed policies linked to a specified group.
+ post:
+ operationId: ReadManagedPoliciesLinkedToUserGroup
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest"
+ examples:
+ ex1:
+ value:
+ Filters:
+ PathPrefix: "/ex"
+ UserGroupIds:
+ - ug-12345678
+ FirstItem: 1
+ ResultsPerPage: 30
+ UserGroupName: example-usergroup
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ HasMoreItems: true
+ MaxResultsLimit: 30
+ MaxResultsTruncated: true
+ Policies:
+ - CreationDate: '2010-10-01T12:34:56.789Z'
+ LastModificationDate: '2010-10-01T12:34:56.789Z'
+ Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy
+ PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234
+ PolicyName: example-policy
+ description: The HTTP 200 response (OK).
+ tags:
+ - Policy
"/ReadNatServices":
description: Lists one or more network address translation (NAT) services.
post:
@@ -19472,6 +20569,197 @@ paths:
description: The HTTP 500 response (Internal Server Error).
tags:
- Tag
+ "/ReadUserGroup":
+ description: Lists information about a specified user group, including its users.
+ post:
+ operationId: ReadUserGroup
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/ReadUserGroupRequest"
+ examples:
+ ex1:
+ value:
+ Path: "/example/"
+ UserGroupName: example-usergroup
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/ReadUserGroupResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ UserGroup:
+ CreationDate: '2010-10-01T12:34:56.789Z'
+ LastModificationDate: '2010-10-01T12:34:56.789Z'
+ Name: example-usergroup
+ Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example
+ Path: "/example/"
+ UserGroupId: ug-12345678
+ Users:
+ - CreationDate: '2010-10-01T12:34:56.789Z'
+ LastModificationDate: '2010-10-01T12:34:56.789Z'
+ Path: "/example/"
+ UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345
+ UserName: example-user
+ description: The HTTP 200 response (OK).
+ tags:
+ - UserGroup
+ "/ReadUserGroupPolicies":
+ description: Lists the names of the inline policies embedded in a specific group.
+ post:
+ operationId: ReadUserGroupPolicies
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/ReadUserGroupPoliciesRequest"
+ examples:
+ ex1:
+ value:
+ FirstItem: 1
+ ResultsPerPage: 30
+ UserGroupName: example-usergroup
+ UserGroupPath: "/example/"
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/ReadUserGroupPoliciesResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ HasMoreItems: true
+ MaxResultsLimit: 30
+ MaxResultsTruncated: true
+ Policies:
+ - Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"],
+ "Resource": ["*"]} ]}'
+ Name: example-policy
+ description: The HTTP 200 response (OK).
+ tags:
+ - Policy
+ "/ReadUserGroupPolicy":
+ description: Returns information about an inline policy included in a specified
+ group.
+ post:
+ operationId: ReadUserGroupPolicy
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/ReadUserGroupPolicyRequest"
+ examples:
+ ex1:
+ value:
+ PolicyName: example-policy
+ UserGroupName: example-usergroup
+ UserGroupPath: "/example/"
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/ReadUserGroupPolicyResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ Policy:
+ Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"],
+ "Resource": ["*"]} ]}'
+ Name: example-policy
+ description: The HTTP 200 response (OK).
+ tags:
+ - Policy
+ "/ReadUserGroups":
+ description: |-
+ Lists the groups with the specified path prefix.
+ If you do not specify any path prefix, this action returns all the groups (or an empty list if there are none).
+ post:
+ operationId: ReadUserGroups
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/ReadUserGroupsRequest"
+ examples:
+ ex1:
+ value:
+ Filters:
+ PathPrefix: "/ex"
+ UserGroupIds:
+ - ug-12345678
+ FirstItem: 1
+ ResultsPerPage: 30
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/ReadUserGroupsResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ HasMoreItems: true
+ MaxResultsLimit: 30
+ MaxResultsTruncated: true
+ UserGroups:
+ - CreationDate: '2010-10-01T12:34:56.789Z'
+ LastModificationDate: '2010-10-01T12:34:56.789Z'
+ Name: example-usergroup
+ Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example
+ Path: "/example/"
+ UserGroupId: ug-12345678
+ description: The HTTP 200 response (OK).
+ tags:
+ - UserGroup
+ "/ReadUserGroupsPerUser":
+ description: Lists the groups a specified user belongs to.
+ post:
+ operationId: ReadUserGroupsPerUser
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/ReadUserGroupsPerUserRequest"
+ examples:
+ ex1:
+ value:
+ UserName: example-user
+ UserPath: "/example/"
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/ReadUserGroupsPerUserResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ UserGroups:
+ - CreationDate: '2010-10-01T12:34:56.789Z'
+ LastModificationDate: '2010-10-01T12:34:56.789Z'
+ Name: example-usergroup
+ Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example
+ Path: "/example/"
+ UserGroupId: ug-12345678
+ description: The HTTP 200 response (OK).
+ tags:
+ - UserGroup
"/ReadUsers":
description: |-
Lists all EIM users that have a specified path.
@@ -19590,8 +20878,10 @@ paths:
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
VmGroups:
- SecurityGroupsIds: sg-87654321
- VmIds: i-12345678
+ - SecurityGroupIds:
+ - sg-87654321
+ VmIds:
+ - i-12345678
CreationDate: 2010-10-01 12:34:56.789000000 +00:00
VmCount: 1
VmGroupName: ClusterLog-PPD01
@@ -19647,7 +20937,7 @@ paths:
Filters:
CpuCores:
- 2
- CpuGeneration:
+ CpuGenerations:
- v4
responses:
'200':
@@ -19659,7 +20949,7 @@ paths:
ex1:
value:
VmTemplates:
- VmTemplateName: vmtemplate-example
+ - VmTemplateName: vmtemplate-example
CpuPerformance: high
CreationDate: 2010-10-01 12:34:56.789000000 +00:00
CpuCores: 2
@@ -19669,6 +20959,8 @@ paths:
CpuGeneration: v4
VmTemplateId: vmtemplate-98765432109876543210987654321012
Ram: 2
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
description: The HTTP 200 response (OK).
tags:
- VmTemplate
@@ -19701,7 +20993,7 @@ paths:
VmTypeName: t2.small
BsuOptimized: false
MaxPrivateIps: 4
- MemorySize: 2.0
+ MemorySize: 2
VcoreCount: 1
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
@@ -19832,7 +21124,7 @@ paths:
tags:
- Vm
"/ReadVmsHealth":
- description: Lists the state of one or more back-end virtual machines (VMs) registered
+ description: Lists the state of one or more backend virtual machines (VMs) registered
with a specified load balancer.
post:
operationId: ReadVmsHealth
@@ -20110,7 +21402,7 @@ paths:
"/RegisterVmsInLoadBalancer":
description: |-
Registers one or more virtual machines (VMs) with a specified load balancer.
- The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a back-end VM.
+ The VMs can be in different Subnets and different Subregions than the load balancer, as long as the VMs and load balancers are all in the public Cloud or all in the same Net. It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a backend VM.
post:
operationId: RegisterVmsInLoadBalancer
requestBody:
@@ -20192,6 +21484,36 @@ paths:
description: The HTTP 500 response (Internal Server Error).
tags:
- NetPeering
+ "/RemoveUserFromUserGroup":
+ description: Removes a specified user from a specified group.
+ post:
+ operationId: RemoveUserFromUserGroup
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/RemoveUserFromUserGroupRequest"
+ examples:
+ ex1:
+ value:
+ UserGroupName: example-usergroup
+ UserGroupPath: "/example/"
+ UserName: example-user
+ UserPath: "/example/"
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/RemoveUserFromUserGroupResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ description: The HTTP 200 response (OK).
+ tags:
+ - UserGroup
"/ScaleDownVmGroup":
description: |-
> [WARNING]
@@ -20433,7 +21755,7 @@ paths:
"/UnlinkFlexibleGpu":
description: |-
Detaches a flexible GPU (fGPU) from a virtual machine (VM).
- The fGPU is in the `detaching` state until the VM is stopped, after which it becomes available for allocation again.
+ The fGPU is in the `detaching` state until the VM is stopped, after which it becomes `allocated`. It is then available again for attachment to a VM.
post:
operationId: UnlinkFlexibleGpu
requestBody:
@@ -20508,9 +21830,8 @@ paths:
tags:
- InternetService
"/UnlinkLoadBalancerBackendMachines":
- description: Detaches one or more back-end virtual machines (VMs) from a load
- balancer. You need to specify at least the `BackendIps` or the `BackendVmIds`
- parameter.
+ description: Detaches one or more backend virtual machines (VMs) from a load balancer.
+ You need to specify at least the `BackendIps` or the `BackendVmIds` parameter.
post:
operationId: UnlinkLoadBalancerBackendMachines
requestBody:
@@ -20553,6 +21874,34 @@ paths:
description: The HTTP 200 response (OK).
tags:
- LoadBalancer
+ "/UnlinkManagedPolicyFromUserGroup":
+ description: Unlinks a managed policy from a specific group.
+ post:
+ operationId: UnlinkManagedPolicyFromUserGroup
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupRequest"
+ examples:
+ ex1:
+ value:
+ PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy
+ UserGroupName: example-usergroup
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/UnlinkManagedPolicyFromUserGroupResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ description: The HTTP 200 response (OK).
+ tags:
+ - Policy
"/UnlinkNic":
description: |-
Detaches a network interface card (NIC) from a virtual machine (VM).
@@ -21290,6 +22639,7 @@ paths:
summary: Making an image private to everyone
value:
ImageId: ami-12345678
+ Description: Private image
PermissionsToLaunch:
Removals:
GlobalPermission: true
@@ -21411,7 +22761,7 @@ paths:
AccountIds: []
AccountId: '123456789012'
Tags: []
- Description: ''
+ Description: Private image
ImageId: ami-12345678
BlockDeviceMappings:
- DeviceName: "/dev/sda1"
@@ -22413,6 +23763,49 @@ paths:
description: The HTTP 200 response (OK).
tags:
- User
+ "/UpdateUserGroup":
+ description: Modifies the name and/or the path of a specified group.
+ post:
+ operationId: UpdateUserGroup
+ requestBody:
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/UpdateUserGroupRequest"
+ examples:
+ ex1:
+ value:
+ NewPath: "/new-path/"
+ NewUserGroupName: new-usergroup
+ Path: "/example/"
+ UserGroupName: example-usergroup
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/UpdateUserGroupResponse"
+ examples:
+ ex1:
+ value:
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ UserGroup:
+ CreationDate: '2010-10-01T12:34:56.789Z'
+ LastModificationDate: '2010-10-01T12:34:56.789Z'
+ Name: new-usergroup
+ Orn: orn:ows:idauth::012345678910:usergroup/example/usergroup-example
+ Path: "/new-path/"
+ UserGroupId: ug-12345678
+ Users:
+ - CreationDate: '2010-10-01T12:34:56.789Z'
+ LastModificationDate: '2010-10-01T12:34:56.789Z'
+ Path: "/example/"
+ UserId: ABCDEFGHIJKLMNOPQRSTUVWXYZ12345
+ UserName: example-user
+ description: The HTTP 200 response (OK).
+ tags:
+ - UserGroup
"/UpdateVm":
description: |-
Modifies the specified attributes of a virtual machine (VM).
@@ -22651,8 +24044,8 @@ paths:
VmGroupId: vmgroup-12345678901234567890123456789012
Description: New description of the VM group
Tags: []
- ResponseContext:
- RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
+ ResponseContext:
+ RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
description: The HTTP 200 response (OK).
'400':
content:
@@ -22702,16 +24095,17 @@ paths:
examples:
ex1:
value:
- VmTemplateName: second-name
- CpuPerformance: high
- CreationDate: 2010-10-01 12:34:56.789000000 +00:00
- CpuCores: 2
- Tags: []
- Description: The new description of the VM template
- ImageId: ami-12345678
- CpuGeneration: v4
- VmTemplateId: vmtemplate-98765432109876543210987654321012
- Ram: 2
+ VmTemplate:
+ VmTemplateName: second-name
+ CpuPerformance: high
+ CreationDate: 2010-10-01 12:34:56.789000000 +00:00
+ CpuCores: 2
+ Tags: []
+ Description: The new description of the VM template
+ ImageId: ami-12345678
+ CpuGeneration: v4
+ VmTemplateId: vmtemplate-98765432109876543210987654321012
+ Ram: 2
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
description: The HTTP 200 response (OK).
diff --git a/outscale-java.yaml b/outscale-java.yaml
index 19016e6..cc5e972 100644
--- a/outscale-java.yaml
+++ b/outscale-java.yaml
@@ -45,16 +45,15 @@ components:
description: The ID of the access key.
type: string
CreationDate:
- description: The date and time (UTC) of creation of the access key.
+ description: The date and time (UTC) at which the access key was created.
format: date-time
type: string
ExpirationDate:
- description: The date (UTC) at which the access key expires.
+ description: The date and time (UTC) at which the access key expires.
format: date-time
type: string
LastModificationDate:
- description: The date and time (UTC) of the last modification of the access
- key.
+ description: The date and time (UTC) at which the access key was last modified.
format: date-time
type: string
State:
@@ -70,7 +69,7 @@ components:
description: The ID of the access key.
type: string
CreationDate:
- description: The date and time (UTC) of creation of the access key.
+ description: The date and time (UTC) at which the access key was created.
format: date-time
type: string
ExpirationDate:
@@ -78,12 +77,11 @@ components:
format: date-time
type: string
LastModificationDate:
- description: The date and time (UTC) of the last modification of the access
- key.
+ description: The date and time (UTC) at which the access key was last modified.
format: date-time
type: string
SecretKey:
- description: The access key that enables you to send requests.
+ description: The secret key that enables you to send requests.
type: string
State:
description: The state of the access key (`ACTIVE` if the key is valid for
@@ -349,8 +347,8 @@ components:
false, the volume is not deleted when terminating the VM.
type: boolean
LinkDate:
- description: The date and time (UTC) of attachment of the volume to the
- VM, in ISO 8601 date-time format.
+ description: The date and time (UTC) at which the volume was attached to
+ the VM, in ISO 8601 date-time format.
format: date-time
type: string
State:
@@ -520,7 +518,7 @@ components:
type: string
ConnectionType:
description: The type of communication tunnel used by the client gateway
- (only `ipsec.1` is supported).
+ (always `ipsec.1`).
type: string
PublicIp:
description: The public IPv4 address of the client gateway (must be a fixed
@@ -765,7 +763,7 @@ components:
type: integer
ConnectionType:
description: The communication protocol used to establish tunnel with your
- client gateway (only `ipsec.1` is supported).
+ client gateway (always `ipsec.1`).
type: string
DryRun:
description: If true, checks whether you have the required permissions to
@@ -1160,8 +1158,8 @@ components:
a policy.
type: string
PolicyName:
- description: The name of the policy. This name must be unique and consist
- of alphanumeric characters and dashes (-).
+ description: The unique name of the policy, with a maximum length of 32
+ alphanumeric characters and dashes (-).
type: string
PolicyType:
description: 'The type of stickiness policy you want to create: `app` or
@@ -1193,8 +1191,9 @@ components:
"$ref": "#/components/schemas/ListenerForCreation"
type: array
LoadBalancerName:
- description: The unique name of the load balancer (32 alphanumeric or hyphen
- characters maximum, but cannot start or end with a hyphen).
+ description: The unique name of the load balancer, with a maximum length
+ of 32 alphanumeric characters and dashes (-). This name must not start
+ or end with a dash.
type: string
LoadBalancerType:
description: 'The type of load balancer: `internet-facing` or `internal`.
@@ -1429,7 +1428,8 @@ components:
type: string
Document:
description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
+ and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
DryRun:
description: If true, checks whether you have the required permissions to
@@ -1458,7 +1458,8 @@ components:
properties:
Document:
description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
+ and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
PolicyOrn:
description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
@@ -1910,7 +1911,7 @@ components:
properties:
ConnectionType:
description: The type of VPN connection supported by the virtual gateway
- (only `ipsec.1` is supported).
+ (always `ipsec.1`).
type: string
DryRun:
description: If true, checks whether you have the required permissions to
@@ -2208,7 +2209,7 @@ components:
description: The ID of the client gateway.
type: string
ConnectionType:
- description: The type of VPN connection (only `ipsec.1` is supported).
+ description: The type of VPN connection (always `ipsec.1`).
type: string
DryRun:
description: If true, checks whether you have the required permissions to
@@ -3609,7 +3610,7 @@ components:
type: array
ConnectionTypes:
description: The types of communication tunnels used by the client gateways
- (only `ipsec.1` is supported).
+ (always `ipsec.1`).
items:
type: string
type: array
@@ -4903,7 +4904,7 @@ components:
description: One or more filters.
properties:
ConnectionTypes:
- description: The types of the virtual gateways (only `ipsec.1` is supported).
+ description: The types of the virtual gateways (always `ipsec.1`).
items:
type: string
type: array
@@ -5348,6 +5349,7 @@ components:
type: object
FiltersVmTemplate:
additionalProperties: false
+ description: One or more filters.
properties:
CpuCores:
description: The number of vCores.
@@ -5509,8 +5511,8 @@ components:
description: One or more filters.
properties:
CreationDates:
- description: The dates and times of creation of the volumes, in ISO 8601
- date-time format (for example, `2020-06-30T00:00:00.000Z`).
+ description: The dates and times at which the volumes were created, in ISO
+ 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`).
items:
format: date-time
type: string
@@ -5525,8 +5527,8 @@ components:
type: string
type: array
LinkVolumeLinkDates:
- description: The dates and times of creation of the volumes, in ISO 8601
- date-time format (for example, `2020-06-30T00:00:00.000Z`).
+ description: The dates and times at which the volumes were attached, in
+ ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`).
items:
format: date-time
type: string
@@ -5606,7 +5608,7 @@ components:
type: string
type: array
ConnectionTypes:
- description: The types of the VPN connections (only `ipsec.1` is supported).
+ description: The types of the VPN connections (always `ipsec.1`).
items:
type: string
type: array
@@ -5688,7 +5690,7 @@ components:
the public catalog.
properties:
Generations:
- description: The generations of VMs that the fGPU is compatible with.
+ description: The processor generations that the fGPUs are compatible with.
items:
type: string
type: array
@@ -5764,7 +5766,7 @@ components:
"$ref": "#/components/schemas/BlockDeviceMappingImage"
type: array
CreationDate:
- description: The date and time (UTC) of creation of the OMI.
+ description: The date and time (UTC) at which the OMI was created.
format: date-time
type: string
Description:
@@ -5840,7 +5842,8 @@ components:
properties:
Body:
description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
+ and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
Name:
description: The name of the policy.
@@ -6342,7 +6345,7 @@ components:
description: Information about the linked policy.
properties:
CreationDate:
- description: The date and time (UTC) of creation of the linked policy.
+ description: The date and time (UTC) at which the linked policy was created.
format: date-time
type: string
LastModificationDate:
@@ -6866,8 +6869,7 @@ components:
type: string
IsSourceDestChecked:
description: "(Net only) If true, the source/destination check is enabled.
- If false, it is disabled. This value must be false for a NAT VM to perform
- network address translation (NAT) in a Net."
+ If false, it is disabled."
type: boolean
LinkNic:
"$ref": "#/components/schemas/LinkNic"
@@ -6970,8 +6972,7 @@ components:
type: string
IsSourceDestChecked:
description: "(Net only) If true, the source/destination check is enabled.
- If false, it is disabled. This value must be false for a NAT VM to perform
- network address translation (NAT) in a Net."
+ If false, it is disabled."
type: boolean
LinkNic:
"$ref": "#/components/schemas/LinkNicLight"
@@ -7207,7 +7208,7 @@ components:
description: Information about the policy.
properties:
CreationDate:
- description: The date and time (UTC) of creation of the policy.
+ description: The date and time (UTC) at which the policy was created.
format: date-time
type: string
Description:
@@ -7247,10 +7248,11 @@ components:
properties:
Body:
description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
+ and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
CreationDate:
- description: The date and time (UTC) of creation of the version.
+ description: The date and time (UTC) at which the version was created.
format: date-time
type: string
DefaultVersion:
@@ -7370,7 +7372,8 @@ components:
type: boolean
PolicyDocument:
description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
+ and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
PolicyName:
description: The name of the policy.
@@ -9653,6 +9656,8 @@ components:
Key:
description: The key of the tag, with a minimum of 1 character.
type: string
+ required:
+ - Key
type: object
ResourceTag:
additionalProperties: false
@@ -9921,7 +9926,7 @@ components:
description: Information about the server certificate.
properties:
ExpirationDate:
- description: The date at which the server certificate expires.
+ description: The date on which the server certificate expires.
format: date
type: string
Id:
@@ -9939,7 +9944,7 @@ components:
description: The path to the server certificate.
type: string
UploadDate:
- description: The date at which the server certificate has been uploaded.
+ description: The date on which the server certificate has been uploaded.
format: date
type: string
type: object
@@ -9991,7 +9996,7 @@ components:
description: The account ID of the owner of the snapshot.
type: string
CreationDate:
- description: The date and time (UTC) of creation of the snapshot.
+ description: The date and time (UTC) at which the snapshot was created.
format: date-time
type: string
Description:
@@ -11248,8 +11253,7 @@ components:
type: boolean
IsSourceDestChecked:
description: "(Net only) If true, the source/destination check is enabled.
- If false, it is disabled. This value must be false for a NAT VM to perform
- network address translation (NAT) in a Net."
+ If false, it is disabled."
type: boolean
KeypairName:
description: |-
@@ -11474,7 +11478,7 @@ components:
properties:
ConnectionType:
description: The type of VPN connection supported by the virtual gateway
- (only `ipsec.1` is supported).
+ (always `ipsec.1`).
type: string
NetToVirtualGatewayLinks:
description: The Net to which the virtual gateway is attached.
@@ -11514,7 +11518,7 @@ components:
description: The idempotency token provided when launching the VM.
type: string
CreationDate:
- description: The date and time (UTC) of creation of the VM.
+ description: The date and time (UTC) at which the VM was created.
format: date-time
type: string
DeletionProtection:
@@ -11529,8 +11533,7 @@ components:
type: string
IsSourceDestChecked:
description: "(Net only) If true, the source/destination check is enabled.
- If false, it is disabled. This value must be false for a NAT VM to perform
- network address translation (NAT) in a Net."
+ If false, it is disabled."
type: boolean
KeypairName:
description: The name of the keypair used when launching the VM.
@@ -11627,7 +11630,7 @@ components:
description: Information about the VM group.
properties:
CreationDate:
- description: The date and time (UTC) of creation of the VM group.
+ description: The date and time (UTC) at which the VM group was created.
format: date-time
type: string
Description:
@@ -11650,6 +11653,8 @@ components:
type: string
type: array
State:
+ description: The state of the VM group (`pending` \| `available` \| `scaling
+ up` \| `scaling down` \| `deleting` \| `deleted`).
enum:
- available
- deleted
@@ -11722,6 +11727,7 @@ components:
type: object
VmTemplate:
additionalProperties: false
+ description: Information about the VM template.
properties:
CpuCores:
description: The number of vCores.
@@ -11737,7 +11743,7 @@ components:
- highest
type: string
CreationDate:
- description: The date and time (UTC) of creation of the VM template.
+ description: The date and time (UTC) at which the VM was created.
format: date-time
type: string
Description:
@@ -11814,7 +11820,7 @@ components:
description: Information about the volume.
properties:
CreationDate:
- description: The date and time (UTC) of creation of the volume.
+ description: The date and time (UTC) at which the volume was created.
format: date-time
type: string
Iops:
@@ -12026,7 +12032,7 @@ info:
time period is limited.
\nBrute force: To protect against brute force attacks,
the number of failed authentication attempts in a given time period is limited.
\nNote that the OUTSCALE Cloud is compatible with Amazon Web Services
- (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html)
+ (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/About-the-APIs.html)
between AWS and the OUTSCALE API.
\nYou can also manage your resources using
the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.
\nAn OpenAPI description of the OUTSCALE API is also available in this
@@ -12072,7 +12078,7 @@ info:
url: https://opensource.org/licenses/BSD-3-Clause
termsOfService: https://en.outscale.com/terms-of-service/
title: 3DS OUTSCALE API
- version: 1.29.3
+ version: 1.30.0
x-osc-api-type: external
openapi: 3.0.0
paths:
@@ -13681,8 +13687,9 @@ paths:
"/CreateNetAccessPoint":
description: |-
Creates a Net access point to access an OUTSCALE service from this Net without using the Internet and public IPs.
- You specify the service using its name. For more information about the available services, see [ReadNetAccessPointServices](#readnetaccesspointservices).
+ You specify the service using its name. For more information about the available services, see [ReadNetAccessPointServices](#readnetaccesspointservices).
To control the routing of traffic between the Net and the specified service, you can specify one or more route tables. Virtual machines placed in Subnets associated with the specified route table thus use the Net access point to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the access point.
+ When a Net access point is created, a public IP is automatically allocated to your account and used for the Net access point. This public IP is not connected to the Internet. It is counted in your quota, but it is not billed.
For more information, see [About Net Access Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html).
post:
operationId: CreateNetAccessPoint
@@ -14439,7 +14446,7 @@ paths:
You can use this method in three different ways:
* **Creating from a volume**: You create a snapshot from one of your volumes.
* **Copying a snapshot**: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
- * **Importing from a bucket**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to the bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
+ * **Importing from a bucket**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to a bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
**[NOTE]**
In case of excessive use of the snapshot creation feature on the same volume over a short period of time, 3DS OUTSCALE reserves the right to temporarily block the feature.
@@ -14554,9 +14561,8 @@ paths:
- Snapshot
"/CreateSnapshotExportTask":
description: |-
- Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket.
- This action enables you to create a backup of your snapshot or to copy it to another account. You, or other accounts you send a pre-signed URL to, can then download this snapshot from the bucket using the [CreateSnapshot](#createsnapshot) method.
- This procedure enables you to copy a snapshot between accounts within the same Region or in different Regions. To copy a snapshot within the same Region, you can also use the [CreateSnapshot](#createsnapshot) direct method. The copy of the source snapshot is independent and belongs to you.
+ Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket that belongs to you. This action enables you to create a backup of your snapshot.
+ You can share this snapshot with others accounts by granting permission to read it via pre-signed URLs or Access Control Lists (ACLs). For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html).
post:
operationId: CreateSnapshotExportTask
diff --git a/outscale.yaml b/outscale.yaml
index 6836ff6..7d127b4 100644
--- a/outscale.yaml
+++ b/outscale.yaml
@@ -45,16 +45,15 @@ components:
description: The ID of the access key.
type: string
CreationDate:
- description: The date and time (UTC) of creation of the access key.
+ description: The date and time (UTC) at which the access key was created.
format: datetime
type: string
ExpirationDate:
- description: The date (UTC) at which the access key expires.
+ description: The date and time (UTC) at which the access key expires.
format: datetime
type: string
LastModificationDate:
- description: The date and time (UTC) of the last modification of the access
- key.
+ description: The date and time (UTC) at which the access key was last modified.
format: datetime
type: string
State:
@@ -70,7 +69,7 @@ components:
description: The ID of the access key.
type: string
CreationDate:
- description: The date and time (UTC) of creation of the access key.
+ description: The date and time (UTC) at which the access key was created.
format: datetime
type: string
ExpirationDate:
@@ -78,12 +77,11 @@ components:
format: datetime
type: string
LastModificationDate:
- description: The date and time (UTC) of the last modification of the access
- key.
+ description: The date and time (UTC) at which the access key was last modified.
format: datetime
type: string
SecretKey:
- description: The access key that enables you to send requests.
+ description: The secret key that enables you to send requests.
type: string
State:
description: The state of the access key (`ACTIVE` if the key is valid for
@@ -349,8 +347,8 @@ components:
false, the volume is not deleted when terminating the VM.
type: boolean
LinkDate:
- description: The date and time (UTC) of attachment of the volume to the
- VM, in ISO 8601 date-time format.
+ description: The date and time (UTC) at which the volume was attached to
+ the VM, in ISO 8601 date-time format.
format: date
type: string
State:
@@ -520,7 +518,7 @@ components:
type: string
ConnectionType:
description: The type of communication tunnel used by the client gateway
- (only `ipsec.1` is supported).
+ (always `ipsec.1`).
type: string
PublicIp:
description: The public IPv4 address of the client gateway (must be a fixed
@@ -765,7 +763,7 @@ components:
type: integer
ConnectionType:
description: The communication protocol used to establish tunnel with your
- client gateway (only `ipsec.1` is supported).
+ client gateway (always `ipsec.1`).
type: string
DryRun:
description: If true, checks whether you have the required permissions to
@@ -1160,8 +1158,8 @@ components:
a policy.
type: string
PolicyName:
- description: The name of the policy. This name must be unique and consist
- of alphanumeric characters and dashes (-).
+ description: The unique name of the policy, with a maximum length of 32
+ alphanumeric characters and dashes (-).
type: string
PolicyType:
description: 'The type of stickiness policy you want to create: `app` or
@@ -1193,8 +1191,9 @@ components:
"$ref": "#/components/schemas/ListenerForCreation"
type: array
LoadBalancerName:
- description: The unique name of the load balancer (32 alphanumeric or hyphen
- characters maximum, but cannot start or end with a hyphen).
+ description: The unique name of the load balancer, with a maximum length
+ of 32 alphanumeric characters and dashes (-). This name must not start
+ or end with a dash.
type: string
LoadBalancerType:
description: 'The type of load balancer: `internet-facing` or `internal`.
@@ -1429,7 +1428,8 @@ components:
type: string
Document:
description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
+ and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
DryRun:
description: If true, checks whether you have the required permissions to
@@ -1458,7 +1458,8 @@ components:
properties:
Document:
description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
+ and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
PolicyOrn:
description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
@@ -1910,7 +1911,7 @@ components:
properties:
ConnectionType:
description: The type of VPN connection supported by the virtual gateway
- (only `ipsec.1` is supported).
+ (always `ipsec.1`).
type: string
DryRun:
description: If true, checks whether you have the required permissions to
@@ -2208,7 +2209,7 @@ components:
description: The ID of the client gateway.
type: string
ConnectionType:
- description: The type of VPN connection (only `ipsec.1` is supported).
+ description: The type of VPN connection (always `ipsec.1`).
type: string
DryRun:
description: If true, checks whether you have the required permissions to
@@ -3609,7 +3610,7 @@ components:
type: array
ConnectionTypes:
description: The types of communication tunnels used by the client gateways
- (only `ipsec.1` is supported).
+ (always `ipsec.1`).
items:
type: string
type: array
@@ -4903,7 +4904,7 @@ components:
description: One or more filters.
properties:
ConnectionTypes:
- description: The types of the virtual gateways (only `ipsec.1` is supported).
+ description: The types of the virtual gateways (always `ipsec.1`).
items:
type: string
type: array
@@ -4990,6 +4991,7 @@ components:
CreationDates:
description: The dates when the VMs were launched.
items:
+ format: date
type: string
type: array
ImageIds:
@@ -5347,6 +5349,7 @@ components:
type: object
FiltersVmTemplate:
additionalProperties: false
+ description: One or more filters.
properties:
CpuCores:
description: The number of vCores.
@@ -5508,8 +5511,8 @@ components:
description: One or more filters.
properties:
CreationDates:
- description: The dates and times of creation of the volumes, in ISO 8601
- date-time format (for example, `2020-06-30T00:00:00.000Z`).
+ description: The dates and times at which the volumes were created, in ISO
+ 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`).
items:
format: date
type: string
@@ -5524,8 +5527,8 @@ components:
type: string
type: array
LinkVolumeLinkDates:
- description: The dates and times of creation of the volumes, in ISO 8601
- date-time format (for example, `2020-06-30T00:00:00.000Z`).
+ description: The dates and times at which the volumes were attached, in
+ ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`).
items:
format: date
type: string
@@ -5605,7 +5608,7 @@ components:
type: string
type: array
ConnectionTypes:
- description: The types of the VPN connections (only `ipsec.1` is supported).
+ description: The types of the VPN connections (always `ipsec.1`).
items:
type: string
type: array
@@ -5687,7 +5690,7 @@ components:
the public catalog.
properties:
Generations:
- description: The generations of VMs that the fGPU is compatible with.
+ description: The processor generations that the fGPUs are compatible with.
items:
type: string
type: array
@@ -5763,7 +5766,7 @@ components:
"$ref": "#/components/schemas/BlockDeviceMappingImage"
type: array
CreationDate:
- description: The date and time (UTC) of creation of the OMI.
+ description: The date and time (UTC) at which the OMI was created.
format: date
type: string
Description:
@@ -5839,7 +5842,8 @@ components:
properties:
Body:
description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
+ and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
Name:
description: The name of the policy.
@@ -6341,7 +6345,7 @@ components:
description: Information about the linked policy.
properties:
CreationDate:
- description: The date and time (UTC) of creation of the linked policy.
+ description: The date and time (UTC) at which the linked policy was created.
format: date-time
type: string
LastModificationDate:
@@ -6865,8 +6869,7 @@ components:
type: string
IsSourceDestChecked:
description: "(Net only) If true, the source/destination check is enabled.
- If false, it is disabled. This value must be false for a NAT VM to perform
- network address translation (NAT) in a Net."
+ If false, it is disabled."
type: boolean
LinkNic:
"$ref": "#/components/schemas/LinkNic"
@@ -6969,8 +6972,7 @@ components:
type: string
IsSourceDestChecked:
description: "(Net only) If true, the source/destination check is enabled.
- If false, it is disabled. This value must be false for a NAT VM to perform
- network address translation (NAT) in a Net."
+ If false, it is disabled."
type: boolean
LinkNic:
"$ref": "#/components/schemas/LinkNicLight"
@@ -7206,7 +7208,7 @@ components:
description: Information about the policy.
properties:
CreationDate:
- description: The date and time (UTC) of creation of the policy.
+ description: The date and time (UTC) at which the policy was created.
format: date-time
type: string
Description:
@@ -7246,10 +7248,11 @@ components:
properties:
Body:
description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
+ and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
CreationDate:
- description: The date and time (UTC) of creation of the version.
+ description: The date and time (UTC) at which the version was created.
format: date-time
type: string
DefaultVersion:
@@ -7369,7 +7372,8 @@ components:
type: boolean
PolicyDocument:
description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html).
+ the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
+ and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
PolicyName:
description: The name of the policy.
@@ -9652,6 +9656,8 @@ components:
Key:
description: The key of the tag, with a minimum of 1 character.
type: string
+ required:
+ - Key
type: object
ResourceTag:
additionalProperties: false
@@ -9920,7 +9926,7 @@ components:
description: Information about the server certificate.
properties:
ExpirationDate:
- description: The date at which the server certificate expires.
+ description: The date on which the server certificate expires.
format: date
type: string
Id:
@@ -9938,7 +9944,7 @@ components:
description: The path to the server certificate.
type: string
UploadDate:
- description: The date at which the server certificate has been uploaded.
+ description: The date on which the server certificate has been uploaded.
format: date
type: string
type: object
@@ -9990,7 +9996,7 @@ components:
description: The account ID of the owner of the snapshot.
type: string
CreationDate:
- description: The date and time (UTC) of creation of the snapshot.
+ description: The date and time (UTC) at which the snapshot was created.
format: datetime
type: string
Description:
@@ -11247,8 +11253,7 @@ components:
type: boolean
IsSourceDestChecked:
description: "(Net only) If true, the source/destination check is enabled.
- If false, it is disabled. This value must be false for a NAT VM to perform
- network address translation (NAT) in a Net."
+ If false, it is disabled."
type: boolean
KeypairName:
description: |-
@@ -11473,7 +11478,7 @@ components:
properties:
ConnectionType:
description: The type of VPN connection supported by the virtual gateway
- (only `ipsec.1` is supported).
+ (always `ipsec.1`).
type: string
NetToVirtualGatewayLinks:
description: The Net to which the virtual gateway is attached.
@@ -11513,7 +11518,7 @@ components:
description: The idempotency token provided when launching the VM.
type: string
CreationDate:
- description: The date and time (UTC) of creation of the VM.
+ description: The date and time (UTC) at which the VM was created.
format: datetime
type: string
DeletionProtection:
@@ -11528,8 +11533,7 @@ components:
type: string
IsSourceDestChecked:
description: "(Net only) If true, the source/destination check is enabled.
- If false, it is disabled. This value must be false for a NAT VM to perform
- network address translation (NAT) in a Net."
+ If false, it is disabled."
type: boolean
KeypairName:
description: The name of the keypair used when launching the VM.
@@ -11626,7 +11630,7 @@ components:
description: Information about the VM group.
properties:
CreationDate:
- description: The date and time (UTC) of creation of the VM group.
+ description: The date and time (UTC) at which the VM group was created.
format: datetime
type: string
Description:
@@ -11649,6 +11653,8 @@ components:
type: string
type: array
State:
+ description: The state of the VM group (`pending` \| `available` \| `scaling
+ up` \| `scaling down` \| `deleting` \| `deleted`).
enum:
- available
- deleted
@@ -11721,6 +11727,7 @@ components:
type: object
VmTemplate:
additionalProperties: false
+ description: Information about the VM template.
properties:
CpuCores:
description: The number of vCores.
@@ -11736,7 +11743,7 @@ components:
- highest
type: string
CreationDate:
- description: The date and time (UTC) of creation of the VM template.
+ description: The date and time (UTC) at which the VM was created.
format: date-time
type: string
Description:
@@ -11813,7 +11820,7 @@ components:
description: Information about the volume.
properties:
CreationDate:
- description: The date and time (UTC) of creation of the volume.
+ description: The date and time (UTC) at which the volume was created.
format: datetime
type: string
Iops:
@@ -12025,7 +12032,7 @@ info:
time period is limited.
\nBrute force: To protect against brute force attacks,
the number of failed authentication attempts in a given time period is limited.
\nNote that the OUTSCALE Cloud is compatible with Amazon Web Services
- (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/OUTSCALE-APIs-Reference.html)
+ (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/About-the-APIs.html)
between AWS and the OUTSCALE API.
\nYou can also manage your resources using
the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.
\nAn OpenAPI description of the OUTSCALE API is also available in this
@@ -12071,7 +12078,7 @@ info:
url: https://opensource.org/licenses/BSD-3-Clause
termsOfService: https://en.outscale.com/terms-of-service/
title: 3DS OUTSCALE API
- version: 1.29.3
+ version: 1.30.0
x-osc-api-type: external
openapi: 3.0.0
paths:
@@ -13680,8 +13687,9 @@ paths:
"/CreateNetAccessPoint":
description: |-
Creates a Net access point to access an OUTSCALE service from this Net without using the Internet and public IPs.
- You specify the service using its name. For more information about the available services, see [ReadNetAccessPointServices](#readnetaccesspointservices).
+ You specify the service using its name. For more information about the available services, see [ReadNetAccessPointServices](#readnetaccesspointservices).
To control the routing of traffic between the Net and the specified service, you can specify one or more route tables. Virtual machines placed in Subnets associated with the specified route table thus use the Net access point to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the access point.
+ When a Net access point is created, a public IP is automatically allocated to your account and used for the Net access point. This public IP is not connected to the Internet. It is counted in your quota, but it is not billed.
For more information, see [About Net Access Points](https://docs.outscale.com/en/userguide/About-Net-Access-Points.html).
post:
operationId: CreateNetAccessPoint
@@ -14438,7 +14446,7 @@ paths:
You can use this method in three different ways:
* **Creating from a volume**: You create a snapshot from one of your volumes.
* **Copying a snapshot**: You copy an existing snapshot. The source snapshot can be one of your own snapshots, or a snapshot owned by another account that has granted you permission via the [UpdateSnapshot](#updatesnapshot) method.
- * **Importing from a bucket**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to the bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
+ * **Importing from a bucket**: You import a snapshot located in an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source snapshot must export it to a bucket by using the [CreateSnapshotExportTask](#createsnapshotexporttask) method. Then, they must grant you permission to read the snapshot via a pre-signed URL or Access Control Lists. For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
**[NOTE]**
In case of excessive use of the snapshot creation feature on the same volume over a short period of time, 3DS OUTSCALE reserves the right to temporarily block the feature.
@@ -14553,9 +14561,8 @@ paths:
- Snapshot
"/CreateSnapshotExportTask":
description: |-
- Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket.
- This action enables you to create a backup of your snapshot or to copy it to another account. You, or other accounts you send a pre-signed URL to, can then download this snapshot from the bucket using the [CreateSnapshot](#createsnapshot) method.
- This procedure enables you to copy a snapshot between accounts within the same Region or in different Regions. To copy a snapshot within the same Region, you can also use the [CreateSnapshot](#createsnapshot) direct method. The copy of the source snapshot is independent and belongs to you.
+ Exports a snapshot to an OUTSCALE Object Storage (OOS) bucket that belongs to you. This action enables you to create a backup of your snapshot.
+ You can share this snapshot with others accounts by granting permission to read it via pre-signed URLs or Access Control Lists (ACLs). For more information, see [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).
For more information, see [About Snapshots](https://docs.outscale.com/en/userguide/About-Snapshots.html).
post:
operationId: CreateSnapshotExportTask